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

DOC: Update the section on validating backup and restore configuration policies

XMLWordPrintable

    • 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: Find the link to where the documentation update
      should go and add it to the recommended changes. You can either use the
      published doc or the staged repo for this step:

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/business_continuity/business-cont-overview#backup-validation-using-a-policy

      Note: As the feature and doc is understood, this recommendation may
      change. If this is new documentation, link to the section where you think
      it should be placed.

      Customer Portal published version

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12

      Doc staged repo within the ACM Workspace:
      https://github.com/stolostron/rhacm-docs

      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.

      As part of ACM-26518, the backup and restore policies were consolidated to reduce UI clutter. The backup-restore-auto-import policy has been removed, and its two templates were merged into the existing backup-restore-enabled policy (now containing a total of 19 templates). The hub-backup-policy-set.yaml file has been updated to reference only this single combined policy, and the PolicySet description has been revised accordingly.

      Required documentation updates:
      (https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/business_continuity/business-cont-overview#backup-validation-using-a-policy)

      Remove all references to the backup-restore-auto-import policy, as it no longer exists.

      Update the backup-restore-enabled policy section to include the full list of templates (including those previously described under backup-restore-auto-import).

      Ensure the doc reflects that the validation functionality remains unchanged—only the policies were merged for a cleaner UI.

      Update the PolicySet description to match the new wording:

      “Validates the ACM Hub backup and restore configuration. This PolicySet applies to local hubs, global hubs, and managed clusters where the ACM Hub is installed.”

              Unassigned Unassigned
              saharebrahimi Sahar Ebrahimi
              Thuy Nguyen Thuy Nguyen
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: