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

[doc] Add backup and restore support for global hub - Tech preview

XMLWordPrintable

    • False
    • None
    • False
    • ACM-627 - Scalability of Hub for Edge Use Cases
    • 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. - [ ] Mandatory Add the required version to the Fix version/s field.

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

            - [ * ] New topic in an existing section or new section

       

           Add a new topic in https://github.com/stolostron/rhacm-docs/blob/2.10_stage/global_hub/global_hub_overview.adoc
           Topic name: Backup and Restore
      

       

            - [ ] Update to an existing topic

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

      # Backup And Restore (Technology Preview)
      
      Global Hub backup and restore use [RHACM backup and restore](https://github.com/stolostron/rhacm-docs/blob/2.10_stage/business_continuity/backup_restore/backup_intro.adoc) to backup the basic resources: 
      
      - Customize configmaps and secrets
      
      - MulticlusterGlobalHub Custom Resource
      
      Global Hub also support backup postgres pvc using [acm-hub-pvc-backup](https://github.com/open-cluster-management-io/policy-collection/tree/main/community/CM-Configuration-Management/acm-hub-pvc-backup)
      
      Note: 
      
      ```
      
      VolSync version must >= 0.9.0
      
      RHACM version must >=2.10.0
      
      ```
      
      # Restoring Global Hub
      
      For restoring a global hub cluster, when you [preparing the new hub cluster](https://github.com/stolostron/rhacm-docs/blob/2.10_stage/business_continuity/backup_restore/backup_restore.adoc#preparing-the-new-hub-cluster) you just need to install the global hub operator and should not create the global hub cr. The global hub cr will be restored automatically.
      
      # Known Issues for Backup And Restore
      
      During the original hub cluster crashed and the new hub cluster ready, the followging things need to notify:
      
      1. If there are some 
      events data(eg: policy compliance events) generated, these events data 
      may lost, and they will not be writen to database.
      
      2. The cron job may missed to run, you should mannually to execute it follow [Running the Summarization Process manually](https://github.com/stolostron/multicluster-global-hub/blob/main/doc/how_global_hub_works.md#running-the-summarization-process-manually) 
              
                           

                  
             - [ ] 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:

              jberger@redhat.com Jacob Berger
              daliu@redhat.com DangPeng Liu
              Hui Chen Hui Chen
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: