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

CLC + Ansible integration docs missing information on what data is passed to the Ansible job for cluster upgrade

XMLWordPrintable

    • False
    • None
    • False
    • No
    • Moderate

      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

      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

      This is a continuation of https://issues.redhat.com/browse/ACM-8583

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.8/html/clusters/cluster_mce_overview#ansible-template-create

      3. - [ ] Mandatory for GA content:
                  
             - [X] Add steps and/or other important conceptual information here: 
             

               In the section "1.5.9.3. Creating an Automation template" step 10, we can add more info to explain the extra variables data for the cluster upgrade scenario. New content in blue.

               10. Repeat steps 5 - 7 for any Automation templates that you want to initiate after the cluster is installed in the Post-install Automation templates section, the Pre-upgrade Automation templates section, and the Post-upgrade Automation templates section. For cluster upgrade, the `Extra variables` field can be used to pass data to the AnsibleJob resource in the form of key=value pairs. In addition to the special keys `cluster_deployment` and `install_config`, another special key `cluster_info` is  passed automatically as an extra variable containing data from the `ManagedClusterInfo` resource.
                  
             - [ ] 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:

      https://access.redhat.com/support/cases/#/case/03652587 Customer is complaining about missing info in the doc regarding how to pass data to the AnsibleJob resource. See changes above.

            rh-ee-ofischer Oliver Fischer
            showeimer Sho Weimer
            David Huynh David Huynh
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: