Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replication 1.6.0 updates for CSM 1.8.0 #817

Merged
merged 5 commits into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ CSM is made up of multiple components including modules (enterprise capabilities
| ----------------------------------------------------------- | -------------------- | --------------------- | --------------------- | ------------------- | ------------------- |
| [**Authorization**](authorization/) v1.8.0 | ✔️ | ✔️ | ❌ | ✔️ | ❌ |
| [**Observability**](observability/) v1.6.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
| [**Replication**](replication/) v1.5.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
| [**Replication**](replication/) v1.6.0 | ✔️ | ✔️ | ✔️ | ✔️ | ❌ |
| [**Resiliency**](resiliency/) v1.7.0 | ✔️ | ✔️ | ✔️ | ❌ | ✔️ |
| [**Encryption**](secure/encryption) v0.4.0 | ❌ | ✔️ | ❌ | ❌ | ❌ |
| [**Application Mobility**](applicationmobility/) v0.4.0 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
22 changes: 12 additions & 10 deletions content/docs/deployment/csminstallationwizard/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,23 +69,25 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a

3. Look over all the fields in the generated `values.yaml` and fill in/adjust any as needed.

4. When the driver is installed using values generated by installation wizard, then the user needs to update the secret for driver by patching the MDM keys, as follows:
4. When the PowerFlex driver is installed using values generated by installation wizard, the user needs to update the secret for driver by patching the MDM keys, as follows:

**Steps**
* `echo -n '<MDM_IPS>' | base64`
* `kubectl patch secret vxflexos-config -n vxflexos -p "{\"data\": { \"MDM\": \"<GENERATED_BASE64>\"}}"`

5. For the Observability module, please refer [Observability](../../observability/deployment/#post-installation-dependencies) to install the post installation dependencies.
5. If Observability is enabled, refer to [Observability](../../observability/deployment/#post-installation-dependencies) for post installation dependencies.

6. If Authorization is enabled , please refer to [Authorization](../../authorization/deployment/helm/) for the installation and configuration of the Proxy Server.
6. If Authorization is enabled, refer to [Authorization](../../authorization/deployment/helm/) for installation and configuration of the Proxy Server.

>NOTE: Only the Authorization sidecar is enabled by the CSM Installation Wizard. The Proxy Server has to be installed and configured separately.

7. If the Volume Snapshot feature is enabled, please refer to [Volume Snapshot for PowerStore](../../csidriver/installation/helm/powerstore/#optional-volume-snapshot-requirements) and [Volume Snapshot for PowerMax](../../csidriver/installation/helm/powermax/#optional-volume-snapshot-requirements) to install the Volume Snapshot CRDs and the default snapshot controller.
7. If Replication is enabled, refer to [Replication](../../replication/deployment/) on how to configure communication between Kubernetes clusters.

>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, please follow the steps outlined in [PowerStore](../../csidriver/installation/helm/powerstore/#install-the-driver), [PowerMax](../../csidriver/installation/helm/powermax/#install-the-driver), [PowerScale](../../csidriver/installation/helm/isilon/#install-the-driver), [PowerFlex](../../csidriver/installation/helm/powerflex/#install-the-driver), [Unity XT](../../csidriver/installation/helm/unity/#install-csi-driver), [Observability](../../observability/), [Replication](../../replication/), [Resiliency](../../resiliency/).
8. If the Volume Snapshot feature is enabled, refer to [Volume Snapshot for PowerStore](../../csidriver/installation/helm/powerstore/#optional-volume-snapshot-requirements) and [Volume Snapshot for PowerMax](../../csidriver/installation/helm/powermax/#optional-volume-snapshot-requirements) for installing the Volume Snapshot CRDs and the default snapshot controller.

8. Install the Helm chart.
>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, follow the steps outlined in [PowerStore](../../csidriver/installation/helm/powerstore/#install-the-driver), [PowerMax](../../csidriver/installation/helm/powermax/#install-the-driver), [PowerScale](../../csidriver/installation/helm/isilon/#install-the-driver), [PowerFlex](../../csidriver/installation/helm/powerflex/#install-the-driver), [Unity XT](../../csidriver/installation/helm/unity/#install-csi-driver), [Observability](../../observability/), [Replication](../../replication/), [Resiliency](../../resiliency/).

9. Install the Helm chart.

On your terminal, run this command:

Expand All @@ -104,15 +106,15 @@ The [Dell Container Storage Modules Installation Wizard](./src/index.html) is a

2. Look over all the fields in the generated `values.yaml` and fill in/adjust any as needed.

3. For the Observability module, please refer [Observability](../csmoperator/modules/observability) to install the post installation dependencies.
3. If Observability is enabled, refer to [Observability](../csmoperator/modules/observability) for post installation dependencies.

4. If Authorization is enabled , please refer to [Authorization](../csmoperator/modules/authorization) for the installation and configuration of the Proxy Server.
4. If Authorization is enabled, refer to [Authorization](../csmoperator/modules/authorization) for installation and configuration of the Proxy Server.

>NOTE: Only the Authorization sidecar is enabled by the CSM Installation Wizard. The Proxy Server has to be installed and configured separately.

5. If Replication is enabled , please refer to [Replication](../csmoperator/modules/replication).
5. If Replication is enabled, refer to [Replication](../csmoperator/modules/replication) for the necessary prerequisites required for this module.

>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, please follow the steps outlined in [PowerStore](../csmoperator/drivers/powerstore), [PowerMax](../csmoperator/drivers/powermax), [PowerScale](../csmoperator/drivers/powerscale), [Resiliency](../csmoperator/modules/resiliency).
>NOTE: The CSM Installation Wizard generates values.yaml with the minimal inputs required to install the CSM. To configure additional parameters in values.yaml, follow the steps outlined in [PowerStore](../csmoperator/drivers/powerstore), [PowerMax](../csmoperator/drivers/powermax), [PowerScale](../csmoperator/drivers/powerscale), [Resiliency](../csmoperator/modules/resiliency).

6. Install the Operator.

Expand Down
13 changes: 6 additions & 7 deletions content/docs/deployment/csmoperator/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ The table below lists the driver and modules versions installable with the CSM O

| CSI Driver | Version | CSM Authorization | CSM Replication | CSM Observability | CSM Resiliency |
| ------------------ |---------|-------------------|-----------------|-------------------|----------------|
| CSI PowerScale | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerScale | 2.8.0 | ✔ 1.8.0 | ✔ 1.6.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerScale | 2.7.0 | ✔ 1.7.0 | ✔ 1.5.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerScale | 2.6.0 | ✔ 1.6.0 | ✔ 1.4.0 | ✔ 1.5.0 | ❌ |
| CSI PowerFlex | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerFlex | 2.7.0 | ✔ 1.7.0 | ✔ 1.4.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerFlex | 2.8.0 | ✔ 1.8.0 | ✔ 1.6.0 | ✔ 1.6.0 | ✔ 1.7.0 |
| CSI PowerFlex | 2.7.0 | ✔ 1.7.0 | ✔ 1.5.0 | ✔ 1.5.0 | ✔ 1.6.0 |
| CSI PowerFlex | 2.6.0 | ✔ 1.6.0 | ❌ | ✔ 1.4.0 | ❌ |
| CSI PowerStore | 2.8.0 | ❌ | ❌ | ❌ | ✔ 1.7.0 |
| CSI PowerStore | 2.7.0 | ❌ | ❌ | ❌ | ✔ 1.6.0 |
| CSI PowerStore | 2.6.0 | ❌ | ❌ | ❌ | ❌ |
| CSI PowerMax | 2.8.0 | ✔ 1.8.0 | ✔ 1.5.0 | ✔ 1.6.0 | ❌ |
| CSI PowerMax | 2.8.0 | ✔ 1.8.0 | ✔ 1.6.0 | ✔ 1.6.0 | ❌ |
| CSI PowerMax | 2.7.0 | ✔ 1.7.0 | ✔ 1.5.0 | ❌ | ❌ |
| CSI Unity XT | 2.8.0 | ❌ | ❌ | ❌ | ❌ |
| CSI Unity XT | 2.7.0 | ❌ | ❌ | ❌ | ❌ |
Expand Down Expand Up @@ -156,9 +156,8 @@ Here is the output of a request to build an offline bundle for the Dell CSM Oper
dellemc/csm-metrics-powerflex:v1.5.0
dellemc/csm-metrics-powerscale:v1.2.0
dellemc/csm-topology:v1.5.0
dellemc/dell-csi-replicator:v1.5.0
dellemc/dell-replication-controller:v1.5.0
dellemc/dell-replication-init:v1.0.1
dellemc/dell-csi-replicator:v1.6.0
dellemc/dell-replication-controller:v1.6.0
dellemc/sdc:3.6.1
docker.io/dellemc/dell-csm-operator:v1.3.0
gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,18 @@ To configure Replication prior to installation via CSM Operator, you need:
The [csm-replication](https://github.com/dell/csm-replication.git) GitHub repository is cloned to your source cluster as part of the installation. On your source cluster run the following to clone and build the repctl tool:

```
git clone -b v1.4.0 https://github.com/dell/csm-replication.git
git clone -b v1.6.0 https://github.com/dell/csm-replication.git
cd csm-replication/repctl
make build
```

Alternately, you can download a pre-built repctl binary from our [Releases](https://github.com/dell/csm-replication/releases) page.
```shell
wget https://github.com/dell/csm-replication/releases/download/v1.6.0/repctl-linux-amd64
mv repctl-linux-amd64 repctl
chmod +x repctl
```

The rest of the instructions will assume that your current working directory is the csm-replication/repctl directory.
## Configuration Steps
To configure Replication perform the following steps:
Expand Down
2 changes: 1 addition & 1 deletion content/docs/replication/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ CSM for Replication provides the following capabilities:
| ----------------- | ---------------- | ---------------- | ---------------- | ---------------- |
| Kubernetes | 1.26, 1.27, 1.28 | 1.26, 1.27, 1.28 | 1.26, 1.27, 1.28 | 1.26, 1.27, 1.28 |
| Red Hat OpenShift | 4.12, 4.13 | 4.12, 4.13 | 4.12, 4.13 | 4.12, 4.13 |
| RHEL | 7.x, 8.x | 7.x, 8.x | 7.x, 8.x | 7.x, 8.x |
| RHEL | 7.x, 8.x | 7.x, 8.x | 7.x, 8.x | 7.x, 8.x |
| CentOS | 7.8, 7.9 | 7.8, 7.9 | 7.8, 7.9 | 7.8, 7.9 |
| Ubuntu | 20.04 | 20.04 | 20.04 | 20.04 |
| SLES | 15SP4 | 15SP2 | 15SP2 | 15SP3 |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/replication/deployment/install-repctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Before you begin, make sure you have the repctl tool available.

You can download a pre-built repctl binary from our [Releases](https://github.com/dell/csm-replication/releases) page.
```shell
wget https://github.com/dell/csm-replication/releases/download/v1.5.0/repctl-linux-amd64
wget https://github.com/dell/csm-replication/releases/download/v1.6.0/repctl-linux-amd64
mv repctl-linux-amd64 repctl
chmod +x repctl
```

Alternately, if you want to build the binary yourself, you can follow these steps:
```shell
git clone -b v1.5.0 https://github.com/dell/csm-replication.git
git clone -b v1.6.0 https://github.com/dell/csm-replication.git
cd csm-replication/repctl
make build
```
Expand Down
4 changes: 2 additions & 2 deletions content/docs/replication/deployment/install-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ description: Installation of CSM for Replication using script (Helm chart)
> **_NOTE:_** These steps should be repeated on all Kubernetes clusters where you want to configure replication.

```shell
git clone -b v1.5.0 https://github.com/dell/csm-replication.git
git clone -b v1.6.0 https://github.com/dell/csm-replication.git
cd csm-replication
kubectl create ns dell-replication-controller
# Download and modify the default values.yaml file if you wish to customize your deployment in any way
wget -O myvalues.yaml https://raw.githubusercontent.com/dell/helm-charts/csm-replication-1.5.0/charts/csm-replication/values.yaml
wget -O myvalues.yaml https://raw.githubusercontent.com/dell/helm-charts/csm-replication-1.6.0/charts/csm-replication/values.yaml
bash scripts/install.sh --values ./myvalues.yaml
```
>Note: Current installation method allows you to specify custom `<FQDN>:<IP>` entries to be appended to controller's `/etc/hosts` file. It can be useful if controller is being deployed in private environment where DNS is not set up properly, but kubernetes clusters use FQDN as API server's address.
Expand Down
9 changes: 4 additions & 5 deletions content/docs/replication/deployment/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Here is an example of how that would look:
# Set this to true to enable replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.2.0
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powerflex"
replicationPrefix: "replication.storage.dell.com"
...
Expand All @@ -71,9 +71,8 @@ for PowerFlex following the usual installation procedure, just ensure you've add
the array information for all of the arrays being used in the
[secret](../../../csidriver/installation/helm/powerflex#install-the-driver).

> **_NOTE:_** you need to install your driver at least on the source cluster,
> but it is recommended to install drivers on all clusters you will use for
> replication.
> **_NOTE:_** You need to install your driver on all clusters where you want to use
replication. Both arrays must be accessible from each cluster.

### Creating Storage Classes

Expand Down Expand Up @@ -121,7 +120,7 @@ Let's go through each parameter and what it means:
the remote storage class. If you are using replication with the multi-cluster
configuration you can make it the same as the current storage class name.
* `replication.storage.dell.com/remoteClusterID` represents the ID of a remote
cluster. It is the same id you put in the replication controller config map.
Kubernetes cluster. It is the same id you put in the replication controller config map.
* `replication.storage.dell.com/remoteSystem` is the name of the remote system
as seen from the current PowerFlex instance. This parameter is the systemID of
the array.
Expand Down
8 changes: 4 additions & 4 deletions content/docs/replication/deployment/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Here is an example of what that would look like:
# Set this to true to enable replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.0.0
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powermax"
replicationPrefix: "replication.storage.dell.com"
...
Expand All @@ -84,8 +84,8 @@ You can leave other parameters like `image`, `replicationContextPrefix`, and `re
After enabling the replication module you can continue to install the CSI driver for PowerMax following
usual installation procedure, just ensure you've added necessary array connection information to secret.

> **_NOTE:_** You need to install your driver at least on the source cluster, but it is recommended to install
> drivers on all clusters you will use for replication.
> **_NOTE:_** You need to install your driver on all clusters where you want to use replication. Both arrays
must be accessible from each cluster.


### Creating Storage Classes
Expand Down Expand Up @@ -129,7 +129,7 @@ Let's go through each parameter and what it means:
* `replication.storage.dell.com/isReplicationEnabled` if set to `true`, will mark this storage class as replication enabled,
just leave it as `true`.
* `replication.storage.dell.com/RemoteStorageClassName` points to the name of the remote storage class, if you are using replication with the multi-cluster configuration you can make it the same as the current storage class name.
* `replication.storage.dell.com/RemoteClusterID` represents the ID of a remote cluster, it is the same ID you put in the replication controller config map.
* `replication.storage.dell.com/RemoteClusterID` represents the ID of a remote Kubernetes cluster, it is the same ID you put in the replication controller config map.
* `replication.storage.dell.com/RemoteSYMID` is the Symmetrix ID of the remote array.
* `replication.storage.dell.com/RemoteSRP` is the storage pool of the remote array.
* `replication.storage.dell.com/RemoteServiceLevel` is the service level that will be assigned to remote volumes.
Expand Down
Loading