CSM Operator Installation - Added CR fields for PowerMax and PowerFlex #1458

ChristianAtDell · 2025-02-27T17:33:28Z

Description

This PR adds documentation to support the changes made in dell/csm-operator#905 .

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #
dell/csm#1762

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?

github-actions · 2025-02-27T17:36:21Z

Test Results

77 tests ±0 77 ✅ ±0 3s ⏱️ ±0s
3 suites ±0 0 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 11202fc. ± Comparison against base commit 78c299a.

♻️ This comment has been updated with latest results.

content/docs/getting-started/installation/kubernetes/powermax/csmoperator/_index.md

rsedlock1958

No edits required

atye · 2025-02-27T17:53:04Z

content/docs/getting-started/installation/kubernetes/powerflex/csmoperator/_index.md

@@ -157,6 +157,7 @@ run `/opt/emc/scaleio/sdc/bin/drv_cfg --add_mdm --ip 10.xx.xx.xx.xx,10.xx.xx.xx`
   | X_CSI_DEBUG | To enable debug mode | No | true |
   | 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 |
+   | CSI_LOG_LEVEL | Controls the log level for messages printed to the driver logs. Allowable values per logrus are [INFO, DEBUG, TRACE, WARN, ERROR, FATAL, and PANIC](https://github.com/sirupsen/logrus/blob/master/logrus.go#L25). | No | INFO |


What's the likelihood of https://github.com/sirupsen/logrus/blob/master/logrus.go#L25 becoming a dead or incorrect link in the future?

Maybe it's simpler to not mention logrus at all; just allowable values.

Virtually nil. https://github.com/sirupsen/logrus/commits/master/logrus.go It has not been updated in 6 years.

I thought about that, too; in a few places that we have CSI_LOG_LEVEL elsewhere we only mention INFO and DEBUG as allowable values, and I'm pretty confident that's not true because it all goes to logrus which accepts the wider selection. I will adjust it if someone has a strong opinion to only include the allowable values, and even trim it down to the two values we mention elsewhere (even if that is not technically correct).

Let's be consistent in our messaging across all the references to CSI_LOG_LEVEL.

content/docs/getting-started/installation/kubernetes/powerflex/csmoperator/_index.md

AronAtDell · 2025-02-28T14:58:15Z

content/docs/getting-started/installation/kubernetes/powermax/csmoperator/_index.md

@@ -160,6 +160,7 @@ Example:
   | X_CSI_VSPHERE_PORTGROUP                         | Existing portGroup that driver will use for vSphere                                                                                                                                                                                                                      | Yes      | ""                             |
   | X_CSI_VSPHERE_HOSTNAME                          | Existing host(initiator group)/host group(cascaded initiator group) that driver will use for vSphere                                                                                                                                                                     | Yes      | ""                             |
   | X_CSI_VCenter_HOST                              | URL/endpoint of the vCenter where all the ESX are present                                                                                                                                                                                                                | Yes      | ""                             |
+   | X_CSI_POWERMAX_DEBUG                              | Enable/Disable gopowermax library-level debugging.                                                                                                                           | No      | false                             |


Do we need to have this also added for other binding layers?

Discussed this comment with Aron:

gopowermax is the one being added with this PR, so we should be covered.

gopowerscale has:
https://github.com/dell/gopowerscale/blob/ef35bfd90f23593d67077d191328562ec17fc696/api/api.go#L58
but that isn't supported in operator at present.

goscaleio has the http flags, but like gopowerscale, they aren't currently supported in operator.

gopowerstore has:
https://github.com/dell/gopowerstore/blob/171b9c405d0d17e5cdaa2734c80f1637a4c01b5c/api/api.go#L138
and that is supported in operator: https://github.com/dell/csm-operator/blob/04fd860891c3f1ec640d24fbeaa273c18963aa95[…]/operatorconfig/driverconfig/powerstore/v2.13.0/controller.yaml

We don't currently expose that value in our Operator sample, nor do we call it out in csm-docs, but it is possible to add it like I did for the two flags already mentioned in this docs PR. Fairly trivial change in both repos, just add it to the docs tables and add a value to the samples in operator.

...

Per feedback, I am converting this PR to draft and working with my team to increase the scope of this defect and add granular control of library debug flags to other libraries.

alexemc · 2025-02-28T20:26:48Z

content/docs/getting-started/installation/kubernetes/powerscale/csmoperator/_index.md

@@ -28,7 +28,7 @@ To deploy the Operator, follow the instructions available [here](../../../operat

 2. **Create `secret` file:**.

-   a. Create a file called `secret.yaml` or pick a [sample](https://github.com/dell/csi-powerscale/blob/main/samples/secret/secret.yaml) that has Powerscale array connection details: 
+   a. Create a file called `secret.yaml` or pick a [sample](https://github.com/dell/csi-powerscale/blob/main/samples/secret/secret.yaml) that has Powerscale array connection details:


It should probably be "PowerScale", not "Powerscale".

alexemc · 2025-02-28T20:34:05Z

content/docs/getting-started/installation/kubernetes/powerflex/csmoperator/_index.md

+   | GOSCALEIO_DEBUG | Enable/Disable goscaleio library-level debugging. | No | false |
+   | GOSCALEIO_SHOWHTTP | Enable/Disable goscaleio library-level REST request logging. Enabling will also **enable** GOSCALEIO_DEBUG regardless of GOSCALEIO_DEBUG setting. | No | false |


For gocsi you use "library level" and here you use "library-level". These descriptions should be consistent.

alexemc · 2025-02-28T20:37:01Z

content/docs/getting-started/installation/kubernetes/powermax/csmoperator/_index.md

@@ -160,6 +160,8 @@ Example:
   | X_CSI_VSPHERE_PORTGROUP                         | Existing portGroup that driver will use for vSphere                                                                                                                                                                                                                      | Yes      | ""                             |
   | X_CSI_VSPHERE_HOSTNAME                          | Existing host(initiator group)/host group(cascaded initiator group) that driver will use for vSphere                                                                                                                                                                     | Yes      | ""                             |
   | X_CSI_VCenter_HOST                              | URL/endpoint of the vCenter where all the ESX are present                                                                                                                                                                                                                | Yes      | ""                             |
+   | X_CSI_DEBUG | Enable/disable gocsi library level debugging. | No | false |


Inconsistency with "library-level" in other places.

ChristianAtDell and others added 3 commits February 27, 2025 12:20

added fields to appropriate files

2602e30

grammar correction

37e3db1

Merge branch 'main' into ccoff/expand-cr-fields

2d22985

ChristianAtDell marked this pull request as ready for review February 27, 2025 17:34

ChristianAtDell requested review from gallacher, mjsdell, prablr79, rajkumar-palani, AronAtDell, sharmilarama and rsedlock1958 as code owners February 27, 2025 17:34

alikdell previously approved these changes Feb 27, 2025

View reviewed changes

ChristianAtDell changed the title ~~added fields to appropriate files~~ CSM Operator Installation - Added CR fields for PowerMax and PowerFlex Feb 27, 2025

santhoshatdell reviewed Feb 27, 2025

View reviewed changes

content/docs/getting-started/installation/kubernetes/powermax/csmoperator/_index.md Outdated Show resolved Hide resolved

changed powerscale to powermax

dd30274

ChristianAtDell dismissed alikdell’s stale review via dd30274 February 27, 2025 17:47

rsedlock1958 reviewed Feb 27, 2025

View reviewed changes

atye reviewed Feb 27, 2025

View reviewed changes

santhoshatdell previously approved these changes Feb 28, 2025

View reviewed changes

gallacher reviewed Feb 28, 2025

View reviewed changes

content/docs/getting-started/installation/kubernetes/powerflex/csmoperator/_index.md Outdated Show resolved Hide resolved

AronAtDell reviewed Feb 28, 2025

View reviewed changes

changed verbage on CSI_LOG_LEVEL for consistency

60bd7b3

ChristianAtDell dismissed santhoshatdell’s stale review via 60bd7b3 February 28, 2025 17:08

ChristianAtDell marked this pull request as draft February 28, 2025 17:09

ChristianAtDell added 2 commits February 28, 2025 13:33

added table entries for more library flags

126e33d

more flags

11202fc

alexemc reviewed Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CSM Operator Installation - Added CR fields for PowerMax and PowerFlex #1458

CSM Operator Installation - Added CR fields for PowerMax and PowerFlex #1458

ChristianAtDell commented Feb 27, 2025

github-actions bot commented Feb 27, 2025 •

edited

Loading

rsedlock1958 left a comment

atye Feb 27, 2025 •

edited

Loading

ChristianAtDell Feb 27, 2025

sharmilarama Feb 28, 2025

AronAtDell Feb 28, 2025

ChristianAtDell Feb 28, 2025

alexemc Feb 28, 2025

alexemc Feb 28, 2025

alexemc Feb 28, 2025

		\| GOSCALEIO_DEBUG \| Enable/Disable goscaleio library-level debugging. \| No \| false \|
		\| GOSCALEIO_SHOWHTTP \| Enable/Disable goscaleio library-level REST request logging. Enabling will also enable GOSCALEIO_DEBUG regardless of GOSCALEIO_DEBUG setting. \| No \| false \|

CSM Operator Installation - Added CR fields for PowerMax and PowerFlex #1458

Are you sure you want to change the base?

CSM Operator Installation - Added CR fields for PowerMax and PowerFlex #1458

Conversation

ChristianAtDell commented Feb 27, 2025

Description

GitHub Issues

Checklist:

github-actions bot commented Feb 27, 2025 • edited Loading

Test Results

rsedlock1958 left a comment

Choose a reason for hiding this comment

atye Feb 27, 2025 • edited Loading

Choose a reason for hiding this comment

ChristianAtDell Feb 27, 2025

Choose a reason for hiding this comment

sharmilarama Feb 28, 2025

Choose a reason for hiding this comment

AronAtDell Feb 28, 2025

Choose a reason for hiding this comment

ChristianAtDell Feb 28, 2025

Choose a reason for hiding this comment

alexemc Feb 28, 2025

Choose a reason for hiding this comment

alexemc Feb 28, 2025

Choose a reason for hiding this comment

alexemc Feb 28, 2025

Choose a reason for hiding this comment

github-actions bot commented Feb 27, 2025 •

edited

Loading

atye Feb 27, 2025 •

edited

Loading