Update tooling with dellctl install powerstore by atye · Pull Request #1698 · dell/csm-docs

atye · 2025-11-14T19:02:33Z

Description

Adds dellctl install to CLI tooling.
Adds the latest csm version from hugo.toml to the table and collapse shortcodes.

GitHub Issues

List the GitHub issues impacted by this PR:

GitHub Issue #

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-11-14T19:03:56Z

Test Results

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

Results for commit 8f5926a. ± Comparison against base commit f6f26ac.

♻️ This comment has been updated with latest results.

content/docs/tooling/cli/_index.md

anandrajak1 · 2025-11-14T19:52:49Z

content/docs/tooling/cli/_index.md

+> | reclaimPolicy      | Delete    |
+> | volumeBindingMode  | Immediate |
+> | csi-volume-prefx   | csivol    |
+> | csi-node-prefix    | csi-node  |


Left Alignment.

anandrajak1 · 2025-11-14T19:55:25Z

content/docs/tooling/cli/_index.md

@@ -83,6 +83,130 @@ Outputs help text

 ---

+### dellctl install powerstore
+
+Installs Dell CSI Powerstore 


This command deploys the CSI PowerStore driver and optional modules in your Kubernetes or OpenShift environment.

anandrajak1 · 2025-11-14T19:55:40Z

content/docs/tooling/cli/_index.md

+
+Installs Dell CSI Powerstore 
+
+##### Flags


Available Flags

anandrajak1 · 2025-11-14T20:04:21Z

content/docs/tooling/cli/_index.md

+
+```bash
+      --certified                                 Optional. If set, the certified sample files pulling from registry.redhat.com are displayed instead of quay.io sample files.
+      --config-version string                     Optional version of Container Storage Modules to install. Defaults to the latest version.


anandrajak1 · 2025-11-14T19:57:37Z

content/docs/tooling/cli/_index.md

+      --certified                                 Optional. If set, the certified sample files pulling from registry.redhat.com are displayed instead of quay.io sample files.
+      --config-version string                     Optional version of Container Storage Modules to install. Defaults to the latest version.
+      --csi-node-prefix string                    Optional param to set the prefix for all CSI nodes provisioned by the driver. Defaults to 'csi-node'.
+      --csi-volume-prefix string                  Optional param to set the prefix for all CSI volumes provisioned by the driver. Defaults to 'csivol'.


No description provided.

anandrajak1 · 2025-11-14T19:57:43Z

content/docs/tooling/cli/_index.md

+      --config-version string                     Optional version of Container Storage Modules to install. Defaults to the latest version.
+      --csi-node-prefix string                    Optional param to set the prefix for all CSI nodes provisioned by the driver. Defaults to 'csi-node'.
+      --csi-volume-prefix string                  Optional param to set the prefix for all CSI volumes provisioned by the driver. Defaults to 'csivol'.
+      --csm-authorization-proxy-hostname string   Optional. If deploying CSM Authorization, this parameter will be used for the Authorization Proxy hostname in the Operator configuration.


Updated for . Can you clarify what you mean by "No description provided."?

anandrajak1 · 2025-11-14T20:01:48Z

content/docs/tooling/cli/_index.md

+  -s, --storage stringArray                       Storage endpoint configuration in the form 'endpoint=<IP|hostname>,username=<user>[,otherKey=otherValue]'. Can be provided multiple times.
+      --tenant-token string                       Path to a YAML file containing Authorization tenant token (proxy-authz-token secret).
+      --validate-connectivity                     Optional. If set, run a DaemonSet on all nodes and verify connectivity to storage systems.
+```


Can you get the tabular format.

Updated. Also moved these flags to the dellctl install command as they will be redundant for each platform.

anandrajak1 · 2025-11-14T20:04:21Z

content/docs/tooling/cli/_index.md

+
+```bash
+      --certified                                 Optional. If set, the certified sample files pulling from registry.redhat.com are displayed instead of quay.io sample files.
+      --config-version string                     Optional version of Container Storage Modules to install. Defaults to the latest version.


anandrajak1 · 2025-11-14T20:05:16Z

content/docs/tooling/cli/_index.md

@@ -11,6 +11,8 @@ This document outlines all dellctl commands, their intended use, options that ca
 | Command | Description |
 | - | - |
 | [dellctl](../cli/#dellctl) | dellctl is used to interact with Container Storage Modules |
+| [dellctl install](../cli/#dellctl-install) | Install a Dell CSI Driver |


anandrajak1 · 2025-11-14T20:05:24Z

content/docs/tooling/cli/_index.md

@@ -11,6 +11,8 @@ This document outlines all dellctl commands, their intended use, options that ca
 | Command | Description |
 | - | - |
 | [dellctl](../cli/#dellctl) | dellctl is used to interact with Container Storage Modules |
+| [dellctl install](../cli/#dellctl-install) | Install a Dell CSI Driver |
+| [dellctl install powerstore](../cli/#dellctl-install-powerstore) | Install Dell CSI Powerstore |


dellctl install powerstore is specific for Powerstore. I think this command should say Powerstore specifically.

Install CSI Powerstore?

This is the description, just remove the Dell. Install Dell CSI Powerstore > Install CSI Powerstore
dont change the command.

shaynafinocchiaro · 2025-11-14T21:14:14Z

content/docs/tooling/cli/_index.md

+dellctl install powerstore --from-file=config.yaml
+```
+
+Sample config.yaml to install pre-requisities and validate connectivity:


Suggestion: Could we have a drop down here; one for a minimal config and the other showing all the options in the config?

Sounds Good

anandrajak1 · 2025-11-14T21:16:23Z

During installation flow, how we are guiding customer to use the alternate method with dellctl installation?

atye · 2025-11-17T13:23:41Z

During installation flow, how we are guiding customer to use the alternate method with dellctl installation?

Updating the installation flow pages will be another PR.

hoppea2 · 2025-11-17T20:45:49Z

content/docs/tooling/cli/_index.md

+##### Examples:
+
+```bash
+dellctl install powerstore --machineconfig --validate-connectivity \


--namespace is required

content/docs/tooling/cli/_index.md

enestvedto-dell · 2025-11-18T14:53:01Z

content/docs/tooling/cli/_index.md

+
+This command deploys the CSI PowerStore driver and optional modules in your Kubernetes or OpenShift environment. 
+
+##### Examples:


question: should we add a small piece about which flags are only allowed to be used through --from-file? Just looking through the sample config.yaml might result in some users not knowing about the existence of some options.

Added this section to dellctl install.

content/docs/tooling/cli/_index.md

enestvedto-dell · 2025-11-18T15:01:08Z

content/docs/tooling/cli/_index.md

+        reclaimPolicy: Delete
+        volumeBindingMode: WaitForFirstConsumer
+        allowVolumeExpansion: true
+        allowedTopologies:


question: is this legal formatting for the topologies? I have been using something like

allowedTopologies: - key: csi-powerstore.dellemc.com/<IP> values: - true

Formatting it correctly for the storge class is handled in generation/creation.

OliverChen557 · 2025-11-18T15:15:38Z

content/docs/tooling/cli/_index.md

+
+>**NOTE:** `--machineconfig` is applicable for both OpenShift and Kubernetes.
+>
+> **DEFAULTS**:


Should we add all defaults here?

Setting Value

nfs-acls 0777

skip-certificate-validation false

config-version latest version of CSM

There are also more default values in the storage class configurations, but it might be too much here if we only want CLI/from-file specific defaults here.

Added more defaults.

OliverChen557 · 2025-11-18T15:21:51Z

content/docs/tooling/cli/_index.md

+| csm-authorization-proxy-hostname <string> | If deploying CSM Authorization, the hostname of the Authorization Proxy Server.  | No |
+| force                                     | The existing Container Storage Module resources are deleted and then recreated.  | No |
+| from-file <string>                        | Path to a YAML file containing configuration details for installing the CSM.  | No |
+| machineconfig                             | Configure pre-requisities based on the provided block-protocol parameter.  | No |


Might be nice to mention what prerequisites are being installed here. There isn't much clarity on what this flag is doing. I think part of the reason is it's used for both K8s and OCP, but for now, maybe link one of the prerequisites pages:

K8s: https://dell.github.io/csm-docs/docs/getting-started/installation/kubernetes/powerstore/prerequisite/

OCP: https://dell.github.io/csm-docs/docs/getting-started/installation/openshift/powerstore/csmoperator/

Updated the description with a link to the installation page for the user to navigate to the relevant orchestrator and platform.

We only support Powerstore right now but that will change and I thought it was ok.

anandrajak1 · 2025-11-18T19:40:09Z

content/docs/tooling/cli/_index.md

+```bash
+dellctl install powerstore --from-file=config.yaml
+```
+


Config file examples

The examples are in the dropdowns just below this.

anandrajak1 · 2025-11-18T19:40:12Z

content/docs/tooling/cli/_index.md

+dellctl install powerstore --from-file=config.yaml
+```
+
+{{< collapse id="1" title="Sample config.yaml to install pre-requisities and validate connectivity" card="false" >}}


Check prerequisites and connectivity

It doesn't check, it installs. There is a separate option to check connectivity.

anandrajak1 · 2025-11-18T19:41:08Z

content/docs/tooling/cli/_index.md

+```
+{{< /collapse >}}
+
+{{< collapse id="2" title="Sample config.yaml to to output yaml" card="false" >}}


Specify output format to yaml.

anandrajak1 · 2025-11-18T19:41:16Z

content/docs/tooling/cli/_index.md

+```
+{{< /collapse >}}
+
+{{< collapse id="3" title="Sample config.yaml with all configuration options" card="false" >}}


Full config

anandrajak1 · 2025-11-18T19:50:59Z

content/docs/tooling/cli/_index.md

+
+##### Output
+
+Outputs help text


Outputs help text ?

This phrase is used elsewhere for other commands so I followed that pattern. For dellctl install, it will only output help text which isn't shown here as it's long.

anandrajak1 · 2025-11-18T19:52:10Z

content/docs/tooling/cli/_index.md

+
+> **NOTE:** `--machineconfig` is applicable for both OpenShift and Kubernetes.
+>
+> **DEFAULTS**:


Can this added to existing table? and have one more column as default value?

anandrajak1 · 2025-11-18T19:53:33Z

content/docs/tooling/cli/_index.md

+> - skip-certificate-validation
+> - storage-class
+> - metro-replication
+> - primary


primary? - some explanation about it? no examples on primary or secondary.

content/docs/tooling/cli/_index.md

atye requested review from AronAtDell, Prabhu-Dell, adarsh-dell, alikdell, anandrajak1, mjsdell, prablr79, rsedlock1958 and sharmilarama as code owners November 14, 2025 19:02

santhoshatdell reviewed Nov 14, 2025

View reviewed changes

content/docs/tooling/cli/_index.md Show resolved Hide resolved

content/docs/tooling/cli/_index.md Outdated Show resolved Hide resolved

anandrajak1 requested changes Nov 14, 2025

View reviewed changes

anandrajak1 reviewed Nov 14, 2025

View reviewed changes

shaynafinocchiaro reviewed Nov 14, 2025

View reviewed changes

atye force-pushed the usr/tyea/dellctl-install branch from ecb7de7 to 6664022 Compare November 17, 2025 16:43

atye requested review from anandrajak1, santhoshatdell and shaynafinocchiaro November 17, 2025 16:50

hoppea2 reviewed Nov 17, 2025

View reviewed changes

atye requested a review from hoppea2 November 17, 2025 21:17

OliverChen557 reviewed Nov 18, 2025

View reviewed changes

content/docs/tooling/cli/_index.md Outdated Show resolved Hide resolved

enestvedto-dell reviewed Nov 18, 2025

View reviewed changes

OliverChen557 reviewed Nov 18, 2025

View reviewed changes

anandrajak1 reviewed Nov 18, 2025

View reviewed changes

atye added 8 commits November 21, 2025 16:41

fix comma

350eb83

remove from-file param

aee15b8

fix platform

a4c16e4

add timeout

9508ac0

remove none,auto

5afcb78

fix typo

1cef77d

fix desc

44334e0

feedback

5f54093

atye force-pushed the usr/tyea/dellctl-install branch from 5e0ec53 to 5f54093 Compare November 21, 2025 21:41

santhoshatdell reviewed Nov 21, 2025

View reviewed changes

content/docs/tooling/cli/_index.md Outdated Show resolved Hide resolved

santhoshatdell reviewed Nov 21, 2025

View reviewed changes

content/docs/tooling/cli/_index.md Outdated Show resolved Hide resolved

santhoshatdell previously approved these changes Nov 21, 2025

View reviewed changes

feedback

4e7c8cc

atye dismissed santhoshatdell’s stale review via 4e7c8cc November 21, 2025 22:06

feedback

8de7287

santhoshatdell previously approved these changes Nov 21, 2025

View reviewed changes

update auth flags

349703e

atye dismissed santhoshatdell’s stale review via 349703e November 24, 2025 20:48

Update metro section

ad360b1

santhoshatdell reviewed Nov 25, 2025

View reviewed changes

content/docs/tooling/cli/_index.md Show resolved Hide resolved

atye and others added 5 commits November 26, 2025 15:04

update for storag e ca

4375e92

add cert flags to storage

1fadd90

fix typo

4eb032a

Merge branch 'main' into usr/tyea/dellctl-install

260c8cf

Fix authproxy input name. yaml output to a file instead of console

8f5926a

santhoshatdell approved these changes Dec 5, 2025

View reviewed changes

alikdell approved these changes Dec 5, 2025

View reviewed changes

alikdell merged commit 1f88049 into main Dec 5, 2025
8 checks passed

alikdell deleted the usr/tyea/dellctl-install branch December 5, 2025 18:25


		This command deploys the CSI PowerStore driver and optional modules in your Kubernetes or OpenShift environment.

		##### Examples:

Setting	Value
nfs-acls	0777
skip-certificate-validation	false
config-version	latest version of CSM

Conversation

atye commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

GitHub Issues

Checklist:

Uh oh!

github-actions bot commented Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anandrajak1 Nov 14, 2025 • edited by lukeatdell Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atye Nov 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anandrajak1 commented Nov 14, 2025

Uh oh!

atye commented Nov 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

atye commented Nov 14, 2025 •

edited

Loading

github-actions bot commented Nov 14, 2025 •

edited

Loading

anandrajak1 Nov 14, 2025 •

edited by lukeatdell

Loading

atye Nov 17, 2025 •

edited

Loading

anandrajak1 Nov 18, 2025 •

edited

Loading