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

[Doc]Indicate the outcome of bindingOverrides.remediationAction in the console

XMLWordPrintable

    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

       

      As a policy user that uses `bindingOverrides.remediationAction` on a `PlacementBinding`, I'd like to see in the console the correct remediationAction reflected.

      (Checklist)

      • The policy Results tab's table should have a `Remediation` column. Add an indicator that it is overridden.
      • The "Policies" tab's table's `Remediation` column should indicate that there are some overrides. For example, if the parent policy has `remediationAction` set to the `inform` but there are some overrides, the text should go from `inform` to `inform/enforce (overridden)`.

      Suggestion: 

      Add YAML example with remediation action overrides would be good. Below: 

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/governance/governance#placement-yaml-sample-file

       

      ```
      apiVersion: policy.open-cluster-management.io/v1

      kind: PlacementBinding

      metadata:name: binding-policy-role
      bindingOverrides:
         remediationAction: [null|enforce]
      subFilter: [false|true]
      placementRef:

        name: placement-policy-role

        kind: Placement apiGroup: cluster.open-cluster-management.io

        subjects:

          - name: policy-role

        kind: Policy

         apiGroup: policy.open-cluster-management.io
       

      ```

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

      Provide info for the following steps:

      1. - [ ] 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
            - [ v] Update to an existing topic

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

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

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

              mdockery@redhat.com Mikela Jackson
              yikim@redhat.com Yi Rae Kim
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: