From 3fec5e77a0b4fa60b18b44d4bcf8f9c44cad3b6b Mon Sep 17 00:00:00 2001 From: Suzana Fernandes Date: Tue, 2 Sep 2025 12:39:10 +0000 Subject: [PATCH] Update Starlingx Dell PowerStore CSM/CSI support documentation Story: 2011308 Task: 52533 Change-Id: Icb6a2ec38c0ff7d1b1a2f48780895a415f6b2087 Signed-off-by: Suzana Fernandes --- doc/source/introduction/terms.rst | 2 +- ...nfigure-dell-storage-csms-937563b7bb36.rst | 181 +++++++++++------- ...ure-powerflex-csi-backend-20a371e4f7d3.rst | 90 ++++----- ...gure-powermax-csi-backend-7b6e65e3a811.rst | 21 +- ...re-powerscale-csi-backend-aa6a128c0b44.rst | 68 ++++--- ...re-powerstore-csi-backend-02af0aa983b0.rst | 42 ++-- ...gure-unity-xt-csi-backend-c1abbbd371dc.rst | 32 ++-- .../dell-storage-backend-28f5771e6d9b.rst | 38 ++-- .../dell-storage-snapshots-46916ac34bf0.rst | 24 ++- 9 files changed, 284 insertions(+), 214 deletions(-) diff --git a/doc/source/introduction/terms.rst b/doc/source/introduction/terms.rst index 2bd76ec36..75a4c3644 100644 --- a/doc/source/introduction/terms.rst +++ b/doc/source/introduction/terms.rst @@ -36,7 +36,7 @@ commonly used in the |org| community and in this documentation. functions either active/active or active/standby. |CSM| Observability - An OpenTelemetry agent that collects array-level metrics for Dell storage. + An OpenTelemetry agent that collects array-level metrics for Dell Storage. |CRUSH| The |CRUSH| algorithm computes storage locations in order to determine how diff --git a/doc/source/storage/kubernetes/configure-dell-storage-csms-937563b7bb36.rst b/doc/source/storage/kubernetes/configure-dell-storage-csms-937563b7bb36.rst index d987fe267..5ad89729e 100644 --- a/doc/source/storage/kubernetes/configure-dell-storage-csms-937563b7bb36.rst +++ b/doc/source/storage/kubernetes/configure-dell-storage-csms-937563b7bb36.rst @@ -16,7 +16,7 @@ CSM Observability ----------------- |CSM| Observability is an OpenTelemetry agent that collects array-level metrics -for Dell storage so they can be exported into a Prometheus database. With |CSM| +for Dell Storage so they can be exported into a Prometheus database. With |CSM| for Observability, you will gain visibility not only on the capacity of the volumes/file shares you manage with Dell |CSM| |CSI| drivers but also on their performance in terms of bandwidth, |IOPS|, and response time. @@ -25,11 +25,11 @@ performance in terms of bandwidth, |IOPS|, and response time. The |CSM| Observability is not available for Unity XT and is not fully available for all storages. You can check the compatibility/capabilities on - `Dell Documentation `__. + `Dell Documentation `__. -****************** -Enable Helm Charts -****************** +****************************** +Enable CSM Observability Chart +****************************** .. note:: @@ -38,13 +38,13 @@ Enable Helm Charts .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage Enable |CSM| Observability using the following command: .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csm-observability dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csm-observability dell-storage ********************* Update User Overrides @@ -61,30 +61,31 @@ Update User Overrides .. code-block:: none - :name: observabilityOverrides.yaml - karaviMetricsPowerstore: - enabled: true + ~(keystone_admin)$ cat << EOF > /home/sysadmin/observabilityOverrides.yaml + karaviMetricsPowerstore: + enabled: true - karaviMetricsPowerflex: - enabled: false + karaviMetricsPowerflex: + enabled: false - karaviMetricsPowerscale: - enabled: false + karaviMetricsPowerscale: + enabled: false - karaviMetricsPowermax: - enabled: false + karaviMetricsPowermax: + enabled: false + EOF #. Apply the overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csm-observability dell-storage --values=observabilityOverrides.yml + ~(keystone_admin)$ system helm-override-update dell-storage csm-observability dell-storage --values=/home/sysadmin/observabilityOverrides.yaml #. Apply the application. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage #. Check that the metrics are being generated by accessing the otel-collector pod API. @@ -102,7 +103,7 @@ CSM Observability Parameters :widths: auto +---------------------------------+---------------------------------------------+----------+---------+ - | Parameter | Description | Required | default | + | Parameter | Description | Required | Default | +=================================+=============================================+==========+=========+ | karaviMetricsPowerstore.enabled | If true, enable metrics for CSI-Powerstore. | No | True | +---------------------------------+---------------------------------------------+----------+---------+ @@ -125,7 +126,7 @@ storage volumes. Therefore, it does not clean up StatefulSet pods if the node ex them fails. ********************* -Enable csm-resiliency +Enable CSM Resiliency ********************* .. rubric:: |proc| @@ -135,34 +136,48 @@ Enable csm-resiliency .. code-block:: none - :name: powerstoreOverrides.yaml - csm: - resiliency: true - storageClasses: - - name: csi-powerstore-iscsi - arrayID: - fstype: ext4 + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerstoreOverrides.yaml + csm: + resiliency: true + storageClasses: + - name: csi-powerstore-iscsi + arrayID: + fstype: ext4 - secret: - arrays: - - globalID: - username: - password: - endpoint: https:///api/rest - isDefault: true - blockProtocol: "ISCSI" + secret: + arrays: + - globalID: + username: + password: + endpoint: https:///api/rest + isDefault: true + blockProtocol: "ISCSI" + EOF #. Apply the user overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=powerstoreOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=/home/sysadmin/powerstoreOverrides.yaml #. Apply the application. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage + +************************ +CSM Resiliency Parameter +************************ + +.. table:: + :widths: auto + + +---------------------------------+---------------------------------------------+----------+---------+ + | Parameter | Description | Required | Default | + +=================================+=============================================+==========+=========+ + | csm.resiliency | Enables/Disables sidecar container. | No | false | + +---------------------------------+---------------------------------------------+----------+---------+ --------------- CSM Replication @@ -174,9 +189,9 @@ replicate groups of volumes using the native replication technology available on the storage array and can provide you a way to restart applications in case of both planned and unplanned migration. -***************************** -Enable CSM Replication Charts -***************************** +**************************** +Enable CSM Replication Chart +**************************** .. rubric:: |prereq| @@ -186,37 +201,42 @@ Ensure that the csm-replication chart is enabled. (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csm-replication dell-storage +********************* +Update User Overrides +********************* + .. rubric:: |proc| -#. Add the ``csm.replication: true`` parameter to the user overrides. Below is - an example using Powerstore: +#. Create user overrides to configure replication. Below is an example using Powerstore: .. code-block:: none - :name: powerstoreOverrides.yaml - csm: - replication: true - app.starlingx.io/component: platform - storageClasses: - - name: csi-powerstore-iscsi - arrayID: - fstype: ext4 - replication: - remoteStorageClassName: remote_storageclass - remoteClusterID: remote_clusterid - remoteSystem: remote_system - rpo: "Five_Minutes" - ignoreNamespaces: false - volumeGroupPrefix: + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerstoreOverrides.yaml + labels: + isApplication: false + csm: + replication: true + storageClasses: + - name: csi-powerstore-iscsi + arrayID: + fstype: ext4 + replication: + remoteStorageClassName: remote_storageclass + remoteClusterID: remote_clusterid + remoteSystem: remote_system + rpo: "Five_Minutes" + ignoreNamespaces: false + volumeGroupPrefix: - secret: - arrays: - - globalID: - username: - password: - endpoint: https:///api/rest - isDefault: true - blockProtocol: "ISCSI" + secret: + arrays: + - globalID: + username: + password: + endpoint: https:///api/rest + isDefault: true + blockProtocol: "ISCSI" + EOF .. note:: @@ -228,12 +248,39 @@ Ensure that the csm-replication chart is enabled. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=powerstoreOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=/home/sysadmin/powerstoreOverrides.yaml #. Apply the application. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage +************************* +CSM Replication Parameter +************************* +.. table:: + :widths: auto + + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | Parameter | Description | Required | Default | + +======================================================+===========================================================================================================+==========+==============================+ + | csm.replication | Enables/Disables replication sidecar container. | No | false | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | controller.replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication | Used to configure replication sidecar container. | No | Not Applicable | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.remoteStorageClassName | Remote StorageClass name. | No | csi-powerstore-replication | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.remoteClusterID | Remote ClusterID. | No | Not Applicable | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.remoteSystem | Remote PowerStore system. | No | Not Applicable | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.rpo | Change to any other |RPOs| supported by PowerStore. | No | Five_Minutes | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.ignoreNamespaces | Set to true if you want to ignore namespaces and if false creates separate volume group per namespace. | No | false | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ + | storageClasses[0].replication.volumeGroupPrefix | Volume group prefix. | No | csi-powerstore | + +------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+----------+------------------------------+ diff --git a/doc/source/storage/kubernetes/configure-powerflex-csi-backend-20a371e4f7d3.rst b/doc/source/storage/kubernetes/configure-powerflex-csi-backend-20a371e4f7d3.rst index 419c778b8..3bd804341 100644 --- a/doc/source/storage/kubernetes/configure-powerflex-csi-backend-20a371e4f7d3.rst +++ b/doc/source/storage/kubernetes/configure-powerflex-csi-backend-20a371e4f7d3.rst @@ -44,56 +44,52 @@ Enable CSI PowerFlex Chart .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powerflex dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powerflex dell-storage #. Create overrides to configure the storage connection. .. code-block:: none - :name: powerflexOverrides.yaml - app.starlingx.io/component: platform + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerflexOverrides.yaml + csm: + resiliency: true - storageClasses: - - name: csi-powerflex-nfs - arrayId: - nasServer: nas_2 - provisioner: csi-vxflexos.dellemc.com - fstype: nfs - path: /target - reclaimPolicy: Delete - allowVolumeExpansion: true - volumeBindingMode: Immediate - mountOptions: ["hard"] - hostIoSize: 8192 - tieringPolicy: 0 - isDataReductionEnabled: "false" - thinProvisioned: "true" - storagePool: pool_2 - protocol: NFS + interfaceNames: + controller-0: enp0s9 - secret: - arrays: - - arrayId: - username: - password: - systemID: - allSystemNames: "pflex-1" - endpoint: https:///api/rest - isDefault: true - skipCertificateValidation: true - nasName: nas_2 + storageClasses: + - name: csi-powerflex-nfs + arrayId: + nasServer: nas_1 + fstype: nfs + storagepool: pool_1 + systemID: + + secret: + mdm: "10.0.0.1,10.0.0.2" + arrays: + - arrayId: + username: + password: + systemID: + allSystemNames: "pflex-1" + endpoint: https:///api/rest + isDefault: true + skipCertificateValidation: true + nasName: nas_1 + EOF #. Apply overrides using the following command: .. code-block:: - (keystone_admin)$ system helm-override-update dell-storage csi-powerflex dell-storage --values=powerflexOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powerflex dell-storage --values=/home/sysadmin/powerflexOverrides.yaml #. Apply the chart using the following command: .. code-block:: - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage ------------------------ UserOverrides Parameters @@ -106,17 +102,19 @@ General Parameters .. table:: :widths: auto - +------------------------------------+-----------------------------------------------------------+----------+----------+ - | Parameter | Description | Required | Default | - +====================================+===========================================================+==========+==========+ - | csm.replication | Enables/disables replication sidecar container. | No | false | - +------------------------------------+-----------------------------------------------------------+----------+----------+ - | csm.resiliency | Enables/disables dell-csi-replicator sidecar container. | No | false | - +------------------------------------+-----------------------------------------------------------+----------+----------+ - | app.starlingx.io/component | Core affinity. | No | platform | - +------------------------------------+-----------------------------------------------------------+----------+----------+ - | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted. | No | Delete | - +------------------------------------+-----------------------------------------------------------+----------+----------+ + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ + | Parameter | Description | Required | Default | + +====================================+===============================================================================================+==========+==================+ + | csm.replication | Enables/Disables dell-csi-replicator sidecar container. | No | false | + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ + | csm.resiliency | Enables/Disables podmon sidecar container. | No | false | + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ + | labels.isApplication | If set to true is can run with application core affinity, otherwise it runs as platform. | No | platform | + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ + | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted. | No | Delete | + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ + | interfaceNames. | Node name and port name for each data network. Make sure the interfaces can reach the MDMs. | Yes | Not Applicable | + +------------------------------------+-----------------------------------------------------------------------------------------------+----------+------------------+ ************************* StorageClasses Parameters @@ -209,7 +207,9 @@ Secret Parameters +--------------------------------------------+-----------------------------------------------------------------------------------------+----------+----------------+ | secret.arrays[0].skipCertificateValidation | Indicates if client-side validation of server's certificate can be skipped. | No | true | +--------------------------------------------+-----------------------------------------------------------------------------------------+----------+----------------+ - | secret.arrays[0].AllSystemNames | Previous names used in secret of Powerflex system. | Yes | Not Applicable | + | secret.arrays[0].allSystemNames | Previous names used in secret of Powerflex system. | Yes | Not Applicable | +--------------------------------------------+-----------------------------------------------------------------------------------------+----------+----------------+ | secret.arrays[0].nasName | What |NAS| should be used for |NFS| volumes. Required for |NFS| protocol. | No | Not Applicable | +--------------------------------------------+-----------------------------------------------------------------------------------------+----------+----------------+ + | secret.mdm | MDM IPv4 addresses or hostnames, separated by comma. | Yes | Not Applicable | + +--------------------------------------------+-----------------------------------------------------------------------------------------+----------+----------------+ diff --git a/doc/source/storage/kubernetes/configure-powermax-csi-backend-7b6e65e3a811.rst b/doc/source/storage/kubernetes/configure-powermax-csi-backend-7b6e65e3a811.rst index 85eb28010..da891f746 100644 --- a/doc/source/storage/kubernetes/configure-powermax-csi-backend-7b6e65e3a811.rst +++ b/doc/source/storage/kubernetes/configure-powermax-csi-backend-7b6e65e3a811.rst @@ -33,19 +33,23 @@ Enable CSI PowerMax Chart .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage #. Enable the chart. .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powermax dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powermax dell-storage #. Create overrides to configure the storage connection. .. code-block:: none - :name: powermaxOverrides.yaml + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powermaxOverrides.yaml + csm: + replication: true + authorization: true + secret: username: password: @@ -66,6 +70,10 @@ Enable CSI PowerMax Chart password: skipCertificateValidation: true + proxyAuthzTokens: + access: + refresh: + storageClasses: - name: "sc-0" SRP: "TEST" @@ -73,18 +81,19 @@ Enable CSI PowerMax Chart ApplicationPrefix: "prefix1" HostLimitName: "1000" DynamicDistribution: "Optimized + EOF #. Apply overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csi-powermax dell-storage --values=powermaxOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powermax dell-storage --values=/home/sysadmin/powermaxOverrides.yaml #. Apply the chart. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage ------------------------ UserOverrides Parameters @@ -104,7 +113,7 @@ General Parameters +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+----------+------------------------------+ | csm.authorization | Enables/disables |CSM| authorization and sidecar container. | No | false | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+----------+------------------------------+ - | app.starlingx.io/component | Core affinity. | No | platform | + | labels.isApplication | If set to true it can run with application core affinity, otherwise it runs as platform. | No | false | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+----------+------------------------------+ | replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | +----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+----------+------------------------------+ diff --git a/doc/source/storage/kubernetes/configure-powerscale-csi-backend-aa6a128c0b44.rst b/doc/source/storage/kubernetes/configure-powerscale-csi-backend-aa6a128c0b44.rst index f70417dd8..137ed97c3 100644 --- a/doc/source/storage/kubernetes/configure-powerscale-csi-backend-aa6a128c0b44.rst +++ b/doc/source/storage/kubernetes/configure-powerscale-csi-backend-aa6a128c0b44.rst @@ -36,7 +36,7 @@ Enable CSI PowerScale Chart .. code-block:: - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage #. Enable the chart. @@ -48,12 +48,17 @@ Enable CSI PowerScale Chart .. code-block:: none - :name: powerscaleOverrides.yaml + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerscaleOverrides.yaml + csm: + replication: false + resiliency: false + authorization: false isiPath: "/my/isi/path" controller: replication: + enabled: true replicationPrefix: "myCustomReplicationPrefix" secret: @@ -83,18 +88,19 @@ Enable CSI PowerScale Chart proxyAuthzTokens: access: "YWJjZGVmCg==" refresh: "YWJjZGVmCg==" + EOF #. Apply override. .. code-block:: - (keystone_admin)$ system helm-override-update dell-storage csi-powerscale dell-storage --values=powerscaleOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powerscale dell-storage --values=/home/sysadmin/powerscaleOverrides.yaml #. Apply chart. .. code-block:: - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage ------------------------ UserOverrides Parameters @@ -107,33 +113,33 @@ General Parameters .. table:: :widths: auto - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | Parameter | Description | Required | Default | - +==========================================+====================================================================+==================================+==============================+ - | app.starlingx.io/component | Code affinity. | No | platform | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | authorization.rootCertificate | Authorization proxy server root certificate. | Only if authorization is enabled | Not Applicable | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | certSecret | Secret containing the certificate. | No | Not Applicable | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | controller.replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted. | No | Delete | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | csm.authorization | Enables/disables authorization sidecar container. | No | false | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | csm.replication | Enables/disables dell-csi-replicator sidecar container. | No | false | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | csm.resiliency | Enables/disables podmon sidecar container. | No | false | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | driverName | Driver name. | No | csi-isilon.dellemc.com | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | isiPath | The base path for the volumes to be created on PowerScale cluster. | No | /ifs/data/csi | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | proxyAuthzTokens.access | Access token for authorization sidecar container access. | Only if authorization is enabled | Not Applicable | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ - | proxyAuthzTokens.refresh | Refresh token for authorization sidecar container access. | Only if authorization is enabled | Not Applicable | - +------------------------------------------+--------------------------------------------------------------------+----------------------------------+------------------------------+ + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | Parameter | Description | Required | Default | + +==========================================+===========================================================================================+==================================+==============================+ + | labels.isApplication | If set to true it can run with application core affinity, otherwise it runs as platform. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | authorization.rootCertificate | Authorization proxy server root certificate. | Only if authorization is enabled | Not Applicable | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | certSecret | Secret containing the certificate. | No | Not Applicable | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | controller.replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted. | No | Delete | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | csm.authorization | Enables/disables authorization sidecar container. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | csm.replication | Enables/disables dell-csi-replicator sidecar container. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | csm.resiliency | Enables/disables podmon sidecar container. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | driverName | Driver name. | No | csi-isilon.dellemc.com | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | isiPath | The base path for the volumes to be created on PowerScale cluster. | No | /ifs/data/csi | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | proxyAuthzTokens.access | Access token for authorization sidecar container access. | Only if authorization is enabled | Not Applicable | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ + | proxyAuthzTokens.refresh | Refresh token for authorization sidecar container access. | Only if authorization is enabled | Not Applicable | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------------------------------+------------------------------+ ************************* StorageClasses Parameters diff --git a/doc/source/storage/kubernetes/configure-powerstore-csi-backend-02af0aa983b0.rst b/doc/source/storage/kubernetes/configure-powerstore-csi-backend-02af0aa983b0.rst index f29c84e9c..13817d4a8 100644 --- a/doc/source/storage/kubernetes/configure-powerstore-csi-backend-02af0aa983b0.rst +++ b/doc/source/storage/kubernetes/configure-powerstore-csi-backend-02af0aa983b0.rst @@ -28,13 +28,13 @@ Enable CSI PowerStore Chart .. code-block:: - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage #. Enable the chart. .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powerstore dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-powerstore dell-storage #. Create overrides to configure the storage connection. @@ -42,7 +42,7 @@ Enable CSI PowerStore Chart .. code-block:: none - :name: powerstoreOverrides.yaml + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerstoreOverrides.yaml storageClasses: - name: csi-powerstore-iscsi arrayID: @@ -50,19 +50,19 @@ Enable CSI PowerStore Chart secret: arrays: - - globalID: username: password: endpoint: https:///api/rest isDefault: true blockProtocol: "ISCSI" + EOF **NFS Protocol** .. code-block:: none - :name: powerstoreOverrides.yaml + ~(keystone_admin)$ cat << EOF > /home/sysadmin/powerstoreOverrides.yaml storageClasses: - name: csi-powerstore-nfs arrayID: @@ -71,7 +71,6 @@ Enable CSI PowerStore Chart secret: arrays: - - globalID: username: password: @@ -79,18 +78,19 @@ Enable CSI PowerStore Chart isDefault: true blockProtocol: None nasName: NAS1 + EOF #. Apply overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=powerstoreOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-powerstore dell-storage --values=/home/sysadmin/powerstoreOverrides.yaml #. Apply the chart. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage ------------------------ UserOverrides Parameters @@ -103,19 +103,19 @@ General Parameters .. table:: :widths: auto - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ - | Parameter | Description | Required | Default | - +==========================================+=======================================================+==========+==============================+ - | csm.replication | Enables/disables replication sidecar container. | No | false | - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ - | csm.resiliency | Enables/disables podmon sidecar container. | No | false | - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ - | app.starlingx.io/component | Core Affinity. | No | platform | - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ - | controller.replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ - | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted.| No | Delete | - +------------------------------------------+-------------------------------------------------------+----------+------------------------------+ + +------------------------------------------+--------------------------------------------------------------------------------------------+---------+------------------------------+ + | Parameter | Description | Required | Default | + +==========================================+===========================================================================================+==========+==============================+ + | csm.replication | Enables/disables replication sidecar container. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------+------------------------------+ + | csm.resiliency | Enables/disables podmon sidecar container. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------+------------------------------+ + | labels.isApplication | If set to true it can run with application core affinity, otherwise it runs as platform. | No | false | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------+------------------------------+ + | controller.replication.replicationPrefix | Change replication prefix. | No | replication.storage.dell.com | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------+------------------------------+ + | controller.snapshot.deletionPolicy | Specifies what happens when VolumeSnapshot is deleted. | No | Delete | + +------------------------------------------+-------------------------------------------------------------------------------------------+----------+------------------------------+ ************************* StorageClasses Parameters diff --git a/doc/source/storage/kubernetes/configure-unity-xt-csi-backend-c1abbbd371dc.rst b/doc/source/storage/kubernetes/configure-unity-xt-csi-backend-c1abbbd371dc.rst index 9891efa94..eb330ae3a 100644 --- a/doc/source/storage/kubernetes/configure-unity-xt-csi-backend-c1abbbd371dc.rst +++ b/doc/source/storage/kubernetes/configure-unity-xt-csi-backend-c1abbbd371dc.rst @@ -31,24 +31,23 @@ Enable CSI Unity Chart .. code-block:: - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage #. Enable the chart. .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-unity dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled true dell-storage csi-unity dell-storage #. Create overrides to configure the storage connection. .. code-block:: none - :name: unityOverrides.yaml - + ~(keystone_admin)$ cat << EOF > /home/sysadmin/unityOverrides.yaml csm: - resiliency: false - app.starlingx.io/component: platform - + resiliency: true + labels: + isApplication: false storageClasses: - name: unity-virt2307pjxdbt-nfs arrayId: @@ -79,18 +78,19 @@ Enable CSI Unity Chart endpoint: https:// isDefault: true skipCertificateValidation: true + EOF #. Apply overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage csi-unity dell-storage --values=unityOverrides.yaml + ~(keystone_admin)$ system helm-override-update dell-storage csi-unity dell-storage --values=/home/sysadmin/unityOverrides.yaml #. Apply the chart. .. code-block:: none - (keystone_admin)$ system application-apply dell-storage + ~(keystone_admin)$ system application-apply dell-storage ------------------------ UserOverrides Parameters @@ -103,13 +103,13 @@ General Parameters .. table:: :widths: auto - +----------------------------+--------------------------------------------+----------+----------+ - | Parameter | Description | Required | Default | - +============================+============================================+==========+==========+ - | csm.resiliency | Enables/disables podmon sidecar container. | No | false | - +----------------------------+--------------------------------------------+----------+----------+ - | app.starlingx.io/component | Core Affinity. | No | platform | - +----------------------------+--------------------------------------------+----------+----------+ + +----------------------------+------------------------------------------------------------------------------------------+----------+----------+ + | Parameter | Description | Required | Default | + +============================+==========================================================================================+==========+==========+ + | csm.resiliency | Enables/disables podmon sidecar container. | No | false | + +----------------------------+------------------------------------------------------------------------------------------+----------+----------+ + | labels.isApplication | If set to true it can run with application core affinity, otherwise it runs as platform. | No | false | + +----------------------------+------------------------------------------------------------------------------------------+----------+----------+ ************************* diff --git a/doc/source/storage/kubernetes/dell-storage-backend-28f5771e6d9b.rst b/doc/source/storage/kubernetes/dell-storage-backend-28f5771e6d9b.rst index db66a94a6..2b8a5c4e7 100644 --- a/doc/source/storage/kubernetes/dell-storage-backend-28f5771e6d9b.rst +++ b/doc/source/storage/kubernetes/dell-storage-backend-28f5771e6d9b.rst @@ -9,28 +9,28 @@ Dell Storage Backend The |CSI| drivers by Dell implement an interface between |CSI| (|CSI| spec v1.6) enabled |CO| and Dell Storage Arrays. It is a plug-in that is installed -in Kubernetes to provide persistent storage using the Dell storage system. +in Kubernetes to provide persistent storage using the Dell Storage system. -For details about Dell |CSIs|, see ``__. +For details about Dell |CSIs|, see ``__. The Dell Technologies (Dell) |CSM| enables simple and consistent integration, and automation experiences, extending enterprise storage capabilities to Kubernetes for cloud-native stateful applications. -For details about Dell |CSMs|, see ``__. +For details about Dell |CSMs|, see ``__. .. rubric:: |prereq| -- Check if your Dell storage platform is supported. To check, see ``__. -- If using any |CSM|, check if it is supported for your platform. To check, see ``__. +- Check if your Dell storage platform is supported. To check, see ``__. +- If using any |CSM|, check if it is supported for your platform. To check, see ``__. - Controller is unlocked. -- The Dell-storage application is on the uploaded state. +- The dell-storage application is in the uploaded state. - All commands are executed on the active controller. .. note:: For every change on user-overrides to be updated on the application, you - need to reapply the override before applying the Dell-storage application. + need to reapply the override before applying the dell-storage application. .. note:: @@ -39,47 +39,51 @@ For details about Dell |CSMs|, see ``__. .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled false dell-storage dell-storage --------------- Common Commands --------------- -- Get list of enabled/disabled Dell-storage application charts. +- Get list of enabled/disabled dell-storage application charts. .. code-block:: none - (keystone_admin)$ system helm-override-list dell-storage --long + ~(keystone_admin)$ system helm-override-list dell-storage --long - Check |CSM|/|CSI| overrides. .. code-block:: none - (keystone_admin)$ system helm-override-show dell-storage dell-storage + ~(keystone_admin)$ system helm-override-show dell-storage dell-storage - Enable/disable the chart. .. code-block:: none - (keystone_admin)$ system helm-chart-attribute-modify --enabled dell-storage dell-storage + ~(keystone_admin)$ system helm-chart-attribute-modify --enabled dell-storage dell-storage - Apply overrides. .. code-block:: none - (keystone_admin)$ system helm-override-update dell-storage dell-storage --values= + ~(keystone_admin)$ system helm-override-update dell-storage dell-storage --values= -- Get the Dell-storage pods list. +- Get the dell-storage pods list. .. code-block:: none - (keystone_admin)$ kubectl get pods -n dell-storage + ~(keystone_admin)$ kubectl get pods -n dell-storage -- Apply/abort/remove the Dell-storage application. +- Apply/abort/remove the dell-storage application. .. code-block:: none - (keystone_admin)$ system application- dell-storage + ~(keystone_admin)$ system application- dell-storage + + .. note:: + + Before removing the application, |PVCs| associated with the Dell Storage backend must be deleted. -------------- Related Topics diff --git a/doc/source/storage/kubernetes/dell-storage-snapshots-46916ac34bf0.rst b/doc/source/storage/kubernetes/dell-storage-snapshots-46916ac34bf0.rst index 1e0e4396c..d5e42b720 100644 --- a/doc/source/storage/kubernetes/dell-storage-snapshots-46916ac34bf0.rst +++ b/doc/source/storage/kubernetes/dell-storage-snapshots-46916ac34bf0.rst @@ -24,7 +24,7 @@ Volume Snapshot for the Dell |CSI| provisioner. .. note:: - The Dell-storage |CSIs| charts already create default snapshotclasses. You + The dell-storage |CSIs| charts already create default snapshotclasses. You can list them by using the following command: .. code-block:: none @@ -35,7 +35,7 @@ Volume Snapshot for the Dell |CSI| provisioner. |CSI|-Powerstore is used in this example. -#. Check if the Dell-storage application is successfully applied. +#. Check if the dell-storage application is successfully applied. .. code-block:: none @@ -50,7 +50,7 @@ Volume Snapshot for the Dell |CSI| provisioner. .. code-block:: none - ~(keystone_admin)$ kubectl get -n dell-storage pvc + ~(keystone_admin)$ kubectl -n dell-storage get pvc NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE pvol0 Bound csi-powerstore-vol-0fca78f7dd 8Gi RWO csi-powerstore-nfs 5m @@ -62,7 +62,7 @@ Volume Snapshot for the Dell |CSI| provisioner. NAME DRIVER DELETIONPOLICY AGE csi-powerstore-snapshot csi-powerstore.dellemc.com Delete 5m -#. Create the |PVC| snapshot file and apply it. +#. Create the |PVC| snapshot file. .. code-block:: none @@ -70,16 +70,20 @@ Volume Snapshot for the Dell |CSI| provisioner. apiVersion: snapshot.storage.k8s.io/v1 kind: VolumeSnapshot metadata: - name: csi-powerstore-pvc-snapshot - namespace: dell-storage + name: csi-powerstore-pvc-snapshot + namespace: dell-storage spec: - volumeSnapshotClassName: csi-powerstore-snapshot - source: + volumeSnapshotClassName: csi-powerstore-snapshot + source: persistentVolumeClaimName: pvol0 EOF - ~(keystone_admin)$ kubectl apply -f ~/powerstore-volume-snapshot.yaml - volumesnapshot.snapshot.storage.k8s.io/csi-powerstore-pvc-snapshot created +#. Apply the |PVC| snapshot file. + + .. code-block:: none + + ~(keystone_admin)$ kubectl apply -f ~/powerstore-volume-snapshot.yaml + volumesnapshot.snapshot.storage.k8s.io/csi-powerstore-pvc-snapshot created #. Confirm that the |PVC| snapshot file was created successfully.