From 51508cee8d58a5966a6891de9db80b45ca6a52f0 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Fri, 10 Feb 2023 15:02:56 +0530 Subject: [PATCH 1/9] PowerFlex driver doc updated for renameSDC and preapprovedGUID features --- content/docs/csidriver/features/powerflex.md | 61 +++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index ec1b8ec749..16d0cf97eb 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -661,4 +661,63 @@ allowedTopologies: values: - csi-vxflexos.dellemc.com ``` -Once the volume gets created, the ControllerPublishVolume will set the QoS limits for the volumes mapped to SDC. \ No newline at end of file +Once the volume gets created, the ControllerPublishVolume will set the QoS limits for the volumes mapped to SDC. + +## Rename SDC + +Starting in version 2.6, CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. + +```yaml +# "node" allows to configure node specific parameters +node: + ... + ... + + # "renameSDC" defines the rename operation for SDC + # Default value: None + renameSDC: + # enabled: Enable/Disable rename of SDC + # Allowed values: + # true: enable renaming + # false: disable renaming + # Default value: "false" + enabled: false + # "prefix" defines a string for the new name of the SDC. + # "prefix" + "worker_node_hostname" should not exceed 31 chars. + # Default value: none + # Examples: "rhel-sdc", "sdc-test" + prefix: "sdc-test" +``` +The renameSDC section is going to be used by the Node Service, it has two keys enabled and prefix, +* `enabled`: Boolean variable that specifies if the renaming for SDC is to be carried out or not. Is true then the driver will perform the rename operation. By default, its value will be false. +* `prefix`: string variable that is used to set the prefix for SDC name. + +Now based on these two keys, there are certain scenarios on which the driver is going to perform the rename SDC operation: +* If enabled and prefix given then set the prefix+worker_node_name for SDC name. +* If enabled and prefix not given then set worker_node_name for SDC name. + +> NOTE: name of the SDC cannot be more than 31 characters, hence the prefix given and the worker node hostname name taken should be such that the total length do not exceed 31 character limit. + +## Pre-approving SDC by GUID + +Starting in version 2.6, CSI Driver for PowerFlex now supports renaming the SDCs. +CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. + +```yaml +# "node" allows to configure node specific parameters +node: + ... + ... + + # "approveSDC" defines the approve operation for SDC + # Default value: None + approveSDC: + # enabled: Enable/Disable SDC approval + #Allowed values: + # true: Driver will attempt to approve restricted SDC by GUID during setup + # false: Driver will not attempt to approve restricted SDC by GUID during setup + # Default value: false + enabled: false +``` + +If SDC approval is denied, then provisioning of the volume should not be attempted and the appropriate error message is reported in the logs/events so the user is informed. From 52e4ffc4683c03519bba8dcd275714e86eba54b2 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Fri, 10 Feb 2023 17:51:43 +0530 Subject: [PATCH 2/9] review comments addressed --- content/docs/csidriver/features/powerflex.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 16d0cf97eb..cfc8093efd 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -665,7 +665,7 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit ## Rename SDC -Starting in version 2.6, CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. +Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. ```yaml # "node" allows to configure node specific parameters @@ -688,7 +688,7 @@ node: # Examples: "rhel-sdc", "sdc-test" prefix: "sdc-test" ``` -The renameSDC section is going to be used by the Node Service, it has two keys enabled and prefix, +The renameSDC section is going to be used by the Node Service, it has two keys enabled and prefix: * `enabled`: Boolean variable that specifies if the renaming for SDC is to be carried out or not. Is true then the driver will perform the rename operation. By default, its value will be false. * `prefix`: string variable that is used to set the prefix for SDC name. @@ -696,11 +696,11 @@ Now based on these two keys, there are certain scenarios on which the driver is * If enabled and prefix given then set the prefix+worker_node_name for SDC name. * If enabled and prefix not given then set worker_node_name for SDC name. -> NOTE: name of the SDC cannot be more than 31 characters, hence the prefix given and the worker node hostname name taken should be such that the total length do not exceed 31 character limit. +> NOTE: name of the SDC cannot be more than 31 characters, hence the prefix given and the worker node hostname name taken should be such that the total length does not exceed 31 character limit. ## Pre-approving SDC by GUID -Starting in version 2.6, CSI Driver for PowerFlex now supports renaming the SDCs. +Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming the SDCs. CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. ```yaml From d4867cc48227b3dafeb7f75b1297c3aa0799d49a Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Mon, 13 Feb 2023 11:43:52 +0530 Subject: [PATCH 3/9] review comments addressed, helm installation file updated --- content/docs/csidriver/features/powerflex.md | 2 +- content/docs/csidriver/installation/helm/powerflex.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index cfc8093efd..b32d9c9eb5 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -700,7 +700,7 @@ Now based on these two keys, there are certain scenarios on which the driver is ## Pre-approving SDC by GUID -Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming the SDCs. +Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID. CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. ```yaml diff --git a/content/docs/csidriver/installation/helm/powerflex.md b/content/docs/csidriver/installation/helm/powerflex.md index 7d219de6b2..94c06d5fe8 100644 --- a/content/docs/csidriver/installation/helm/powerflex.md +++ b/content/docs/csidriver/installation/helm/powerflex.md @@ -203,6 +203,10 @@ Use the below command to replace or update the secret: | healthMonitor.enabled | Enable/Disable health monitor of CSI volumes- volume usage, volume condition | No | false | | nodeSelector | Defines what nodes would be selected for pods of node daemonset. Leave as blank to use all nodes. | Yes | " " | | tolerations | Defines tolerations that would be applied to node daemonset. Leave as blank to install node driver only on worker nodes. | Yes | " " | +| **renameSDC** | This section allows the rename operation for SDC. | - | - | +| enabled | A boolean that enable/disable rename SDC feature. | No | false | +| prefix | Defines a string for the prefix of the SDC. | No | " " | +| approveSDC.enabled | A boolean that enable/disable SDC approval feature. | No | false | | **monitor** | This section allows the configuration of the SDC monitoring pod. | - | - | | enabled | Set to enable the usage of the monitoring pod. | Yes | false | | hostNetwork | Set whether the monitor pod should run on the host network or not. | Yes | true | From e2050ba637d90a6393c2a8606bd9360ec8d84f5b Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Mon, 13 Feb 2023 19:03:25 +0530 Subject: [PATCH 4/9] powerflex features file updated --- content/docs/csidriver/features/powerflex.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index b32d9c9eb5..5e311a8ef8 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -667,6 +667,7 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. +If you want to rename the SDC, please make the following edits to your values file at `yaml csi-vxflexos/helm/csi-vxflexos/values.yaml:` ```yaml # "node" allows to configure node specific parameters node: @@ -703,6 +704,7 @@ Now based on these two keys, there are certain scenarios on which the driver is Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID. CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. +If you want to get the SDC pre-approved by GUID, please make the following edits to your values file at `yaml csi-vxflexos/helm/csi-vxflexos/values.yaml:` ```yaml # "node" allows to configure node specific parameters node: @@ -719,5 +721,6 @@ node: # Default value: false enabled: false ``` +> NOTE: Currently, the CSI-PowerFlex driver only supports GUID for the restricted SDC mode. If SDC approval is denied, then provisioning of the volume should not be attempted and the appropriate error message is reported in the logs/events so the user is informed. From da0d817325a2515d0ec7c048fd7eae0588b2cde7 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Mon, 13 Feb 2023 19:06:22 +0530 Subject: [PATCH 5/9] fixed the typo --- content/docs/csidriver/features/powerflex.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 5e311a8ef8..65a8b20466 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -667,7 +667,7 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. -If you want to rename the SDC, please make the following edits to your values file at `yaml csi-vxflexos/helm/csi-vxflexos/values.yaml:` +If you want to rename the SDC, please make the following edits to your values file at `csi-vxflexos/helm/csi-vxflexos/values.yaml:` ```yaml # "node" allows to configure node specific parameters node: @@ -704,7 +704,7 @@ Now based on these two keys, there are certain scenarios on which the driver is Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID. CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. -If you want to get the SDC pre-approved by GUID, please make the following edits to your values file at `yaml csi-vxflexos/helm/csi-vxflexos/values.yaml:` +If you want to get the SDC pre-approved by GUID, please make the following edits to your values file at `csi-vxflexos/helm/csi-vxflexos/values.yaml:` ```yaml # "node" allows to configure node specific parameters node: From e73ec435ff7490b3719251384b798ee1da301c78 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Tue, 14 Feb 2023 18:07:46 +0530 Subject: [PATCH 6/9] review comments addressed --- content/docs/csidriver/features/powerflex.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 65a8b20466..c252f50298 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -667,7 +667,7 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. -If you want to rename the SDC, please make the following edits to your values file at `csi-vxflexos/helm/csi-vxflexos/values.yaml:` +If you want to rename the SDC, please make the following edits to your [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: ```yaml # "node" allows to configure node specific parameters node: @@ -690,7 +690,7 @@ node: prefix: "sdc-test" ``` The renameSDC section is going to be used by the Node Service, it has two keys enabled and prefix: -* `enabled`: Boolean variable that specifies if the renaming for SDC is to be carried out or not. Is true then the driver will perform the rename operation. By default, its value will be false. +* `enabled`: Boolean variable that specifies if the renaming for SDC is to be carried out or not. If true then the driver will perform the rename operation. By default, its value will be false. * `prefix`: string variable that is used to set the prefix for SDC name. Now based on these two keys, there are certain scenarios on which the driver is going to perform the rename SDC operation: @@ -704,7 +704,7 @@ Now based on these two keys, there are certain scenarios on which the driver is Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID. CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. -If you want to get the SDC pre-approved by GUID, please make the following edits to your values file at `csi-vxflexos/helm/csi-vxflexos/values.yaml:` +If you want to get the SDC pre-approved by GUID, please make the following edits to your [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: ```yaml # "node" allows to configure node specific parameters node: @@ -723,4 +723,4 @@ node: ``` > NOTE: Currently, the CSI-PowerFlex driver only supports GUID for the restricted SDC mode. -If SDC approval is denied, then provisioning of the volume should not be attempted and the appropriate error message is reported in the logs/events so the user is informed. +If SDC approval is denied, then provisioning of the volume should not be attempted and an appropriate error message is reported in the logs/events so the user is informed. From 5dccf3c4c87788ac87dda8e7390bd1232424a874 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Tue, 14 Feb 2023 23:47:37 +0530 Subject: [PATCH 7/9] review comments addressed --- content/docs/csidriver/features/powerflex.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index c252f50298..185e088eee 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -665,9 +665,9 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit ## Rename SDC -Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming of SDC. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. +Starting in version 2.6, the CSI driver for PowerFlex will support renaming of SDCs. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. -If you want to rename the SDC, please make the following edits to your [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: +To request renaming of SDC, make the following edits to [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: ```yaml # "node" allows to configure node specific parameters node: @@ -701,10 +701,10 @@ Now based on these two keys, there are certain scenarios on which the driver is ## Pre-approving SDC by GUID -Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID. -CSI PowerFlex driver should be able to detect/read the SDC mode from the PowerFlex array and determine whether requests for SDC approval be made to the array prior to publishing a volume. This is specific to each SDC. +Starting in version 2.6, the CSI Driver for PowerFlex will support pre-approving SDC by GUID. +CSI PowerFlex driver will detect the SDC mode set on the PowerFlex array and will request SDC approval from the array prior to publishing a volume. This is specific to each SDC. -If you want to get the SDC pre-approved by GUID, please make the following edits to your [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: +To request SDC approval for GUID, make the following edits to [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: ```yaml # "node" allows to configure node specific parameters node: @@ -723,4 +723,4 @@ node: ``` > NOTE: Currently, the CSI-PowerFlex driver only supports GUID for the restricted SDC mode. -If SDC approval is denied, then provisioning of the volume should not be attempted and an appropriate error message is reported in the logs/events so the user is informed. +If SDC approval is denied, then provisioning of the volume will not be attempted and an appropriate error message is reported in the logs/events so the user is informed. From f9c3f6fc28aca6aac603addfb67404b9004fbc1c Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Tue, 14 Feb 2023 23:57:29 +0530 Subject: [PATCH 8/9] review comments addressed --- content/docs/csidriver/features/powerflex.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 185e088eee..87b1f3e51e 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -665,9 +665,9 @@ Once the volume gets created, the ControllerPublishVolume will set the QoS limit ## Rename SDC -Starting in version 2.6, the CSI driver for PowerFlex will support renaming of SDCs. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. +Starting with version 2.6, the CSI driver for PowerFlex will support renaming of SDCs. To use this feature, the node section of values.yaml should have renameSDC keys enabled with a prefix value. -To request renaming of SDC, make the following edits to [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: +To enable renaming of SDC, make the following edits to [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: ```yaml # "node" allows to configure node specific parameters node: @@ -701,7 +701,7 @@ Now based on these two keys, there are certain scenarios on which the driver is ## Pre-approving SDC by GUID -Starting in version 2.6, the CSI Driver for PowerFlex will support pre-approving SDC by GUID. +Starting with version 2.6, the CSI Driver for PowerFlex will support pre-approving SDC by GUID. CSI PowerFlex driver will detect the SDC mode set on the PowerFlex array and will request SDC approval from the array prior to publishing a volume. This is specific to each SDC. To request SDC approval for GUID, make the following edits to [values.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file: From a9fe5892704d188bd00fbef9d18dfd84f39d3710 Mon Sep 17 00:00:00 2001 From: Rajshree Khare Date: Wed, 15 Feb 2023 00:01:20 +0530 Subject: [PATCH 9/9] review comments addressed --- content/docs/csidriver/features/powerflex.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/csidriver/features/powerflex.md b/content/docs/csidriver/features/powerflex.md index 87b1f3e51e..d2b2663551 100644 --- a/content/docs/csidriver/features/powerflex.md +++ b/content/docs/csidriver/features/powerflex.md @@ -693,7 +693,7 @@ The renameSDC section is going to be used by the Node Service, it has two keys e * `enabled`: Boolean variable that specifies if the renaming for SDC is to be carried out or not. If true then the driver will perform the rename operation. By default, its value will be false. * `prefix`: string variable that is used to set the prefix for SDC name. -Now based on these two keys, there are certain scenarios on which the driver is going to perform the rename SDC operation: +Based on these two keys, there are certain scenarios on which the driver is going to perform the rename SDC operation: * If enabled and prefix given then set the prefix+worker_node_name for SDC name. * If enabled and prefix not given then set worker_node_name for SDC name.