Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional sdc documentation #1274

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions content/docs/csidriver/features/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,18 @@ The CSI PowerFlex driver version 1.3 and later support the automatic deployment
Refer to https://hub.docker.com/r/dellemc/sdc for supported OS versions.
- There is no automated uninstallation of the SDC kernel module. Follow PowerFlex SDC documentation to manually uninstall the SDC driver from the node.

From CSM 1.12.0, you can disable automatic SDC deployment.

By default, SDC deployment is enabled. If you do not want to deploy `sdc` with PowerFlex, it can be disabled by setting the `sdc.enabled` field to `false`.

```
node:
...
sdc:
# enabled: Enable/Disable SDC
enabled: true
```
## Multiarray Support
The CSI PowerFlex driver version 1.4 added support for managing multiple PowerFlex arrays from the single driver instance. This feature is enabled by default and integrated to even single instance installations.
Expand Down Expand Up @@ -925,6 +937,38 @@ externalAccess: "10.0.0.0/24"

This means that we allow for NFS Export created by driver to be consumed by address range `10.0.0.0-10.0.0.255`.

## Configuring NFS independent of SDC

Starting from CSM 1.12.0, the CSI PowerFlex driver supports configuring NFS independent of SDC. This separation is helpful in scenarios where an SDC is not available in the cluster or additional network interfaces do not need to be deployed.

To disable SDC deployment, update the values file and provide the interface names mapping for each of the nodes that are being used.
falfaroc marked this conversation as resolved.
Show resolved Hide resolved

**Helm**
```
node:
...
sdc:
# enabled: Enable/Disable SDC
enabled: false
...

interfaceNames:
# worker-1-jxsjoueeewabc.domain: "ens192"
# worker-2-jxsjoueeewabc.domain: "ens192"
```
**Operator**
```
common:
...
- name: INTERFACE_NAMES: 'worker-1-jxsjoueeewabc.domain: "ens192", worker-2-jxsjoueeewabc.domain: "ens192"'
...
node:
...
- name: X_CSI_SDC_ENABLED
value: "false"
```
## Storage Capacity Tracking
CSI-PowerFlex driver version 2.8.0 and above supports Storage Capacity Tracking.
Expand Down
2 changes: 2 additions & 0 deletions content/docs/deployment/csmoperator/drivers/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,15 @@ For detailed PowerFlex installation procedure, see the [Dell PowerFlex Deploymen
| X_CSI_VXFLEXOS_ENABLESNAPSHOTCGDELETE | Enable this to automatically delete all snapshots in a consistency group when a snap in the group is deleted | No | false |
| 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 |
| ***Controller parameters*** |
| X_CSI_POWERFLEX_EXTERNAL_ACCESS | allows specifying additional entries for hostAccess of NFS volumes. Both single IP address and subnet are valid entries | No | empty |
| X_CSI_HEALTH_MONITOR_ENABLED | Enable/Disable health monitor of CSI volumes from Controller plugin - volume condition | No | false |
| ***Node parameters*** |
| X_CSI_RENAME_SDC_ENABLED | Enable this to rename the SDC with the given prefix. The new name will be ("prefix" + "worker_node_hostname") and it should not exceed 31 chars. | Yes | false |
| X_CSI_APPROVE_SDC_ENABLED | Enable this to to approve restricted SDC by GUID during setup | Yes | false |
| X_CSI_HEALTH_MONITOR_ENABLED | Enable/Disable health monitor of CSI volumes from Node plugin - volume condition | No | false |
| X_CSI_SDC_ENABLED | Enable/Disable installation of the SDC. | Yes | true |

4. Execute this command to create PowerFlex custom resource:
```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ Use the below command to replace or update the secret:
| enabled | A boolean that enables/disables authorization feature. | No | false |
| proxyHost | Hostname of the csm-authorization server. | No | Empty |
| skipCertificateValidation | A boolean that enables/disables certificate validation of the csm-authorization proxy server. | No | true |
| **interfaceNames** | A mapping of node names to interface names. Only necessary when SDC is disabled (see above). | No | "" |
falfaroc marked this conversation as resolved.
Show resolved Hide resolved


10. Install the driver using `csi-install.sh` bash script by running `cd dell-csi-helm-installer && ./csi-install.sh --namespace vxflexos --values myvalues.yaml --helm-charts-version <version>`. You may modify the release name with the `--release` arg. If arg is not provided, release will be named `vxflexos` by default.
Expand Down
Loading