Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-11956

Document the ConfigurationPolicy recreateOption field

XMLWordPrintable

    • False
    • None
    • False
    • No

      Describe the changes in the doc and link to your dev story

      Please make updates to the documentation similar to this diff:

       

      diff --git a/governance/config_policy_ctrl.adoc b/governance/config_policy_ctrl.adoc
      index 2328e98f7..8656e45c7 100644
      --- a/governance/config_policy_ctrl.adoc
      +++ b/governance/config_policy_ctrl.adoc
      @@ -139,6 +139,10 @@ By default, the minimum time between evaluations for configuration policies is a
       | Optional
       | Specifies if and where to log the difference between the object on the cluster and the `objectDefinition` in the policy. Set to `Log` to log the difference in the controller logs or `None` to not log the difference. By default, this parameter is empty to not log the difference.
       
      +| `spec.object-templates[].recreateOption`
      +| Optional
      +| 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`.
      +
       | `spec.object-templates[].objectDefinition`
       | Required
       | A Kubernetes object (either fully defined or containing a subset of fields) for the controller to compare with objects on the managed cluster.

       

      Provide info for the following steps:

      1. - [x] Mandatory Add the required version to the Fix version/s field.

      2. - [x] Mandatory Choose the type of documentation change.

            - [ ] New topic in an existing section or new section
            - [x] Update to an existing topic

      3. - [ ] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here:  See the above diff.       
                  
             - [x] Add Required access level for the user to complete the task here: N/A
             

             - [x] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?): N/A
           
           
             - [x] Add link to dev story here: ACM-11846

      4. - [x] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation: N/A

              mdockery@redhat.com Mikela Jackson
              mprahl Matthew Prahl
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: