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

DOC - RFE Add the possibility to retry posthooks when using the ClusterCurator resource

XMLWordPrintable

    • 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 https://issues.redhat.com/browse/ACM-4654

      For this story, we added a feature to allow users to retry any Ansible posthooks that failed either part of the install/upgrade process.

       

      Provide info for the following steps:

      1. - [x] Mandatory Add the required version to the Fix version/s field.

      • [ ] ACM 2.5
      • [ ] ACM 2.6
      • [ ] ACM 2.7
      • [x]ACM 2.8 (upcoming release
      • [ ] MCE 2.1
      • [ ] MCE 2.2
      • [x] MCE 2.3 (upcoming release)

      2. - [x] Mandatory Choose the type of documentation change.

            - [x] New topic in an existing section or new section
            - [ ] Update to an existing topic

      https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html-single/release_notes/index#cluster-whats-new

      Add the following under the clusters what's new section.

      Now you can retry failed Ansible posthooks that are part of cluster automation templates. To retry a posthook for installing clusters add the following to root of the ClusterCurator resource:

      operation:
        retryPosthook: installPosthook

      For retrying the upgrade posthook add:

      operation:
        retryPosthook: upgradePosthook

      A new job will be created to run the Ansible posthook.

       

      Also add a new topic for the Troubleshooting section under Cluster management https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html-single/troubleshooting/index#documented-troubleshooting

       

      Topic name: Troubleshooting a failed Ansible posthook during a cluster install/upgrade

      Content is the same as above:

      Now you can retry failed Ansible posthooks that are part of cluster automation templates. To retry a posthook for installing clusters add the following to root of the ClusterCurator resource:

      operation:
        retryPosthook: installPosthook

      For retrying the upgrade posthook add:

      operation:
        retryPosthook: upgradePosthook

      A new job will be created to run the Ansible posthook.

       

      3. - [ ] Mandatory for GA content:
                  
             - [ ] Add steps and/or other important conceptual information here: 
             
                  
             - [ ] 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?)
           
           
             - [x] Add link to dev story here:

      https://issues.redhat.com/browse/ACM-4654

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:

              rh-ee-ofischer Oliver Fischer
              fxiang@redhat.com Feng Xiang
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: