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

Concern about why the gitops chapter has compliance operator doc

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • No

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

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html-single/gitops/index#policy-gen-install-compliance-operator

      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. - [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:
         

      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:

      Problem:

      • The Gitops chapter includes a section on installing the Compliance Operator.  There is no information about why this chapter exists in the Gitops book.  Is it just another example of how to install an operator using policies?  Why does it exist in gitops and not as an example of using the Policy Generator in the Governance chapter?
      • The section after the compliance operator is "Using policy dependencies with OperatorGroups"  which if it had come before the Compliance Operator section and the Compliance Operator section implemented those details, the doc flow would have made more sense.
      • The yaml shown in the doc for the Operator Group resource appears to be incorrect.  The following yaml should point to the namespace name and not the resource name (should be openshift-compliance).

      targetNamespaces:- compliance-operator * It would make more sense to me for the section on integrating the Policy Generator with GitOps to be first.  In other words, "Managing policy definitions with OpenShift Container Platform GitOps (Argo CD)" should be before "Generating a policy to install GitOps Operator"

      • It's not very clear that these policy resources you are creating should be committed in git and included as part of the ApplicationSet.  Was that the intent for the Compliance Operator or was the sample really showing only how Policy can deploy Operators with a couple samples?

              mdockery@redhat.com Mikela Jackson
              gparvin-redhat Gus Parvin
              Derek Ho Derek Ho
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: