Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Razz4780 committed Dec 5, 2023
1 parent b53d275 commit 564a084
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
3 changes: 3 additions & 0 deletions mirrord/config/src/feature.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,9 @@ pub struct FeatureConfig {
///
/// Creates a new copy of the target. mirrord will use this copy instead of the original target
/// (e.g. intercept network traffic). This feature requires a [mirrord operator](https://mirrord.dev/docs/teams/introduction/).
///
/// This feature is not compatible with rollout targets and running without a target
/// (`targetless` mode).
#[config(nested, unstable)]
pub copy_target: CopyTargetConfig,
}
Expand Down
6 changes: 4 additions & 2 deletions mirrord/config/src/feature/copy_target.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,10 @@ pub enum CopyTargetFileConfig {
Advanced {
/// ### feature.copy_target.scale_down {#feature-copy_target-scale_down}
///
/// If this option is set and [`target`](#target) is a deployment,
/// mirrord will scale it down to 0 for the time the copied pod is alive.
/// If this option is set, mirrord will scale down the target deployment to 0 for the time
/// the copied pod is alive.
///
/// This option is compatible only with deployment targets.
scale_down: Option<bool>,
},
}
Expand Down

0 comments on commit 564a084

Please sign in to comment.