Update the recreateOption documentation based on feedback

Relates: stolostron/rhacm-docs#6536 Signed-off-by: mprahl <[email protected]>
open-cluster-management-io · Jun 21, 2024 · 518ad5e · 518ad5e
1 parent 9a2ada5
commit 518ad5e
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 13 deletions.
diff --git 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/...ustomize_configurationpolicy/policy.open-cluster-management.io_configurationpolicies.yaml b/...ustomize_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
@@ -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