More CRD docs

Razz4780 · Nov 3, 2023 · 59ebe29 · 59ebe29
1 parent d429414
commit 59ebe29
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/mirrord/operator/src/crd.rs b/mirrord/operator/src/crd.rs
@@ -135,11 +135,12 @@ pub enum OperatorFeatures {
     namespaced
 )]
 pub struct CopyTargetSpec {
-    /// Original target.
+    /// Original target. Only [`Target::Pod`] and [`Target::Deployment`] are accepted.
     pub target: Target,
     /// How long should the operator keep this pod alive after its creation.
     /// The pod is deleted when this timout has expired and there are no connected clients.
     pub idle_ttl: Option<u32>,
-    /// Should the operator scale down target deployment while this pod is alive.
+    /// Should the operator scale down target deployment by 1 while this pod is alive.
+    /// Ignored if [`Target`] is not [`Target::Deployment`].
     pub scale_down: Option<bool>,
 }