CSI PowerFlex driver docs update - renameSDC and preapprovedGUID #455

khareRajshree · 2023-02-10T09:43:33Z

Description

Documentation update for CSI PowerFlex driver includes:

Updates for rename SDC feature.
Updates for Pre-approving SDC by GUID feature.

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#402

Checklist:

Have you run a grammar and spell checks against your submission?
Have you tested the changes locally?
Have you tested whether the hyperlinks are working properly?
Did you add the examples wherever applicable?
Have you added high-resolution images?

content/docs/csidriver/features/powerflex.md

rsedlock1958

I have reviewed this. Several edits are required.

khareRajshree · 2023-02-10T12:23:23Z

I have reviewed this. Several edits are required.

Hi @rsedlock1958, I have addressed the review comments.

JacobGros · 2023-02-10T13:45:58Z

please update the values.yaml section in install driver guide as well: https://github.com/dell/csm-docs/blob/main/content/docs/csidriver/installation/helm/powerflex.md#install-the-driver

JacobGros · 2023-02-10T13:48:03Z

content/docs/csidriver/features/powerflex.md

+## Pre-approving SDC by GUID
+
+Starting in version 2.6, the CSI Driver for PowerFlex now supports renaming the SDCs.


This line should say approving sdc by guid, renaming SDC was previous section

Changes done.

JacobGros

Please fix typo and update installation section with the new values

khareRajshree · 2023-02-13T06:16:00Z

Please fix typo and update installation section with the new values
Hi @JacobGros, I have addressed the comments, please re-review it once.

JacobGros

LGTM

rajkumar-palani

please correct the review comments given.

rajkumar-palani · 2023-02-14T12:20:11Z

content/docs/csidriver/features/powerflex.md

+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:`


provide link to the values.yaml file.

rajkumar-palani · 2023-02-14T12:20:30Z

content/docs/csidriver/features/powerflex.md

+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:`


provide link to the values.yaml file.

rajkumar-palani · 2023-02-14T12:21:41Z

content/docs/csidriver/features/powerflex.md

+```
+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.


correct the typo from Is True to If True

rajkumar-palani · 2023-02-14T12:22:58Z

content/docs/csidriver/features/powerflex.md

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


change "the" to "an" appropriate.

khareRajshree · 2023-02-14T12:40:21Z

please correct the review comments given.

Hi @rajkumar-palani, have addressed the review comments.

bharathsreekanth · 2023-02-14T16:43:03Z

content/docs/csidriver/features/powerflex.md

+## 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.


Minor: CSI driver for PowerFlex will support renaming of SDCs.

bharathsreekanth · 2023-02-14T16:44:01Z

content/docs/csidriver/features/powerflex.md

+## Pre-approving SDC by GUID
+
+Starting in version 2.6, the CSI Driver for PowerFlex now supports pre-approving SDC by GUID.


Minor: CSI Driver for PowerFlex will support pre-approving SDC by GUID.

bharathsreekanth · 2023-02-14T16:45:36Z

content/docs/csidriver/features/powerflex.md

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


I would avoid "should", gives the impression that it is best try. I would rephrase as "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"

bharathsreekanth · 2023-02-14T16:46:07Z

content/docs/csidriver/features/powerflex.md

+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.yaml](https://github.com/dell/csi-powerflex/blob/main/helm/csi-vxflexos/values.yaml) file:


Change to : To request SDC approval for GUID, make the following edits...

bharathsreekanth · 2023-02-14T16:47:29Z

content/docs/csidriver/features/powerflex.md

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


would avoid "should" again. If SDC approval is denied, then provisioning of the volume will not be attempted and an appropriate ....

bharathsreekanth · 2023-02-14T18:21:19Z

content/docs/csidriver/features/powerflex.md


-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:


Sorry, minor comment : To enable renaming of SDC, make the following ....

bharathsreekanth · 2023-02-14T18:24:12Z

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.


Starting with version 2.6, the CSI driver for PowerFlex ...

bharathsreekanth · 2023-02-14T18:29:25Z

content/docs/csidriver/features/powerflex.md

+* `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:


You can remove "Now". Based on these two keys, the driver will perform the rename SDC operation as described below:

Can you change it to "Based on these two keys, the driver will perform the rename SDC operation as described below", does it make sense?

rajkumar-palani

lgtm

bharathsreekanth

sorry Rajshree, I was looking at this again and made some comments. They are minor but I thought these will make the docs look crisper. I am approving the PR, but do consider the comments and see if it makes sense.

bharathsreekanth · 2023-02-15T11:46:43Z

content/docs/csidriver/features/powerflex.md

+> NOTE: Currently, the CSI-PowerFlex driver only supports GUID for the restricted SDC mode.
+
+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.


minor comment, you can remove "so the user is informed" as purpose of logs/events is information to user. I will leave it up to you if you want to change it or leave as is.

bharathsreekanth · 2023-02-15T11:49:00Z

content/docs/csidriver/features/powerflex.md

+## Rename SDC
+
+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.


Do we need the last sentence? you are mentioning how to use the feature to rename SDC in the line below? upto you, if you want to change it.

bharathsreekanth · 2023-02-15T11:50:55Z

content/docs/csidriver/features/powerflex.md

+    prefix: "sdc-test"
+```
+The renameSDC section is going to be used by the Node Service, it has two keys enabled and prefix:


Do we need to mention Node Service in the documentation? That is internal to our implementation right?
To enable renameSDC following keys are used.

bharathsreekanth · 2023-02-15T11:52:09Z

content/docs/csidriver/features/powerflex.md

+```
+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. If true then the driver will perform the rename operation. By default, its value will be false.


I would rephrase as "Boolean variable that specified is renaming of SDC is desired". If true, then the driver will perform the rename operation. By default, the value is set to false.

* PowerFlex driver doc updated for renameSDC and preapprovedGUID features

PowerFlex driver doc updated for renameSDC and preapprovedGUID features

51508ce

khareRajshree requested review from Deepak-Ghivari, gallacher, mjsdell, prablr79, rajendraindukuri, rajkumar-palani, rsedlock1958 and shanmydell as code owners February 10, 2023 09:43

rsedlock1958 reviewed Feb 10, 2023

View reviewed changes

content/docs/csidriver/features/powerflex.md Outdated Show resolved Hide resolved

rsedlock1958 reviewed Feb 10, 2023

View reviewed changes

content/docs/csidriver/features/powerflex.md Outdated Show resolved Hide resolved

rsedlock1958 reviewed Feb 10, 2023

View reviewed changes

content/docs/csidriver/features/powerflex.md Outdated Show resolved Hide resolved

rsedlock1958 reviewed Feb 10, 2023

View reviewed changes

review comments addressed

52e4ffc

rsedlock1958 previously approved these changes Feb 10, 2023

View reviewed changes

JacobGros reviewed Feb 10, 2023

View reviewed changes

JacobGros requested changes Feb 10, 2023

View reviewed changes

review comments addressed, helm installation file updated

d4867cc

khareRajshree dismissed rsedlock1958’s stale review via d4867cc February 13, 2023 06:14

khareRajshree added 2 commits February 13, 2023 19:03

powerflex features file updated

e2050ba

fixed the typo

da0d817

JacobGros previously approved these changes Feb 13, 2023

View reviewed changes

khareRajshree requested a review from VamsiSiddu-7 February 13, 2023 13:40

VamsiSiddu-7 previously approved these changes Feb 14, 2023

View reviewed changes

rajkumar-palani requested changes Feb 14, 2023

View reviewed changes

review comments addressed

e73ec43

khareRajshree dismissed VamsiSiddu-7’s stale review via e73ec43 February 14, 2023 12:38

khareRajshree dismissed JacobGros’s stale review via e73ec43 February 14, 2023 12:38

bharathsreekanth requested changes Feb 14, 2023

View reviewed changes

review comments addressed

5dccf3c

bharathsreekanth requested changes Feb 14, 2023

View reviewed changes

review comments addressed

f9c3f6f

bharathsreekanth previously approved these changes Feb 14, 2023

View reviewed changes

review comments addressed

a9fe589

khareRajshree dismissed bharathsreekanth’s stale review via a9fe589 February 14, 2023 18:31

bharathsreekanth approved these changes Feb 14, 2023

View reviewed changes

VamsiSiddu-7 approved these changes Feb 15, 2023

View reviewed changes

rajkumar-palani approved these changes Feb 15, 2023

View reviewed changes

bharathsreekanth approved these changes Feb 15, 2023

View reviewed changes

khareRajshree merged commit dd97eff into release-1.6.0 Feb 16, 2023

rajkumar-palani pushed a commit that referenced this pull request Feb 27, 2023

CSI PowerFlex driver docs update - renameSDC and preapprovedGUID (#455)

8305eb2

* PowerFlex driver doc updated for renameSDC and preapprovedGUID features

ashleyvjoy mentioned this pull request Feb 27, 2023

Added csm auth docs for Preapproved guid feature #470

Merged

5 tasks

rajkumar-palani pushed a commit that referenced this pull request Mar 9, 2023

CSI PowerFlex driver docs update - renameSDC and preapprovedGUID (#455)

6316490

* PowerFlex driver doc updated for renameSDC and preapprovedGUID features

JacobGros mentioned this pull request Mar 28, 2023

[FEATURE]: User friendly name to the PowerFlex dell/csm#181

Closed

shanmydell deleted the pflex-renameSDC-preapprovedGUID branch July 20, 2023 10:42

		## 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 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:`

		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:`

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

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


		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:

		* `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:

CSI PowerFlex driver docs update - renameSDC and preapprovedGUID #455

CSI PowerFlex driver docs update - renameSDC and preapprovedGUID #455

Conversation

khareRajshree commented Feb 10, 2023 • edited Loading

Description

GitHub Issues

Checklist:

rsedlock1958 left a comment

Choose a reason for hiding this comment

khareRajshree commented Feb 10, 2023

JacobGros commented Feb 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JacobGros left a comment

Choose a reason for hiding this comment

khareRajshree commented Feb 13, 2023

JacobGros left a comment

Choose a reason for hiding this comment

rajkumar-palani left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khareRajshree commented Feb 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajkumar-palani left a comment

Choose a reason for hiding this comment

bharathsreekanth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khareRajshree commented Feb 10, 2023 •

edited

Loading