-
Bug
-
Resolution: Done
-
Undefined
-
ACM 2.8.0, ACM 2.7.0
-
False
-
-
False
-
-
-
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 3:
- Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.6
- 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 Choose the documentation release (Published releases are refreshed ~weekly after publication).
- [ ] ACM 2.4
- [ ] ACM 2.5
- [x] ACM 2.6
- [x]ACM 2.7 (upcoming release)
- [ ] MCE 2.0
- [ ] MCE 2.1
- [ ] MCE 2.2 (upcoming release)
2. - [x] Mandatory Choose the type of documentation change.
- [ ] New topic in an existing section or new section
- [x] Update to an existing topic
3. - [x] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:
Note this should also be updated in the upcoming ACM 2.8 docs.
In this section: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/add-ons/add-ons-overview#restic-backup-volsync
It's described how to setup the restic secret in order to run a restic backup via VolSync. However there's a link to the restic docs embedded in this section:
Replace access and password with the credentials for your provider, if required. Refer to Preparing a new repository for more information.
The confusing part is that the restic "Preparing a new repository" steps include running a restic init command to initialize the repository. This is not actually required for VolSync and may make a user think it's harder to use (i.e. user would need the restic cli and run an init command themselves, but in reality this is not required).
Can we add a note saying that the restic repository will be initalized by VolSync if necessary? We have a note like this in the upstream docs:
If necessary, the repository will be automatically initialized (i.e., restic init) during the first backup.
4. - [ ] 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?)
- [ ] Add link to dev story here:
- Errata release note version, this is NOT for regular refreshes:
(published with Errata release)
- [ ] ACM 2.4.x
- [ ] ACM 2.5.x
- [ ] ACM 2.6.x
- [ ] MCE 2.0.x
- [ ] MCE 2.1.x