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

Document spoke resource cleanup after agent unbind/delete

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • Hide

      Provide the required acceptance criteria using this template.

      • ...
      Show
      Provide the required acceptance criteria using this template. ...
    • None

      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:

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#auto-remove-host-steps-no-bmh

      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.

            - [x] Update to an existing topic

      3. - [x] Mandatory for GA content:
                  
             - [x] Add steps and/or other important conceptual information here: 
             
      This is a change in behavior. Now, managed cluster nodes (and related resources like machines, and bare metal hosts) will be removed if the Agent resource is deleted or unbound from the cluster unless an additional annotation is placed on the agent.

      This behavior (removing the spoke node resources) can be skipped by setting the following annotation on the Agent CR before unbinding or deleting it.

      agent.agent-install.openshift.io/skip-spoke-cleanup: true

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

      Whatever access level is needed to edit and remove Agent CRs.

             - [x] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
           
      The node should be removed from the managed cluster. i.e.

       oc get nodes

      should not show the node for the removed/unbound agent.
           
             - [x] Add link to dev story here: https://issues.redhat.com//browse/MGMT-10006

      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:

      Current doc:

      If you do not have a bare metal host on your hub cluster and want remove managed cluster nodes from a managed cluster, follow the Deleting nodes instructions in the OpenShift Container Platform documentation.
      

      Proposed doc:

      If you do not have a bare metal host on your hub cluster and want to remove managed cluster nodes from a managed cluster, you can unbind (remove the clusterDeploymentName field from the Agent CR spec) or delete the Agent CR corresponding with the node to be removed.
      
      If you want to delete and Agent CR from the hub cluster, but do not want the node removed from the managed cluster you can set the annotation "agent.agent-install.openshift.io/skip-spoke-cleanup" to "true" on the Agent resource before removing it.
      

              bswope@redhat.com Brandi Swope
              ncarboni@redhat.com Nick Carboni
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: