From 18e33b7d1e9174c03eac455ad554ed8fc22d1565 Mon Sep 17 00:00:00 2001 From: Gus Parvin Date: Thu, 10 Nov 2022 08:20:51 -0500 Subject: [PATCH] Add description for pruneObjectBehavior Adding a description to the pruning parameter in the CRD Refs: - https://github.com/stolostron/backlog/issues/26528 Signed-off-by: Gus Parvin --- api/v1/configurationpolicy_types.go | 3 ++- ...licy.open-cluster-management.io_configurationpolicies.yaml | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/api/v1/configurationpolicy_types.go b/api/v1/configurationpolicy_types.go index 0aaec02d..b09e67b5 100644 --- 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 index c8c33af8..b4f38e2e 100644 --- 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