diff --git a/content/docs/csidriver/installation/helm/isilon.md b/content/docs/csidriver/installation/helm/isilon.md index 23658d78fe..ac71233281 100644 --- a/content/docs/csidriver/installation/helm/isilon.md +++ b/content/docs/csidriver/installation/helm/isilon.md @@ -38,43 +38,7 @@ Install Helm 3.0 on the master node before you install the CSI Driver for Dell P Run the `curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash` command to install Helm 3.0. ### (Optional) Volume Snapshot Requirements - -Applicable only if you decided to enable snapshot feature in `values.yaml` - -```yaml -controller: - snapshot: - enabled: true -``` - -#### 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:[v6.2.1](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.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: [v6.2.1](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.1/deploy/kubernetes/snapshot-controller) - -*NOTE:* -- The manifests available on GitHub install the snapshotter image: - - [quay.io/k8scsi/csi-snapshotter:v4.0.x](https://quay.io/repository/k8scsi/csi-snapshotter?tag=v4.0.0&tab=tags) -- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration. - - -#### Installation example -You can install CRDs and the default snapshot controller by running these commands: -```bash -git clone https://github.com/kubernetes-csi/external-snapshotter/ -cd ./external-snapshotter -git checkout release- -kubectl kustomize client/config/crd | kubectl create -f - -kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - -``` - -*NOTE:* -- It is recommended to use 6.2.x version of snapshotter/snapshot-controller. + For detailed snapshot setup procedure, [click here.](../../../../snapshots/#optional-volume-snapshot-requirements) ### (Optional) Volume Health Monitoring Volume Health Monitoring feature is optional and by default this feature is disabled for drivers when installed via helm. diff --git a/content/docs/csidriver/installation/helm/powerflex.md b/content/docs/csidriver/installation/helm/powerflex.md index f5c8851e6c..803f5cec18 100644 --- a/content/docs/csidriver/installation/helm/powerflex.md +++ b/content/docs/csidriver/installation/helm/powerflex.md @@ -70,44 +70,7 @@ For detailed PowerFlex installation procedure, see the [Dell PowerFlex Deploymen ### (Optional) Volume Snapshot Requirements - -Applicable only if you decided to enable snapshot feature in `values.yaml` - -```yaml -controller: - snapshot: - enabled: true -``` - -#### 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: [v6.1.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.1.0/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: [v6.1.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.1.0/deploy/kubernetes/snapshot-controller) - -*NOTE:* -- The manifests available on GitHub install the snapshotter image: - - [quay.io/k8scsi/csi-snapshotter:v4.0.x](https://quay.io/repository/k8scsi/csi-snapshotter?tag=v4.0.0&tab=tags) -- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration. - -#### Installation example - -You can install CRDs and default snapshot controller by running following commands: -```bash -git clone https://github.com/kubernetes-csi/external-snapshotter/ -cd ./external-snapshotter -git checkout release- -kubectl kustomize client/config/crd | kubectl create -f - -kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - -``` - -*NOTE:* -- When using Kubernetes it is recommended to use 6.1.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. + For detailed snapshot setup procedure, [click here.](../../../../snapshots/#optional-volume-snapshot-requirements) ## Install the Driver diff --git a/content/docs/csidriver/installation/helm/powermax.md b/content/docs/csidriver/installation/helm/powermax.md index 56c1a3cf8e..c390ac25a2 100644 --- a/content/docs/csidriver/installation/helm/powermax.md +++ b/content/docs/csidriver/installation/helm/powermax.md @@ -160,44 +160,7 @@ Set up the PowerPath for Linux as follows: - Start the PowerPath service using `systemctl start PowerPath` ### (Optional) Volume Snapshot Requirements - -Applicable only if you decided to enable snapshot feature in `values.yaml` - -```yaml -snapshot: - enabled: true -``` - -#### Volume Snapshot CRD's -The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. For installation, use [v6.2.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.0/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: [v6.2.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.0/deploy/kubernetes/snapshot-controller) - -*NOTE:* -- The manifests available on GitHub install the snapshotter image: - [quay.io/k8scsi/csi-snapshotter:v4.0.x](https://quay.io/repository/k8scsi/csi-snapshotter?tag=v4.0.0&tab=tags) -- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration. - -#### Installation example - -You can install CRDs and the default snapshot controller by running the following commands: -```bash -git clone https://github.com/kubernetes-csi/external-snapshotter/ -cd ./external-snapshotter -git checkout release- -kubectl kustomize client/config/crd | kubectl create -f - -kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - -``` - -*NOTE:* -- It is recommended to use 6.1.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. + For detailed snapshot setup procedure, [click here.](../../../../snapshots/#optional-volume-snapshot-requirements) ### (Optional) Replication feature Requirements diff --git a/content/docs/csidriver/installation/helm/powerstore.md b/content/docs/csidriver/installation/helm/powerstore.md index 8ddafe634a..2394491f59 100644 --- a/content/docs/csidriver/installation/helm/powerstore.md +++ b/content/docs/csidriver/installation/helm/powerstore.md @@ -94,42 +94,7 @@ Set up Linux multipathing as follows: - Ensure that the multipath command for `multipath.conf` is available on all Kubernetes nodes. ### (Optional) Volume Snapshot Requirements - -Applicable only if you decided to enable the snapshot feature in `values.yaml` - -```yaml -snapshot: - enabled: true -``` - -#### Volume Snapshot CRD's -The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Use [v6.1.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.1.0/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 [v6.1.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.1.0/deploy/kubernetes/snapshot-controller) for the installation. - -*NOTE:* -- The manifests available on GitHub install the snapshotter image: - - [quay.io/k8scsi/csi-snapshotter:v4.0.x](https://quay.io/repository/k8scsi/csi-snapshotter?tag=v4.0.0&tab=tags) -- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration. - -#### Installation example -You can install CRDs and default snapshot controller by running these commands: -```bash -git clone https://github.com/kubernetes-csi/external-snapshotter/ -cd ./external-snapshotter -git checkout release- -kubectl kustomize client/config/crd | kubectl create -f - -kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - -``` - -*NOTE:* -- It is recommended to use 6.1.x version of snapshotter/snapshot-controller. + For detailed snapshot setup procedure, [click here.](../../../../snapshots/#optional-volume-snapshot-requirements) ### Volume Health Monitoring diff --git a/content/docs/csidriver/installation/helm/unity.md b/content/docs/csidriver/installation/helm/unity.md index eba3659a90..d065a3c52b 100644 --- a/content/docs/csidriver/installation/helm/unity.md +++ b/content/docs/csidriver/installation/helm/unity.md @@ -239,43 +239,7 @@ Procedure **Note:** * Parameters "allowRWOMultiPodAccess" and "syncNodeInfoInterval" have been enabled for configuration in values.yaml and this helps users to dynamically change these values without the need for driver re-installation. -6. Setup for snapshots. - - Applicable only if you decided to enable snapshot feature in `values.yaml` - - ```yaml - controller: - snapshot: - enabled: true - ``` - - 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 [v6.2.1](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.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 [v6.2.1](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.1.0/deploy/kubernetes/snapshot-controller) for the installation. - - #### Installation example - - You can install CRDs and default snapshot controller by running following commands: - ```bash - git clone https://github.com/kubernetes-csi/external-snapshotter/ - cd ./external-snapshotter - git checkout release- - kubectl kustomize client/config/crd | kubectl create -f - - kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - - ``` - - **Note**: - - It is recommended to use 6.1.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. - +6. For detailed snapshot setup procedure, [click here.](../../../../snapshots/#optional-volume-snapshot-requirements) 7. Run the `./csi-install.sh --namespace unity --values ./myvalues.yaml` command to proceed with the installation using bash script. diff --git a/content/docs/snapshots/_index.md b/content/docs/snapshots/_index.md index 07be659245..6872a24fff 100644 --- a/content/docs/snapshots/_index.md +++ b/content/docs/snapshots/_index.md @@ -32,3 +32,45 @@ spec: After the VolumeSnapshot has been successfully created by the CSI driver, a VolumeSnapshotContent object is automatically created. When the status of the VolumeSnapshot object has the _readyToUse_ field set to _true_, it is available for use. >Note: VolumeSnapshots can be listed using the command `kubectl get volumesnapshot -n ` + + +### (Optional) Volume Snapshot Requirements + +Applicable only if you decide to enable the snapshot feature in `values.yaml`. + +```yaml +snapshot: + enabled: true +``` + +#### Volume Snapshot CRD's +The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. For installation, use [v6.2.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.0/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: [v6.2.x](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.2.0/deploy/kubernetes/snapshot-controller) + +*NOTE:* +- The manifests available on GitHub install the snapshotter image: + [quay.io/k8scsi/csi-snapshotter:v4.0.x](https://quay.io/repository/k8scsi/csi-snapshotter?tag=v4.0.0&tab=tags) +- The CSI external-snapshotter sidecar is still installed along with the driver and does not involve any extra configuration. + +#### Installation example + +You can install CRDs and the default snapshot controller by running the following commands: +```bash +git clone https://github.com/kubernetes-csi/external-snapshotter/ +cd ./external-snapshotter +git checkout release-6.2.0 +kubectl kustomize client/config/crd | kubectl create -f - +kubectl -n kube-system kustomize deploy/kubernetes/snapshot-controller | kubectl create -f - +``` + +*NOTE:* +- It is recommended to use the 6.2.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. +