Fixes for Operator install of Replication #612
Conversation
donatwork
requested review from
rensyct,
harshaatdell,
ChristianAtDell and
lukeatdell
donatwork
changed the title
donatwork
requested review from
bharathsreekanth,
Deepak-Ghivari,
gallacher,
mgandharva,
mjsdell,
prablr79,
rajendraindukuri,
rajkumar-palani,
rsedlock1958 and
shanmydell
as code owners
| ```shell | ||
| ./repctl create -f ../deploy/replicationcrds.all.yaml | ||
| ``` | ||
| 3. Inject the service account's configuration into the clusters. CSM Operator needs the admin configs instead of the service account configurations to be able to properly manage the target clusters. |
There was a problem hiding this comment.
I do not understand this step. "Inject" does not seem to be a proper verb here. The step also says to "Inject the service account's configuration...", and then the explanatory text says that admin co0nfigs are needed, not the service account configurations.
There was a problem hiding this comment.
Will remove the second sentence as it does not relate to the installation steps.
| @@ -5,23 +5,47 @@ description: > | |||
| Pre-requisite for Installing Replication via Dell CSM Operator | |||
| --- | |||
|
|
|||
| The CSM Replication module for supported Dell CSI Drivers can be installed via the Dell CSM Operator. Dell CSM Operator will deploy CSM Replication sidecar and the complemental CSM Replication controller manager. | |||
| The CSM Replication module for supported Dell CSI Drivers can be installed via the Dell CSM Operator. Dell CSM Operator will deploy the CSM Replication sidecar and the CSM Replication Controller Manager. | |||
There was a problem hiding this comment.
Can include replication Crds?
There was a problem hiding this comment.
The Replication CRDs are not installed via Operator. There is a step that installs the CRDs using repctl. However in the future we may have Operator install all fo the CRDs.
| - one or more target clusters which will serve as diaster recovery clusters for the main cluster | ||
|
|
||
| To configure all the clusters, follow the steps below: | ||
| - a target cluster which will serve as the disaster recovery cluster, a single stretched cluster configuration is also supported |
There was a problem hiding this comment.
Can this two points be separated out ' target cluster which will serve as the disaster recovery cluster .
"the CSM Operator also supports a single stretched cluster configuration offering even more flexibility in your replication setup
There was a problem hiding this comment.
The text you suggest has some marketing/promo content. I want to keep the instructions less marketing savvy as those can be in another more appropriate section.
| 2. On each of the target clusters, configure the prerequisites for deploying the driver via Dell CSM Operator. For example, PowerScale has the following [prerequisites for deploying PowerScale via Dell CSM Operator](../../drivers/powerscale/#prerequisite) | ||
| The rest of the instructions will assume that your current working directory is the csm-replication/repctl directory. | ||
| ## Configuration Steps | ||
| To configure replication when using multiple clusters: |
There was a problem hiding this comment.
Can this changed to support two cluster?
There was a problem hiding this comment.
Reworded this as it was from an earlier iteration.
| 2. On each of the target clusters, configure the prerequisites for deploying the driver via Dell CSM Operator. For example, PowerScale has the following [prerequisites for deploying PowerScale via Dell CSM Operator](../../drivers/powerscale/#prerequisite) | ||
| The rest of the instructions will assume that your current working directory is the csm-replication/repctl directory. | ||
| ## Configuration Steps | ||
| To configure replication when using multiple clusters: |
There was a problem hiding this comment.
Can this changed to support two cluster? or Source and target Cluster
There was a problem hiding this comment.
Reworded as this was a leftover from a previous edit.
| ```shell | ||
| ./repctl create sc --from-config ./examples/<storage>_example_values.yaml | ||
| ``` | ||
| 6. On each of the target clusters, configure the [prerequisites](../../../csmoperator/drivers/#pre-requisites-for-installation-of-the-csi-drivers) for deploying the driver via Dell CSM Operator. |
| ```shell | ||
| ./repctl cluster add -f "/root/.kube/config-1","/root/.kube/config-2" -n "cluster-1","cluster-2" | ||
| ``` | ||
| > **_NOTE:_** If using a single Kubernetes cluster in a stretched configuration there will be only one cluster. |
There was a problem hiding this comment.
Do we need to provide example for single cluster configuration
There was a problem hiding this comment.
If we have to have separate examples then we should have two sections which are more linear. One section for two clusters and another for a single cluster.
|
Cleaned up the requirements a bit. |
Description
Cleared up confusing documentation for installing Replication via CSM Operator. The current documentation is referring to the Helm repctl section for installation steps and these steps are not compatible with the Operator install process. This change also requires fixes in Operator to handle the stretched cluster case. I will update with the PRs for those changes one I get them.
GitHub Issues
List the GitHub issues impacted by this PR:
Checklist: