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

Document "Require minimal fields in the operator policy"

XMLWordPrintable

    • False
    • None
    • False
    • 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

      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

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

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

      Please update this documentation section with this diff or similar:

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/governance/governance#policy-operator-yaml-table

      diff --git a/governance/policy_operator.adoc b/governance/policy_operator.adoc
      index 4a6e51a64..d51d28229 100644
      --- a/governance/policy_operator.adoc
      +++ b/governance/policy_operator.adoc
      @@ -69,13 +69,13 @@ If the `remediationAction` set to `inform`, the controller only reports the stat
       
       | `spec.subscription`
       | Required
      -| Define the configurations to create an operator subscription. You must add information in the following fields to create an operator subscription:
      -+
      -- `channel`
      diff --git a/governance/policy_operator.adoc b/governance/policy_operator.adoc
      index 4a6e51a64..d51d28229 100644
      --- a/governance/policy_operator.adoc
      +++ b/governance/policy_operator.adoc
      @@ -69,13 +69,13 @@ If the `remediationAction` set to `inform`, the controller only reports the stat
       
       | `spec.subscription`
       | Required
      -| Define the configurations to create an operator subscription. You must add information in the following fields to create an operator subscription:
      -+
      -- `channel`
      -- `name`
      -- `namespace`
      -- `source`
      -- `sourceNamespace`
      +a| Define the configurations to create an operator subscription. You must add information in the following fields to create an operator subscription:
      +
      +- `channel` - if not specified, the default channel will be selected from the operator catalog. The default can be different on different {ocp} versions.
      +- `name` - the package name of the operator.
      +- `namespace` - if not specified, the default namespaced used for {ocp} managed clusters is `openshift-operators`.
      +- `source` - if not specified, the catalog containing the operator is chosen.
      +- `sourceNamespace` - if not specified, the namespace of the catalog containing the operator is chosen.
       
       | `subscriptions.installPlanApproval`
       | Required

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

      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:

      See the above diff.

              bswope@redhat.com Brandi Swope
              mprahl Matthew Prahl
              Derek Ho Derek Ho
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: