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

Document the "InStatus" recordDiff ConfigurationPolicy option

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • No

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

      Provide info for the following steps:

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

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

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

      3. - [x] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here: See step 4
             
                  
             - [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?)
           
           
             - [x] Add link to dev story here: ACM-11421

      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:

      Please update this section:
      https://github.com/stolostron/rhacm-docs/blob/2.11_stage/governance/config_policy_ctrl.adoc#configuration-policy-yaml-table

      Here is the suggested Git diff:

      diff --git a/governance/config_policy_ctrl.adoc b/governance/config_policy_ctrl.adoc
      index 2328e98f7..a22538076 100644
      --- a/governance/config_policy_ctrl.adoc
      +++ b/governance/config_policy_ctrl.adoc
      @@ -137,7 +137,7 @@ By default, the minimum time between evaluations for configuration policies is a
       
       | `spec.object-templates[].recordDiff`
       | 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.
      +| Specifies if and where to display the difference between the object on the cluster and the `objectDefinition` in the policy. Set to `InStatus` to store the difference in the `ConfigurationPolicy` status, `Log` to log the difference in the controller logs, or `None` to not display the difference. By default, this parameter is set to `InStatus` if the controller does not detect sensitive data in the difference and otherwise defaults to `None`. If sensitive data is detected, the `ConfigurationPolicy` status will include a message to set `recordDiff` to view the difference.
       
       | `spec.object-templates[].objectDefinition`
       | Required

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

                Created:
                Updated:
                Resolved: