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

[Doc] Add support for object-templates-raw in the Policy Generator

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:

      The subsection that should be updated: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/governance/integrate-third-party-policy-controllers#policy-generator-configuration 

      Specifically, the paragraph about manifests might be modified to include information about using object-templates-raw.

       - 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

      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. - [x] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here:
      If a Policy Generator configuration points to a manifest with just `object-templates-raw: ...`, we should use that directly in a generated `ConfigurationPolicy` rather than require the user to provide an entire `ConfigurationPolicy`. For example, a manifest could be as basic as the following:
       

      object-templates-raw: | 
        example content

      This value will be used directly in a generated `ConfigurationPolicy` without modification, and will then be added as a Policy's `policy-templates` as an entry. The `object-templates-raw` generated `ConfigurationPolicy` will be named as if it were generated from a `ConfigurationPolicy` manifest without a specified name

             - [ ] Add Required access level for the user to complete the task here:
             

             - [x] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
      A user can add an `object-tempates-raw` manifest to an existing `PolicyGenerator` file and run the Policy Generator as they normally would.
           
             - [x] Add link to dev story here: https://issues.redhat.com/browse/ACM-10565 (2.11.0) https://issues.redhat.com/browse/ACM-11524 (2.10.4)

      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
            rh-ee-jeluo Jeffrey Luo
            Derek Ho Derek Ho
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: