Installation Guide

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 vxflexos.

   oc new-project vxflexos
   

2. Create config secret:

   
   

   Create a file called config.yaml or use sample:

   Example:

   cat << EOF > config.yaml
   - username: "admin"
     password: "password"
     systemID: "2b11bb111111bb1b"
     endpoint: "https://127.0.0.2"
     skipCertificateValidation: true
     mdm: "10.0.0.3,10.0.0.4"
   EOF
   

   Add blocks for each Powerflex 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 vxflexos-config.

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

   Use this command to create the config:

   oc apply -f secret-vxflexos-config.yaml
   

   Use this command to replace or update the config:

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

   Verify config secret is created.

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

Note: - Configure SFTP settings based on PowerFlex Concepts

3. Create Custom Resource ContainerStorageModule for powerflex.

   
   

   Use this command to create the ContainerStorageModule Custom Resource:

   oc create -f csm-vxflexos.yaml
   

   Example:

   cat << EOF > csm-vxflexos.yaml
   apiVersion: storage.dell.com/v1
   kind: ContainerStorageModule
   metadata:
     name: vxflexos
     namespace: vxflexos
   spec:
     driver:
       csiDriverType: "powerflex"
       configVersion: v2.15.1
   EOF 
   

   Detailed Configuration: Use the sample file for detailed settings.

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

Parameters

Parameter	Description	Required	Default
dnsPolicy	Determines the DNS Policy of the Node service	Yes	ClusterFirstWithHostNet
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”
replicas	Controls the number of controller pods you deploy. If the number of controller pods is greater than the number of available nodes, excess pods will become stay in a pending state. Defaults are 2 which allows for Controller high availability.	Yes	2
storageCapacity.enabled	Enable/Disable storage capacity tracking	No	true
storageCapacity.pollInterval	Configure how often the driver checks for changed capacity	No	5m
enableQuota	a boolean that, when enabled, will set quota limit for a newly provisioned NFS volume	No	none
maxVxflexosVolumesPerNode	Specify default value for maximum number of volumes that controller can publish to the node.If value is zero CO SHALL decide how many volumes of this type can be published by the controller to the node	Yes	0
Common parameters for node and controller
X_CSI_VXFLEXOS_ENABLELISTVOLUMESNAPSHOT	Enable list volume operation to include snapshots (since creating a volume from a snap actually results in a new snap)	No	false
X_CSI_VXFLEXOS_ENABLESNAPSHOTCGDELETE	Enable this to automatically delete all snapshots in a consistency group when a snap in the group is deleted	No	false
X_CSI_ALLOW_RWO_MULTI_POD_ACCESS	Setting allowRWOMultiPodAccess to “true” will allow multiple pods on the same node to access the same RWO volume. This behavior conflicts with the CSI specification version 1.3. NodePublishVolume description that requires an error to be returned in this case. However, some other CSI drivers support this behavior and some customers desire this behavior. Customers use this option at their own risk.	No	false
INTERFACE_NAMES	A mapping of node names to interface names. Only necessary when SDC is disabled.	No	none
Controller parameters
X_CSI_POWERFLEX_EXTERNAL_ACCESS	allows specifying additional entries for hostAccess of NFS volumes. Both single IP address and subnet are valid entries	No	empty
X_CSI_HEALTH_MONITOR_ENABLED	Enable/Disable health monitor of CSI volumes from Controller plugin - volume condition	No	false
Node parameters
X_CSI_RENAME_SDC_ENABLED	Enable this to rename the SDC with the given prefix. The new name will be (“prefix” + “worker_node_hostname”) and it should not exceed 31 chars.	Yes	false
X_CSI_APPROVE_SDC_ENABLED	Enable this to to approve restricted SDC by GUID during setup	Yes	false
X_CSI_HEALTH_MONITOR_ENABLED	Enable/Disable health monitor of CSI volumes from Node plugin - volume condition	No	false
X_CSI_SDC_ENABLED	Enable/Disable installation of the SDC.	Yes	true
X_CSI_SDC_SFTP_REPO_ENABLED	A boolean that enables/disables the SFTP repository settings for SDC.	No	false
X_CSI_SFTP_REPO_ADDRESS	Specifies the address of the Dell SFTP/private repository to look up for SDC kernel files.	No	“sftp://0.0.0.0”
X_CSI_SFTP_REPO_USER	Specifies the username to authenticate to the SFTP repository.	No	“sdcSFTPRepoUser”

Check if ContainerStorageModule CR is created successfully:

oc get csm vxflexos -n vxflexos

NAME        CREATIONTIME   CSIDRIVERTYPE   CONFIGVERSION                                           STATE
vxflexos    3h             powerflex       v2.15.1         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-vxflexos.yaml
   

   Example:

   cat << EOF > sc-vxflexos.yaml
   apiVersion: storage.k8s.io/v1
   kind: StorageClass
   metadata:
     name: vxflexos
     annotations:
       storageclass.kubernetes.io/is-default-class: "true"
   provisioner: csi-vxflexos.dellemc.com
   reclaimPolicy: Delete
   allowVolumeExpansion: true
   parameters:
     storagepool: <STORAGE_POOL>
     systemID: <SYSTEM_ID>
     csi.storage.k8s.io/fstype: ext4
   volumeBindingMode: Immediate
   EOF
   

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

   
   

   Verify Storage Class is created:

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

   
   

5. Create Volume Snapshot Class:

   
   

   Use this command to create the Volume Snapshot Class:

   oc apply -f vsclass-vxflexos.yaml
   

   Example:

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

   Verify Volume Snapshot Class is created:

   oc get volumesnapshotclass
   
   NAME                 DRIVER                     DELETIONPOLICY   AGE
   vsclass-vxflexos     csi-vxflexos.dellemc.com   Delete           3h9m
   

   
   

Configurations