CSI Drivers
Installation of Dell CSI Drivers using Dell CSM Operator
The Dell CSM Operator is currently in tech-preview and is not supported in production environments. It can be used in environments where no other Dell CSI Drivers or CSM Modules are installed.
The Dell CSM Operator is a Kubernetes Operator, which can be used to install and manage the CSI Drivers and CSM Modules provided by Dell for various storage platforms. This operator is available as a community operator for upstream Kubernetes and can be deployed using OperatorHub.io. The operator can be installed using OLM (Operator Lifecycle Manager) or manually.
Dell CSM Operator has been tested and qualified on Upstream Kubernetes and OpenShift. Supported versions are listed below.
Kubernetes Version | OpenShift Version |
---|---|
1.21, 1.22, 1.23 | 4.8, 4.9 |
CSI Driver | Version | ConfigVersion |
---|---|---|
CSI PowerScale | 2.2.0 | v2.2.0 |
CSM Modules | Version | ConfigVersion |
---|---|---|
CSM Authorization | 1.2.0 | v1.2.0 |
Dell CSM Operator can be installed manually or via Operator Hub.
cd csm-operator
deploy/operator.yaml
file and set the image name for the CSM Operator Deployment.bash scripts/install.sh
to install the operator.NOTE: Dell CSM Operator will be installed in the
dell-csm-operator
namespace.
kubectl get pods -n dell-csm-operator
to validate the installation. If installed successfully, you should be able to see the operator pod in the dell-csm-operator
namespace.cd csm-operator
bash scripts/install_olm.sh
to install the operator.NOTE: Dell CSM Operator will get installed in the
test-csm-operator-olm
namespace.
kubectl get pods -n test-csm-operator-olm
to validate the installation. If installed successfully, you should be able to see the operator pods and CSV in the test-csm-operator-olm
namespace. The CSV phase will be in Succeeded
state.NOTE: The recommended version of OLM for upstream Kubernetes is
v0.18.2
.
dell-csm-operator
can be installed via Operator Hub on upstream Kubernetes clusters & Red Hat OpenShift Clusters.
The installation process involves the creation of a Subscription
object either via the OperatorHub UI or using kubectl/oc
. While creating the Subscription
you can set the Approval strategy for the InstallPlan
for the operator to:
InstallPlan
for installation/upgrades.To uninstall a CSM operator, run bash scripts/uninstall.sh
. This will uninstall the operator in dell-csm-operator
namespace.
To uninstall a CSM operator installed with OLM run bash scripts/uninstall_olm.sh
. This will uninstall the operator in test-csm-operator-olm
namespace.
As part of the Dell CSM Operator installation, a CRD representing configuration for the CSI Driver and CSM Modules is also installed.
containerstoragemodule
CRD is installed in API Group storage.dell.com
.
Drivers and modules can be installed by creating a customResource
.
Each CSI Driver and CSM Module installation is represented by a Custom Resource.
The specification for the Custom Resource is the same for all the drivers.Below is a list of all the mandatory and optional fields in the Custom Resource specification
configVersion - Configuration version - refer here for appropriate config version.
replicas - Number of replicas for controller plugin - must be set to 1 for all drivers.
dnsPolicy - Determines the dnsPolicy for the node daemonset. Accepted values are Default
, ClusterFirst
, ClusterFirstWithHostNet
, None
.
common - This field is mandatory and is used to specify common properties for both controller and the node plugin.
controller - List of environment variables and values which are applicable only for controller.
node - List of environment variables and values which are applicable only for node.
sideCars - Specification for CSI sidecar containers.
authSecret - Name of the secret holding credentials for use by the driver. If not specified, the default secret *-creds must exist in the same namespace as driver.
tlsCertSecret - Name of the TLS cert secret for use by the driver. If not specified, a secret *-certs must exist in the namespace as driver.
tolerations - List of tolerations which should be applied to the driver StatefulSet/Deployment and DaemonSet. It should be set separately in the controller and node sections if you want separate set of tolerations for them.
nodeSelector - Used to specify node selectors for the driver StatefulSet/Deployment and DaemonSet.
Note: The
image
field should point to the correct image tag for version of the driver you are installing.
On Upstream Kubernetes clusters, make sure to install
The Kubernetes Volume Snapshot CRDs can be obtained and installed from the external-snapshotter project on Github. Manifests are available here
The CSI external-snapshotter sidecar is split into two controllers:
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, 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
NOTE:
You can install CRDs and the default snapshot controller by running the following commands:
git clone https://github.com/kubernetes-csi/external-snapshotter/
cd ./external-snapshotter
git checkout release-<your-version>
kubectl create -f client/config/crd
kubectl create -f deploy/kubernetes/snapshot-controller
NOTE:
Refer PowerScale Driver to install the driver via Operator
Note: If you are using an OLM based installation, example manifests are available in
OperatorHub
UI. You can edit these manifests and install the driver using theOperatorHub
UI.
Once the driver Custom Resource (CR)
is created, you can verify the installation as mentioned below
$ kubectl get csm/<name-of-custom-resource> -n <driver-namespace> -o yaml
Succeeded
state. If the status is not Succeeded
, see the Troubleshooting guide for more information.The CSI Drivers and CSM Modules installed by the Dell CSM Operator can be updated like any Kubernetes resource. This can be achieved in various ways which include:
kubectl edit
For e.g. - If the name of the installed PowerScale driver is powerscale, then run
# Replace driver-namespace with the namespace where the PowerScale driver is installed
$ kubectl edit csm/powerscale -n <driver-namespace>
and modify the installationkubectl patch
The CSI Drivers and CSM Modules can be uninstalled by deleting the Custom Resource.
For e.g.
$ kubectl delete csm/powerscale -n <driver-namespace>
By default, the forceRemoveDriver
option is set to true
which will uninstall the CSI Driver and CSM Modules when the Custom Resource is deleted. Setting this option to false
is not recommended.
Although the sidecars field in the driver specification is optional, it is strongly recommended to not modify any details related to sidecars provided (if present) in the sample manifests. The only exception to this is modifications requested by the documentation, for example, filling in blank IPs or other such system-specific data. Any modifications not specifically requested by the documentation should be only done after consulting with Dell support.
The CSM Operator can optionally enable modules that are supported by the specific Dell CSI driver. By default, the modules are disabled but they can be enabled by setting the enabled
flag to true and setting any other configuration options for the given module.
Installation of Dell CSI Drivers using Dell CSM Operator
Installation of Dell CSM Modules using Dell CSM Operator
Troubleshooting guide for Dell CSM Operator