CSI Drivers
Installation of Dell CSI Drivers using Dell CSM Operator
The Dell Container Storage Modules 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.24, 1.25, 1.26 | 4.10, 4.10 EUS, 4.11 |
NOTE:
- Authorization module is only supported on Kubernetes platforms.
The table below lists the driver and modules versions installable with the CSM Operator:
CSI Driver | Version | CSM Authorization | CSM Replication | CSM Observability | CSM Resiliency |
---|---|---|---|---|---|
CSI PowerScale | 2.6.0 | 1.6.0 | 1.4.0 | 1.5.0 | N/A |
CSI PowerFlex | 2.6.0 | 1.6.0 | 1.4.0 | 1.5.0 | N/A |
CSI PowerStore | 2.6.0 | N/A | N/A | N/A | N/A |
NOTE:
- Refer to sample files here for prior versions of CSM.
Dell CSM Operator can be installed manually or via Operator Hub.
git clone -b v1.1.0 https://github.com/dell/csm-operator.git
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.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.
Dell CSM Operator can be upgraded in 2 ways:
1.Using script (for non-OLM based installation)
2.Using Operator Lifecycle Manager (OLM)
git clone -b v1.1.0 https://github.com/dell/csm-operator.git
cd csm-operator
bash scripts/install.sh --upgrade
. This command will install the latest version of the operator.Note: Dell CSM Operator would install to the ‘dell-csm-operator’ namespace by default.
The upgrade of the Dell CSM Operator is done via Operator Lifecycle Manager.
The Update approval
(InstallPlan
in OLM terms) strategy plays a role while upgrading dell-csm-operator on OpenShift. This option can be set during installation of dell-csm-operator on OpenShift via the console and can be either set to Manual
or Automatic
.
Update approval
is set to Automatic
, OpenShift automatically detects whenever the latest version of dell-csm-operator is available in the Operator hub
, and upgrades it to the latest available version.Manual
, OpenShift notifies of an available upgrade. This notification can be viewed by the user in the Installed Operators
section of the OpenShift console. Clicking on the hyperlink to Approve
the installation would trigger the dell-csm-operator upgrade process.NOTE: The recommended version of OLM for Upstream Kubernetes is v0.18.3
.
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.
Installation of Dell CSI Drivers using Dell CSM Operator
Installation of Dell CSM Modules using Dell CSM Operator
Troubleshooting guide for Dell CSM Operator
Release notes for Dell Container Storage Modules Operator