Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
falfaroc committed Feb 8, 2023
1 parent 95037d4 commit 6768d70
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 19 deletions.
12 changes: 6 additions & 6 deletions content/docs/replication/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ CSM for Replication provides the following capabilities:
{{<table "table table-striped table-bordered table-sm">}}
| COP/OS | PowerMax | PowerStore | PowerScale | PowerFlex |
| ----------------- | ---------------- | ---------------- | ---------------- | ---------------- |
| Kubernetes | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24 |
| Kubernetes | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 |
| Red Hat OpenShift | 4.10, 4.11 | 4.9, 4.10 | 4.9, 4.10 | 4.9, 4.10 |
| RHEL | 7.x, 8.x | 7.x, 8.x | 7.x, 8.x | 8.x |
| CentOS | 7.8, 7.9 | 7.8, 7.9 | 7.8, 7.9 | 7.9 |
| Ubuntu | 20.04 | 20.04 | 20.04 | n/a |
| SLES | 15SP4 | 15SP2 | 15SP2 | n/a |
| 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 |
{{</table>}}

## Supported Storage Platforms
Expand Down Expand Up @@ -92,7 +92,7 @@ The following matrix provides a list of all supported versions for each Dell Sto

| Platforms | PowerMax | PowerStore | PowerScale | PowerFlex |
| ---------------- | ------------------------------ | ---------------- | ---------------- | ---------------- |
| Kubernetes | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25 |
| Kubernetes | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 | 1.24, 1.25, 1.26 |
| RedHat Openshift | 4.10, 4.11 | 4.9, 4.10 | 4.9, 4.10 | 4.9, 4.10 |
| CSI Driver | 2.x(k8s), <br> 2.2+(OpenShift) | 2.x | 2.2+ | 2.6+ |

Expand Down
3 changes: 1 addition & 2 deletions content/docs/replication/deployment/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ The following CSI drivers support replication:
1. CSI driver for PowerMax
2. CSI driver for PowerStore
3. CSI driver for PowerScale
4. CSI driver for Unity XT
5. CSI driver for PowerFlex
4. CSI driver for PowerFlex

Please follow the steps outlined in [PowerMax](../powermax), [PowerStore](../powerstore), [PowerScale](../powerscale), or [PowerFlex](../powerflex) pages during the driver installation.

Expand Down
33 changes: 23 additions & 10 deletions content/docs/replication/deployment/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ to do the steps described in the following sections.

Be sure to configure replication between multiple PowerFlex instances using instructions provided by PowerFlex storage.

You can ensure that you configured remote systems by navigating to the `Protection` tab and choosing `Peer Systems` in the UI of your PowerFlex instance.
Ensure that the remote systems are configured by navigating to the `Protection` tab and choosing `Peer Systems` in the UI of the PowerFlex instance.

You should see a list of remote systems with the `State` fields set to `Connected`.
There should be a list of remote systems with the `State` fields set to `Connected`.

#### In Kubernetes
Ensure you installed CRDs and replication controller in your clusters.

To verify you have everything in order you can execute the following commands:
Run the following commands to verify that everything is installed correctly:

* Check controller pods
```shell
Expand All @@ -53,13 +53,13 @@ To install the driver with replication enabled, you need to ensure you have set
helm parameter `replication.enabled` in your copy of example `values.yaml` file
(usually called `my-powerflex-settings.yaml`, `myvalues.yaml` etc.).
Here is an example of how that would look like
Here is an example of how that would look
```yaml
...
# Set this to true to enable replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.0.0
image: dellemc/dell-csi-replicator:v1.2.0
replicationContextPrefix: "powerflex"
replicationPrefix: "replication.storage.dell.com"
...
Expand Down Expand Up @@ -96,7 +96,7 @@ kind: StorageClass
metadata:
name: vxflexos-replication
provisioner: csi-vxflexos.dellemc.com
reclaimPolicy: Delete
reclaimPolicy: Retain
allowVolumeExpansion: true
volumeBindingMode: Immediate
parameters:
Expand All @@ -109,6 +109,9 @@ parameters:
replication.storage.dell.com/volumeGroupPrefix: "csi"
replication.storage.dell.com/consistencyGroupName: <desiredConsistencyGroupName>
replication.storage.dell.com/protectionDomain: <remoteProtectionDomain>
systemID: <sourceSystemID>
storagepool: <sourceStoragePool>
protectiondomain: <sourceProtectionDomain>
```

Let's go through each parameter and what it means:
Expand All @@ -122,6 +125,8 @@ Let's go through each parameter and what it means:
* `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.
* `replication.storage.dell.com/remoteStoragePool` is the name of the storage
pool on the remote system to be used for creating the remote volumes.
* `replication.storage.dell.com/rpo` is an acceptable amount of data, which is
measured in units of time, that may be lost due to a failure.
* `replication.storage.dell.com/volumeGroupPrefix` represents what string would
Expand All @@ -131,16 +136,20 @@ Let's go through each parameter and what it means:
driver will generate a name for the consistency group.
* `replication.storage.dell.com/protectionDomain` represents the remote array's
protection domain to use.
* `systemID` represents the systemID of the PowerFlex array.
* `storagepool` represents the name of the storage pool to be used on the
PowerFlex array.
* `protectiondomain` represents the array's protection domain to be used.
Let's follow up that with an example, let's assume we have two Kubernetes
Let's follow up that with an example. Let's assume we have two Kubernetes
clusters and two PowerFlex storage arrays:
* Clusters have IDs of `cluster-1` and `cluster-2`
* Cluster `cluster-1` connected to array `000000000001`
* Cluster `cluster-2` connected to array `000000000002`
* For `cluster-1` we plan to use storage pool `pool1` and protection domain `domain1`
* For `cluster-2` we plan to use storage pool `pool1` and protection domain `domain1`
And this how would our pair of storage classes would look like:
And this is how our pair of storage classes would look:
StorageClass to be created in `cluster-1`:
```yaml
Expand All @@ -162,6 +171,8 @@ parameters:
replication.storage.dell.com/rpo: 60
replication.storage.dell.com/volumeGroupPrefix: "csi"
arrayID: "000000000001"
storagepool: "pool1"
protectiondomain: "domain1"
```
StorageClass to be created in `cluster-2`:
Expand All @@ -184,6 +195,8 @@ parameters:
replication.storage.dell.com/rpo: 60
replication.storage.dell.com/volumeGroupPrefix: "csi"
arrayID: "000000000002"
storagepool: "pool1"
protectiondomain: "domain1"
```
After figuring out how storage classes would look, you just need to go and apply
Expand All @@ -203,8 +216,8 @@ copy it, and modify it to your needs.
If you open this example you can see a lot of similar fields and parameters you
can modify in the storage class.
Let's use the same example from manual installation and see how the config would
look like
Let's use the same example from the manual installation and see how the config would
look
```yaml
sourceClusterID: "cluster-1"
targetClusterID: "cluster-2"
Expand Down
2 changes: 1 addition & 1 deletion content/docs/replication/deployment/storageclasses.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This should contain the name of the storage class on the remote cluster which is
>Note: You still need to create a pair of storage classes even while using a single stretched cluster

### Driver specific parameters
Please refer to the driver specific sections for [PowerMax](../powermax/#creating-storage-classes), [PowerStore](../powerstore/#creating-storage-classes) or [PowerScale](../powerscale/#creating-storage-classes) for a detailed list of parameters.
Please refer to the driver specific sections for [PowerMax](../powermax/#creating-storage-classes), [PowerStore](../powerstore/#creating-storage-classes), [PowerScale](../powerscale/#creating-storage-classes) or [PowerFlex](../powerflex#creating-storage-classes) for a detailed list of parameters.

### PV sync Deletion

Expand Down
1 change: 1 addition & 0 deletions content/docs/replication/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Description: >
- [PowerScale - Implement Failback functionality](https://github.com/dell/csm/issues/558)
- [PowerScale - Implement Reprotect functionality](https://github.com/dell/csm/issues/532)
- [PowerScale - SyncIQ policy improvements](https://github.com/dell/csm/issues/573)
- [PowerFlex - Initial Replication Support](https://github.com/dell/csm/issues/618)

### Fixed Issues

Expand Down

0 comments on commit 6768d70

Please sign in to comment.