From 518ad5e5ba562513a85c4adee3d8cf586fac90d2 Mon Sep 17 00:00:00 2001 From: mprahl Date: Fri, 21 Jun 2024 08:52:00 -0400 Subject: [PATCH] Update the recreateOption documentation based on feedback Relates: https://github.com/stolostron/rhacm-docs/pull/6536 Signed-off-by: mprahl --- api/v1/configurationpolicy_types.go | 10 +++++----- ...en-cluster-management.io_configurationpolicies.yaml | 9 +++++---- ...en-cluster-management.io_configurationpolicies.yaml | 9 +++++---- 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/api/v1/configurationpolicy_types.go b/api/v1/configurationpolicy_types.go index c1b7013c..0d5d8c23 100644 --- a/api/v1/configurationpolicy_types.go +++ b/api/v1/configurationpolicy_types.go @@ -196,11 +196,11 @@ type ObjectTemplate struct { ComplianceType ComplianceType `json:"complianceType"` MetadataComplianceType MetadataComplianceType `json:"metadataComplianceType,omitempty"` - // RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired` - // will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch - // is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect - // on clusters without dry run update support. The default value is `None`. - // + // RecreateOption describes when to delete and recreate an object when an update is required. When you set the + // object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the + // parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to + // `inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no + // effect on clusters without dry-run update support. The default value is `None`. //+kubebuilder:default=None RecreateOption RecreateOption `json:"recreateOption,omitempty"` diff --git a/deploy/crds/kustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml b/deploy/crds/kustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml index 75ed9d8e..f871fd2d 100644 --- a/deploy/crds/kustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml +++ b/deploy/crds/kustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml @@ -195,10 +195,11 @@ spec: recreateOption: default: None description: |- - RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired` - will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch - is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect - on clusters without dry run update support. The default value is `None`. + RecreateOption describes when to delete and recreate an object when an update is required. When you set the + object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the + parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to + `inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no + effect on clusters without dry-run update support. The default value is `None`. enum: - None - IfRequired diff --git a/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml b/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml index 2cd8868d..a16baf52 100644 --- a/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml +++ b/deploy/crds/policy.open-cluster-management.io_configurationpolicies.yaml @@ -202,10 +202,11 @@ spec: recreateOption: default: None description: |- - RecreateOption describes whether to delete and recreate an object when an update is required. `IfRequired` - will recreate the object when updating an immutable field. `Always` will always recreate the object if a mismatch - is detected. `RecreateOption` has no effect when the `remediationAction` is `inform`. `IfRequired` has no effect - on clusters without dry run update support. The default value is `None`. + RecreateOption describes when to delete and recreate an object when an update is required. When you set the + object to `IfRequired`, the policy recreates the object when updating an immutable field. When you set the + parameter to `Always`, the policy recreates the object on any update. When you set the `remediationAction` to + `inform`, the parameter value, `recreateOption`, has no effect on the object. The `IfRequired` value has no + effect on clusters without dry-run update support. The default value is `None`. enum: - None - IfRequired