Installation

Operator Installation

1. On the OpenShift console, navigate to OperatorHub and use the keyword filter to search for Dell Container Storage Modules.

2. Click Dell Container Storage Modules tile

3. Keep all default settings and click Install.

Verify that the operator is deployed

oc get operators

NAME                                                          AGE
dell-csm-operator-certified.openshift-operators               2d21h

oc get pod -n openshift-operators

NAME                                                       READY   STATUS       RESTARTS      AGE
dell-csm-operator-controller-manager-86dcdc8c48-6dkxm      2/2     Running      21 (19h ago)  2d21h

CSI Driver Installation

1. Create project:

   
   

   Use this command to create new project. You can use any project name instead of unity.

   oc new-project unity
   

2. Create config secret:

   
   

   Create a file called config.yaml or use sample:

   Example:

   cat << EOF > config.yaml
    storageArrayList:
    - arrayId: "APM00******1"                 # unique array id of the Unisphere array
      username: "user"                        # username for connecting to API
      password: "password"                    # password for connecting to API
      endpoint: "https://10.1.1.1/"           # full URL path to the Unity XT API
      skipCertificateValidation: true         # indicates if client side validation of (management)server's certificate can be skipped
      isDefault: true                         # treat current array as a default (would be used by storage classes without arrayID parameter)
   EOF
   

   Add blocks for each unity array in config.yaml, and include both source and target arrays if replication is enabled.

   
   

   Edit the file, then run the command to create the unity-config.

   oc create secret generic unity-config --from-file=config=config.yaml -n unity --dry-run=client -oyaml > secret-unity-config.yaml
   

   Use this command to create the config:

   oc apply -f secret-unity-config.yaml
   

   Use this command to replace or update the config:

   oc replace -f secret-unity-config.yaml --force
   

   Verify config secret is created.

   oc get secret -n unity
   
   NAME                 TYPE        DATA   AGE
   unity-config         Opaque      1      3h7m
   

3. Create Custom Resource ContainerStorageModule for unity.

   
   

   Use this command to create the ContainerStorageModule Custom Resource:

   oc create -f csm-unity.yaml
   

   Example:

   cat << EOF > csm-unity.yaml
   apiVersion: storage.dell.com/v1
   kind: ContainerStorageModule
   metadata:
     name: unity
     namespace: unity
   spec:
     driver:
       csiDriverType: "unity"
       configVersion: v2.13.0
       forceRemoveDriver: true
   EOF 
   

   Detailed Configuration: Use the sample file for detailed settings.

   To set the parameters in CR. The table shows the main settings of the unity driver and their defaults.

Parameters

Parameter	Description	Required	Default
replicas	Controls the number of controller pods you deploy. If the number of controller pods is greater than the number of available nodes, the excess pods will be in pending state until new nodes are available for scheduling. Default is 2 which allows for Controller high availability.	Yes	2
namespace	Specifies namespace where the driver will be installed	Yes	“unity”
fsGroupPolicy	Defines which FS Group policy mode to be used. Supported modes None, File and ReadWriteOnceWithFSType. In OCP <= 4.16 and K8s <= 1.29, fsGroupPolicy is an immutable field.	No	“ReadWriteOnceWithFSType”
storageCapacity.enabled	Enable/Disable storage capacity tracking	No	true
storageCapacity.pollInterval	Configure how often the driver checks for changed capacity	No	5m
Common parameters for node and controller
X_CSI_UNITY_ALLOW_MULTI_POD_ACCESS	To enable sharing of volumes across multiple pods within the same node in RWO access mode	No	false
X_CSI_UNITY_SYNC_NODEINFO_INTERVAL	Time interval to add node info to array. Default 15 minutes. Minimum value should be 1	No	15
CSI_LOG_LEVEL	Sets the logging level of the driver	true	info
TENANT_NAME	Tenant name added while adding host entry to the array	No
CERT_SECRET_COUNT	Represents the number of certificate secrets, which the user is going to create for SSL authentication. (unity-cert-0..unity-cert-n). The minimum value should be 1.	false	1
X_CSI_UNITY_SKIP_CERTIFICATE_VALIDATION	Specifies if the driver is going to validate unisphere certs while connecting to the Unisphere REST API interface.If it is set to false, then a secret unity-certs has to be created with an X.509 certificate of CA which signed the Unisphere certificate	No	true
Controller parameters
X_CSI_HEALTH_MONITOR_ENABLED	Enable/Disable health monitor of CSI volumes from Controller plugin - volume condition	No	false
Node parameters
X_CSI_HEALTH_MONITOR_ENABLED	Enable/Disable health monitor of CSI volumes from Controller plugin - volume condition	No	false
X_CSI_ALLOWED_NETWORKS	Custom networks for Unity export. List of networks that can be used for NFS I/O traffic, CIDR format should be used “ip/prefix, ip/prefix”	No	empty

Check if ContainerStorageModule CR is created successfully:

oc get csm unity -n unity

NAME        CREATIONTIME   CSIDRIVERTYPE   CONFIGVERSION   STATE
unity       3h             unity           v2.13.0         Succeeded      

Check the status of the CR to verify if the driver installation is in the Succeeded state. If the status is not Succeeded, see the Troubleshooting guide for more information.

4. Create Storage class:

   
   

   Use this command to create the Storage Class:

   oc apply -f sc-unity.yaml
   

   Example:

   cat << EOF > sc-unity.yaml
   apiVersion: storage.k8s.io/v1
   kind: StorageClass
   metadata:
     name:  unity-<ARRAY_ID>-iscsi
   provisioner: csi-unity.dellemc.com
   reclaimPolicy: Delete
   allowVolumeExpansion: true
   volumeBindingMode: Immediate
   parameters: 
     protocol: iSCSI 
     arrayId: <ARRAY_ID>
     storagepool: <STORAGE_POOL> 
     thinProvisioned: "true"
     tieringPolicy: <TIERING_POLICY>
     hostIOLimitName: <HOST_IO_LIMIT_NAME>
     csi.storage.k8s.io/fstype: ext4
   EOF
   

   Replace placeholders with actual values for your unity array and various storage class sample refer here

   Verify Storage Class is created:

   oc get storageclass unity
   
   NAME                    PROVISIONER                    RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
   unity (default)         csi-unity.dellemc.com          Delete          Immediate           true                   3h8m
   

   
   

5. Create Volume Snapshot Class:

   
   

   Use this command to create the Volume Snapshot:

   oc apply -f vsclass-unity.yaml
   

   Example:

   cat << EOF > vsclass-unity.yaml
   apiVersion: snapshot.storage.k8s.io/v1
   kind: VolumeSnapshotClass
   metadata:
     name: unity-snapclass 
   driver: csi-unity.dellemc.com
   deletionPolicy: Delete
   EOF 
   

   Verify Volume Snapshot Class is created:

   oc get volumesnapshotclass
   
   NAME                      DRIVER                              DELETIONPOLICY   AGE
   unity-snapclass           csi-unity.dellemc.com               Delete           3h9m
   

   
   

Configurations