-
Task
-
Resolution: Done
-
Undefined
-
ACM 2.13.0
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. - [x] Mandatory: Choose the type of documentation change or review.
- [x] We need to update to an existing topic
- [x 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
- [x] We need a z-Stream (Errata) Advisory and Release note
for MCE and/or ACM
We may need a release note to indicate that beginning with ACM 2.13, ACM can deploy VolSync to managed clusters that are non-OpenShift.
3. - [x] *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:
- Published doc: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10
- Source: https://github.com/stolostron/rhacm-docs
Docs for volsync are all here (this is the 2.12 link, but we'll need to update the 2.13 version):
4. - [x] Mandatory for GA content:
- [x] Add steps, the diff, known issue, and/or other important
conceptual information in the following space:
Changes:
We need to remove this text:
"VolSync does not create its own namespace, so it is in the same namespace as other OpenShift Container Platform all-namespace operators. Any changes that you make to the operator settings for VolSync also affects the other operators in the same namespace, such as if you change to manual approval for channel updates."
And instead add something like this:
"VolSync will be installed into the `volsync-system` namespace on the managed cluster. Previously VolSync was installed as an OLM operator, but now it will be installed as a deploymetn in the volsync-system namespace. Note that this means non-OpenShift managed clusters are now supported."
Step 4 needs to be changed to this:
Run the following command on the hub to confirm that volsync has been installed: ``` oc -n <managed-cluster-name> get ManagedClusterAddOn volsync ``` The command output should show that the managedclusteraddon is "ready". The following can be run on the managed cluster to additionally confirm that volsync has been installed. ``` kubectl -n volsync-system get deployment volsync ```
Lastly, in the prerequisites section (https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/business_continuity/business-cont-overview#volsync-prereq), we have these 2 bullets:
- At least two managed clusters for the same Red Hat Advanced Cluster Management hub cluster - Network connectivity between the clusters that you are configuring with VolSync. If the clusters are not on the same network, you can configure the Submariner multicluster networking and service discovery and use the ClusterIP value for ServiceType to network the clusters, or use a load balancer with the LoadBalancer value for ServiceType.
Can these be moved to under something saying for the rsync-tls mover? (as having multiple clusters is not actually required unless you specifically want to replicate data between clusters).
Something like this:
Before installing VolSync on your clusters, you must have the following requirements: - A configured Red Hat OpenShift Container Platform environment on a supported Red Hat Advanced Cluster Management hub cluster - The storage driver that you use for your source persistent volume must be CSI-compatible and able to support snapshots. - Additionally, if you want to use the the rsync-tls mover to replicate data between clusters: - At least two managed clusters for the same Red Hat Advanced Cluster Management hub cluster - Network connectivity between the clusters that you are configuring with VolSync. If the clusters are not on the same network, you can configure the Submariner multicluster networking and service discovery and use the ClusterIP value for ServiceType to network the clusters, or use a load balancer with the LoadBalancer value for ServiceType.
Removals:
- In this section: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/business_continuity/business-cont-overview#volsync
We need to remove this sentence: "VolSync can only replicate persistent volume claims on supported versions of Red Hat OpenShift Container Platform clusters."
- We need to remove this section: https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/business_continuity/business-cont-overview#volsync-update-mcaddon
- [ ] *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.