Add description for pruneObjectBehavior

Adding a description to the pruning parameter in the CRD Refs: - stolostron/backlog#26528 Signed-off-by: Gus Parvin <gparvin@redhat.com>
open-cluster-management-io · Nov 11, 2022 · 18e33b7 · 18e33b7
1 parent dfed254
commit 18e33b7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/api/v1/configurationpolicy_types.go b/api/v1/configurationpolicy_types.go
@@ -27,7 +27,8 @@ type RemediationAction string
 // +kubebuilder:validation:Enum=low;Low;medium;Medium;high;High;critical;Critical
 type Severity string
 
-// PruneObjectBehavior : DeleteAll, DeleteIfCreated, or None
+// PruneObjectBehavior is used to remove objects that are managed by the
+// policy upon policy deletion.
 // +kubebuilder:validation:Enum=DeleteAll;DeleteIfCreated;None;
 type PruneObjectBehavior string
 

diff --git a/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml b/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml
@@ -159,8 +159,8 @@ spec:
  type: array
  pruneObjectBehavior:
  default: None
- description: 'PruneObjectBehavior : DeleteAll, DeleteIfCreated, or
- None'
+ description: PruneObjectBehavior is used to remove objects that are
+ managed by the policy upon policy deletion.
  enum:
  - DeleteAll
  - DeleteIfCreated