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

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

XMLWordPrintable

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

      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

      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 7, we can add more info to explain the extra variables data. New content in blue.

               7. Select between a Job template or a Workflow job template in the modal that appears. You can also add job_tags, skip_tags, and workflow types. The `Extra variables` field can be used to pass data to the AnsibleJob resource in the form of key=value pairs. Special keys `cluster_deployment` and `machine_pool` are passed automatically as extra variables containing data on general information about the cluster and details about the worker nodes being created in the cluster.
                  
             - [ ] 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.

              jberger@redhat.com Jacob Berger
              showeimer Sho Weimer
              David Huynh David Huynh
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: