Skip to content

Commit

Permalink
Mark mirrord container as unstable (#2668)
Browse files Browse the repository at this point in the history
* Mark mirrord container as unstable

* Small update
  • Loading branch information
DmitryDodzin authored Aug 15, 2024
1 parent 7a2dd1b commit cf54840
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 5 deletions.
1 change: 1 addition & 0 deletions changelog.d/2641.fixed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Specify that `mirrord container` is an unstable feature.
2 changes: 1 addition & 1 deletion mirrord-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@
]
},
"ContainerFileConfig": {
"description": "`mirrord container` command specific config.",
"description": "Unstable: `mirrord container` command specific config.",
"type": "object",
"properties": {
"cli_image": {
Expand Down
2 changes: 1 addition & 1 deletion mirrord/cli/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pub(super) struct Cli {

#[derive(Debug, Subcommand)]
pub(super) enum Commands {
/// Create and run a new container from an image with mirrord loaded
/// Unstable: Create and run a new container from an image with mirrord loaded
Container(Box<ContainerArgs>),

/// Execute a binary using mirrord, mirror remote traffic to it, provide it access to remote
Expand Down
2 changes: 2 additions & 0 deletions mirrord/cli/src/container.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,8 @@ pub(crate) async fn container_command(
) -> Result<()> {
let progress = ProgressTracker::from_env("mirrord container");

progress.warning("mirrord container is currently an unstable feature");

for (name, value) in exec_params.as_env_vars()? {
std::env::set_var(name, value);
}
Expand Down
2 changes: 1 addition & 1 deletion mirrord/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ IP:PORT to connect to instead of using k8s api, for testing purposes.

## container {#root-container}

`mirrord container` command specific config.
Unstable: `mirrord container` command specific config.

### container.cli_image {#container-cli_image}

Expand Down
2 changes: 1 addition & 1 deletion mirrord/config/src/container.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ static DEFAULT_CLI_IMAGE: &str = concat!(
env!("CARGO_PKG_VERSION")
);

/// `mirrord container` command specific config.
/// Unstable: `mirrord container` command specific config.
#[derive(MirrordConfig, Clone, Debug, Serialize)]
#[config(map_to = "ContainerFileConfig", derive = "JsonSchema")]
#[cfg_attr(test, config(derive = "PartialEq"))]
Expand Down
2 changes: 1 addition & 1 deletion mirrord/config/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ pub struct LayerConfig {
pub agent: AgentConfig,

/// ## container {#root-container}
#[config(nested)]
#[config(nested, unstable)]
pub container: ContainerConfig,

/// ## feature {#root-feature}
Expand Down

0 comments on commit cf54840

Please sign in to comment.