Skip to content

Commit

Permalink
Operator Minimal CR feature: Documentation (#1273)
Browse files Browse the repository at this point in the history
* minimal CR documentation for drivers

* add modules doc for minimal CR

* update spacing and font size

* add doc changes

* modify documentation

* modify unity md file

* revert last commit to unity md file
  • Loading branch information
ashleyvjoy authored and coulof committed Oct 21, 2024
1 parent 3aa14d0 commit 1f066f2
Show file tree
Hide file tree
Showing 12 changed files with 64 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,9 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
value: "true"
```

Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerFlex driver following the appropriate documenation for your installation method.

7. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ Create the karavi-authorization-config secret using this command:
value: "true"
```

Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

5. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.

6. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
value: "true"
```

Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerScale driver following the appropriate documenation for your installation method.

7. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
value: "true"
```

Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerFlex driver following the appropriate documenation for your installation method.
Original file line number Diff line number Diff line change
Expand Up @@ -147,4 +147,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
value: "true"
```

6. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.
Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.
10 changes: 8 additions & 2 deletions content/docs/deployment/csmoperator/drivers/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,13 @@ For detailed PowerFlex installation procedure, see the [Dell PowerFlex Deploymen
1. Follow all the [prerequisites](#prerequisite) above

2. Create a CR (Custom Resource) for PowerFlex using the sample files provided
[here](https://github.com/dell/csm-operator/tree/master/samples). This file can be modified to use custom parameters if needed.

a. Install the PowerFlex driver using default configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples). This file can be modified to use custom parameters if needed.

b. Install the PowerFlex driver using the detailed configuration using the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples).

3. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the PowerFlex driver and their default values:

Expand Down Expand Up @@ -169,4 +175,4 @@ For detailed PowerFlex installation procedure, see the [Dell PowerFlex Deploymen
6. Refer https://github.com/dell/csi-powerflex/tree/main/samples for the sample files.

**Note** :
1. Snapshotter and resizer sidecars are installed by default.
1. Snapshotter and resizer sidecars are installed by default.
12 changes: 10 additions & 2 deletions content/docs/deployment/csmoperator/drivers/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,8 +324,16 @@ Create a secret named powermax-certs in the namespace where the CSI PowerMax dri
X_CSI_MANAGED_ARRAYS: "000000000000,000000000000,"
```

5. Create a CR (Custom Resource) for PowerMax using the sample files provided [here](https://github.com/dell/csm-operator/tree/master/samples). This file can be modified to use custom parameters if needed.
6. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the PowerMax driver and their default values:
4. Create a CR (Custom Resource) for PowerMax using the sample files provided

a. Install the PowerMax driver using default configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples). This file can be modified to use custom parameters if needed.

b. Install the PowerMax driver using the detailed configuration using the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples).

5. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the PowerMax driver and their default values:

| Parameter | Description | Required | Default |
|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|--------------------------------|
Expand Down
8 changes: 7 additions & 1 deletion content/docs/deployment/csmoperator/drivers/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,13 @@ kubectl get csm --all-namespaces
1. Follow all the [prerequisites](#prerequisite) above

2. Create a CR (Custom Resource) for PowerScale using the sample files provided
[here](https://github.com/dell/csm-operator/tree/master/samples). This file can be modified to use custom parameters if needed.

a. Install the PowerScale driver using default configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples). This file can be modified to use custom parameters if needed.

b. Install the PowerScale driver using the detailed configuration using the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples).

3. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the PowerScale driver and their default values:

Expand Down
9 changes: 8 additions & 1 deletion content/docs/deployment/csmoperator/drivers/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,14 @@ CRDs should be configured during replication prepare stage with repctl as descri
1. Follow all the [prerequisites](#prerequisite) above

2. Create a CR (Custom Resource) for PowerStore using the sample files provided
[here](https://github.com/dell/csm-operator/tree/master/samples). This file can be modified to use custom parameters if needed.

a. Install the PowerStore driver using default configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples). This file can be modified to use custom parameters if needed.

b. Install the PowerStore driver using the detailed configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples).

3. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the PowerStore driver and their default values:

Expand Down
8 changes: 7 additions & 1 deletion content/docs/deployment/csmoperator/drivers/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,13 @@ kubectl get csm --all-namespaces
1. Follow all the [prerequisites](#prerequisite) above

2. Create a CR (Custom Resource) for Unity XT using the sample files provided
[here](https://github.com/dell/csm-operator/tree/master/samples). This file can be modified to use custom parameters if needed.

a. Install the Unity driver using default configuration using
the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples). This file can be modified to use custom parameters if needed.

b. Install the Unity driver using the detailed configuration using the sample file provided
[here](https://github.com/dell/csm-operator/tree/main/samples).

3. Users should configure the parameters in CR. The following table lists the primary configurable parameters of the Unity XT driver and their default values:

Expand Down
5 changes: 5 additions & 0 deletions content/docs/deployment/csmoperator/modules/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ The CSM Observability module for supported Dell CSI Drivers can be installed via
- Once you have prepared the sample file(s) (one per driver being installed), deploy by running `kubectl apply -f <SAMPLE FILE>` on the sample file.
## How to enable this module using minimal CR
Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples).
## Upgrade Observability
The Observability module installed by the Dell CSM Operator can be updated like any Kubernetes resource.
Expand Down
3 changes: 3 additions & 0 deletions content/docs/deployment/csmoperator/modules/resiliency.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,6 @@ To enable this module, user should choose the sample file for the respective dri
- "--driver-config-params=/powerstore-config-params/driver-config-params.yaml"
- "--driverPath=csi-powerstore.dellemc.com"
```
## How to enable this module using minimal CR
To enable this module, user should choose the minimal sample file for the respective driver for specific version. By default, the module is disabled but this can be enabled by setting the enabled flag to `true` in the minimal sample file.

0 comments on commit 1f066f2

Please sign in to comment.