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

document cleanupBeforeRestore option on ACM restore

XMLWordPrintable

    • False
    • None
    • False
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

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

      2. - [ ] Mandatory: Choose the type of documentation change or review.

      • [x] We need to update to an existing topic
      • [ ] We need to add a new document to an existing section
      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note
        for MCE and/or ACM

      3. - [ ] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      4. - [ ] Mandatory for GA content:

      • [ ] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] 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:

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

      related to https://access.redhat.com/support/cases/#/case/03939562

      Change #1

       

      At this link

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/business_continuity/business-cont-overview#clean-hub-restore

       

      Update:

      CleanupAll: Clean up all resources on the hub cluster that might be part of a Red Hat Advanced Cluster Management backup, even if they were not created as a result of a restore operation. This is to be used when extra content is created on a hub cluster before the restore operation starts.

      With

      CleanupAll: Clean up all resources on the hub cluster that might be part of a Red Hat Advanced Cluster Management backup, even if they were not created as a result of a restore operation. This is to be used when you want to clean up the restore hub data, including content created by the user. Use this option with extra caution and since it cleans up resources created by the user and not only from a previous backup.

      Important: Always used None value if your restore operation filters out some of the resources using the Restore options: excludedResource, excludedNamespaces, excludedResources or any other options that filter out the resources which are being restored. If you don't use the cleanupBeforeRestore=None option in this situation, you delete resources on the restore hub which are part of the backup but are being filtered out by the restore operation.

       

      Change #2:

      At this link

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/business_continuity/business-cont-overview#restoring-backup-restore-operation

       

      Add the following content just before 

      You can choose to install only a certain type of backup, such as only managed clusters, only user credentials, or only hub cluster resources.

       

      New content:

      Your restore resource might resemble the following file:
      apiVersion: cluster.open-cluster-management.io/v1beta1kind: Restoremetadata:name: restore-acm namespace: open-cluster-management-backupspec:
      cleanupBeforeRestore: None 1
      veleroManagedClustersBackupName: latest 2
      veleroCredentialsBackupName: latest 3
      veleroResourcesBackupName: latest 4

      1. The post restore cleanup uses the cleanupBeforeRestore property to identify the subset of objects to clean up. You can use the following options for the post restore cleanup:

      • None: No clean up necessary, just begin Velero restore. Use None on a brand new hub cluster.
      • CleanupRestored: Clean up all resources created by a previous Red Hat Advanced Cluster Management restore that are not part of the currently restored backup. 
      • CleanupAll: Clean up all resources on the hub cluster that might be part of a Red Hat Advanced Cluster Management backup, even if they were not created as a result of a restore operation. This is to be used when you want to clean up the restore hub data, including content created by the user. Use this option with extra caution and since it cleans up resources created by the user and not only from a previous backup.
        Important: Always used None value if your restore operation filters out some of the resources using the Restore options: excludedResource, excludedNamespaces, excludedResources or any other options that filter out the resources which are being restored. If you don't use the cleanupBeforeRestore=None option in this situation, you delete resources on the restore hub which are part of the backup but are being filtered out by the restore operation.

       

      • (For the 2,3,4 in the yaml: add them to the sections below , where it explains those options)

              jberger@redhat.com Jacob Berger
              vbirsan@redhat.com Valentina Birsan
              Thuy Nguyen Thuy Nguyen
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: