Skip to content

Commit

Permalink
Common changes documentation (#351)
Browse files Browse the repository at this point in the history
  • Loading branch information
shanmydell authored Sep 6, 2022
1 parent 892a076 commit 283ff5f
Show file tree
Hide file tree
Showing 25 changed files with 125 additions and 79 deletions.
2 changes: 1 addition & 1 deletion content/docs/csidriver/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
{{<table "table table-striped table-bordered table-sm">}}
| | PowerMax | PowerFlex | Unity XT | PowerScale | PowerStore |
|---------------|:-------------------------------------------------------:|:----------------:|:--------------------------:|:----------------------------------:|:----------------:|
| Storage Array |5978.479.479, 5978.711.711, 6079.xxx.xxx<br>Unisphere 10.0 | 3.5.x, 3.6.x | 5.0.7, 5.1.0, 5.1.2 | OneFS 8.1, 8.2, 9.0, 9.1, 9.2, 9.3, 9.4 | 1.0.x, 2.0.x, 2.1.x, 3.0 |
| Storage Array |5978.479.479, 5978.711.711, 6079.xxx.xxx<br>Unisphere 10.0 | 3.5.x, 3.6.x | 5.0.7, 5.1.0, 5.1.2, 5.2.0 | OneFS 8.1, 8.2, 9.0, 9.1, 9.2, 9.3, 9.4 | 1.0.x, 2.0.x, 2.1.x, 3.0 |
{{</table>}}
### Backend Storage Details
{{<table "table table-striped table-bordered table-sm">}}
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can use existent volumes from the PowerScale array as Persistent Volumes in
1. Open your volume in One FS, and take a note of volume-id.
2. Create PersistentVolume and use this volume-id as a volumeHandle in the manifest. Modify other parameters according to your needs.
3. In the following example, the PowerScale cluster accessZone is assumed as 'System', storage class as 'isilon', cluster name as 'pscale-cluster' and volume's internal name as 'isilonvol'. The volume-handle should be in the format of <volume_name>=_=_=<export_id>=_=_=<zone>=_=_=<cluster_name>
4. If Quotas are enabled in the driver, it is recommended to add the Quota ID to the description of the NFS export in the following format:
4. If Quotas are enabled in the driver, it is required to add the Quota ID to the description of the NFS export in this format:
`CSI_QUOTA_ID:sC-kAAEAAAAAAAAAAAAAQEpVAAAAAAAA`
5. Quota ID can be identified by querying the PowerScale system.

Expand Down
6 changes: 3 additions & 3 deletions content/docs/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ controller:
```
#### Volume Snapshot CRD's
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Manifests are available here:[v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/client/config/crd)
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Manifests are available here:[v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/client/config/crd)
#### Volume Snapshot Controller
The CSI external-snapshotter sidecar is split into two controllers:
- A common snapshot controller
- A CSI external-snapshotter sidecar
The common snapshot controller must be installed only once in the cluster irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/deploy/kubernetes/snapshot-controller)
The common snapshot controller must be installed only once in the cluster irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/deploy/kubernetes/snapshot-controller)

*NOTE:*
- The manifests available on GitHub install the snapshotter image:
Expand Down Expand Up @@ -103,7 +103,7 @@ kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl
```

*NOTE:*
- It is recommended to use 5.0.x version of snapshotter/snapshot-controller.
- It is recommended to use 6.0.x version of snapshotter/snapshot-controller.

### (Optional) Replication feature Requirements

Expand Down
8 changes: 4 additions & 4 deletions content/docs/csidriver/installation/helm/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ controller:
```
#### Volume Snapshot CRD's
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Manifests are available here: [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/client/config/crd)
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Manifests are available here: [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/client/config/crd)
#### Volume Snapshot Controller
The CSI external-snapshotter sidecar is split into two controllers:
- A common snapshot controller
- A CSI external-snapshotter sidecar
The common snapshot controller must be installed only once in the cluster irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/deploy/kubernetes/snapshot-controller)
The common snapshot controller must be installed only once in the cluster irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/deploy/kubernetes/snapshot-controller)

*NOTE:*
- The manifests available on GitHub install the snapshotter image:
Expand All @@ -104,7 +104,7 @@ kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl
```

*NOTE:*
- When using Kubernetes 1.21/1.22/1.23 it is recommended to use 5.0.x version of snapshotter/snapshot-controller.
- When using Kubernetes it is recommended to use 6.0.x version of snapshotter/snapshot-controller.
- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration.

## Install the Driver
Expand Down Expand Up @@ -158,7 +158,7 @@ Use the below command to replace or update the secret:
- "insecure" parameter has been changed to "skipCertificateValidation" as insecure is deprecated and will be removed from use in config.yaml or secret.yaml in a future release. Users can continue to use any one of "insecure" or "skipCertificateValidation" for now. The driver would return an error if both parameters are used.
- Please note that log configuration parameters from v1.5 will no longer work in v2.0 and higher. Please refer to the [Dynamic Logging Configuration](../../../features/powerflex#dynamic-logging-configuration) section in Features for more information.
- If the user is using complex K8s version like "v1.21.3-mirantis-1", use this kubeVersion check in helm/csi-unity/Chart.yaml file.
kubeVersion: ">= 1.21.0-0 < 1.24.0-0"
kubeVersion: ">= 1.21.0-0 < 1.25.0-0"
5. Default logging options are set during Helm install. To see possible configuration options, see the [Dynamic Logging Configuration](../../../features/powerflex#dynamic-logging-configuration) section in Features.
Expand Down
19 changes: 10 additions & 9 deletions content/docs/csidriver/installation/helm/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ CSI Driver for Dell PowerMax supports PowerPath for Linux. Configure Linux Power

Set up the PowerPath for Linux as follows:

- All the nodes must have the PowerPath package installed . Download the PowerPath archive for the environment from [Dell EMC Online Support](https://www.dell.com/support/home/en-in/product-support/product/powerpath-for-linux/drivers).
- Untar the PowerPath archive, Copy the RPM package into a temporary folder and Install PowerPath using `rpm -ivh DellEMCPower.LINUX-<version>-<build>.<platform>.x86_64.rpm`
- All the nodes must have the PowerPath package installed . Download the PowerPath archive for the environment from [Dell Online Support](https://www.dell.com/support/home/en-in/product-support/product/powerpath-for-linux/drivers).
- `Untar` the PowerPath archive, Copy the RPM package into a temporary folder and Install PowerPath using `rpm -ivh DellEMCPower.LINUX-<version>-<build>.<platform>.x86_64.rpm`
- Start the PowerPath service using `systemctl start PowerPath`

### (Optional) Volume Snapshot Requirements
Expand All @@ -125,15 +125,15 @@ snapshot:
```
#### Volume Snapshot CRD's
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. For installation, use [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/client/config/crd)
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. For installation, use [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/client/config/crd)
#### Volume Snapshot Controller
The CSI external-snapshotter sidecar is split into two controllers to support Volume snapshots.
- A common snapshot controller
- A CSI external-snapshotter sidecar
The common snapshot controller must be installed only once in the cluster, irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/deploy/kubernetes/snapshot-controller)
The common snapshot controller must be installed only once in the cluster, irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available here: [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/deploy/kubernetes/snapshot-controller)

*NOTE:*
- The manifests available on GitHub install the snapshotter image:
Expand All @@ -152,7 +152,7 @@ kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl
```

*NOTE:*
- It is recommended to use 5.0.x version of snapshotter/snapshot-controller.
- It is recommended to use 6.0.x version of snapshotter/snapshot-controller.
- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration.

### (Optional) Replication feature Requirements
Expand All @@ -173,7 +173,7 @@ CRDs should be configured during replication prepare stage with repctl as descri

**Steps**

1. Run `git clone -b v2.3.0 https://github.com/dell/csi-powermax.git` to clone the git repository. This will include the Helm charts and dell-csi-helm-installer scripts.
1. Run `git clone -b v2.4.0 https://github.com/dell/csi-powermax.git` to clone the git repository. This will include the Helm charts and dell-csi-helm-installer scripts.
2. Ensure that you have created a namespace where you want to install the driver. You can run `kubectl create namespace powermax` to create a new one
3. Edit the `samples/secret/secret.yaml file, point to the correct namespace, and replace the values for the username and password parameters.
These values can be obtained using base64 encoding as described in the following example:
Expand All @@ -185,7 +185,8 @@ CRDs should be configured during replication prepare stage with repctl as descri
4. Create the secret by running `kubectl create -f samples/secret/secret.yaml`.
5. If you are going to install the new CSI PowerMax ReverseProxy service, create a TLS secret with the name - _csireverseproxy-tls-secret_ which holds an SSL certificate and the corresponding private key in the namespace where you are installing the driver.
6. Copy the default values.yaml file `cd helm && cp csi-powermax/values.yaml my-powermax-settings.yaml`
7. Edit the newly created file and provide values for the following parameters `vi my-powermax-settings.yaml`
7. Ensure the unisphere have 10.0 REST endpoint support by clicking on Unisphere -> Help (?) -> About in Unisphere for PowerMax GUI.
8. Edit the newly created file and provide values for the following parameters `vi my-powermax-settings.yaml`

| Parameter | Description | Required | Default |
|-----------|--------------|------------|----------|
Expand Down Expand Up @@ -343,7 +344,7 @@ global:
csireverseproxy:
# Set enabled to true if you want to use proxy
enabled: true
image: dellemc/csipowermax-reverseproxy:v1.4.0
image: dellemc/csipowermax-reverseproxy:v2.3.0
tlsSecret: csirevproxy-tls-secret
deployAsSidecar: true
port: 2222
Expand Down Expand Up @@ -391,7 +392,7 @@ global:
csireverseproxy:
# Set enabled to true if you want to use proxy
enabled: true
image: dellemc/csipowermax-reverseproxy:v1.4.0
image: dellemc/csipowermax-reverseproxy:v2.3.0
tlsSecret: csirevproxy-tls-secret
deployAsSidecar: true
port: 2222
Expand Down
6 changes: 3 additions & 3 deletions content/docs/csidriver/installation/helm/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,15 @@ snapshot:
```
#### Volume Snapshot CRD's
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Use [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/client/config/crd) for the installation.
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Use [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/client/config/crd) for the installation.
#### Volume Snapshot Controller
The CSI external-snapshotter sidecar is split into two controllers:
- A common snapshot controller
- A CSI external-snapshotter sidecar
The common snapshot controller must be installed only once in the cluster irrespective of the number of CSI drivers installed in the cluster. On OpenShift clusters 4.4 and later, the common snapshot-controller is pre-installed. In the clusters where it is not present, it can be installed using `kubectl` and the manifests are available:
Use [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/deploy/kubernetes/snapshot-controller) for the installation.
Use [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/deploy/kubernetes/snapshot-controller) for the installation.

*NOTE:*
- The manifests available on GitHub install the snapshotter image:
Expand All @@ -129,7 +129,7 @@ kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl
```

*NOTE:*
- It is recommended to use 5.0.x version of snapshotter/snapshot-controller.
- It is recommended to use 6.0.x version of snapshotter/snapshot-controller.

### Volume Health Monitoring

Expand Down
8 changes: 4 additions & 4 deletions content/docs/csidriver/installation/helm/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Install CSI Driver for Unity XT using this procedure.

*Before you begin*

* You must have the downloaded files, including the Helm chart from the source [git repository](https://github.com/dell/csi-unity) with the command ```git clone -b v2.3.0 https://github.com/dell/csi-unity.git```, as a pre-requisite for running this procedure.
* You must have the downloaded files, including the Helm chart from the source [git repository](https://github.com/dell/csi-unity) with the command ```git clone -b v2.4.0 https://github.com/dell/csi-unity.git```, as a pre-requisite for running this procedure.
* In the top-level dell-csi-helm-installer directory, there should be two scripts, `csi-install.sh` and `csi-uninstall.sh`.
* Ensure _unity_ namespace exists in Kubernetes cluster. Use the `kubectl create namespace unity` command to create the namespace if the namespace is not present.

Expand Down Expand Up @@ -252,14 +252,14 @@ Procedure
In order to use the Kubernetes Volume Snapshot feature, you must ensure the following components have been deployed on your Kubernetes cluster

#### Volume Snapshot CRD's
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Use [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/client/config/crd) for the installation.
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Use [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/client/config/crd) for the installation.

#### Volume Snapshot Controller
The CSI external-snapshotter sidecar is split into two controllers:
- A common snapshot controller
- A CSI external-snapshotter sidecar

Use [v5.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v5.0.1/deploy/kubernetes/snapshot-controller) for the installation.
Use [v6.0.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1/deploy/kubernetes/snapshot-controller) for the installation.

#### Installation example

Expand All @@ -273,7 +273,7 @@ Procedure
```

**Note**:
- It is recommended to use 5.0.x version of snapshotter/snapshot-controller.
- It is recommended to use 6.0.x version of snapshotter/snapshot-controller.
- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration.


Expand Down
6 changes: 3 additions & 3 deletions content/docs/csidriver/installation/offline/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ cd dell-csi-operator/scripts
dellemc/csi-isilon:v2.0.0
dellemc/csi-isilon:v2.1.0
dellemc/csipowermax-reverseproxy:v1.4.0
dellemc/csi-powermax:v2.0.0
dellemc/csi-powermax:v2.1.0
dellemc/csipowermax-reverseproxy:v2.3.0
dellemc/csi-powermax:v2.3.0
dellemc/csi-powermax:v2.4.0
dellemc/csi-powerstore:v2.0.0
dellemc/csi-powerstore:v2.1.0
dellemc/csi-unity:v2.0.0
Expand Down
Loading

0 comments on commit 283ff5f

Please sign in to comment.