diff --git a/content/docs/authorization/v1.x GA/configuration/powerflex/_index.md b/content/docs/authorization/v1.x GA/configuration/powerflex/_index.md index dd24f52ca4..3605b097aa 100644 --- a/content/docs/authorization/v1.x GA/configuration/powerflex/_index.md +++ b/content/docs/authorization/v1.x GA/configuration/powerflex/_index.md @@ -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. diff --git a/content/docs/authorization/v1.x GA/configuration/powermax/_index.md b/content/docs/authorization/v1.x GA/configuration/powermax/_index.md index 8032a47bb1..d48662ec3d 100644 --- a/content/docs/authorization/v1.x GA/configuration/powermax/_index.md +++ b/content/docs/authorization/v1.x GA/configuration/powermax/_index.md @@ -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. diff --git a/content/docs/authorization/v1.x GA/configuration/powerscale/_index.md b/content/docs/authorization/v1.x GA/configuration/powerscale/_index.md index 914e09a1cc..ccbc36eb6e 100644 --- a/content/docs/authorization/v1.x GA/configuration/powerscale/_index.md +++ b/content/docs/authorization/v1.x GA/configuration/powerscale/_index.md @@ -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. diff --git a/content/docs/authorization/v2.0 Tech Preview/configuration/powerflex/_index.md b/content/docs/authorization/v2.0 Tech Preview/configuration/powerflex/_index.md index 2cb84ca9b0..2dc96fdf6f 100644 --- a/content/docs/authorization/v2.0 Tech Preview/configuration/powerflex/_index.md +++ b/content/docs/authorization/v2.0 Tech Preview/configuration/powerflex/_index.md @@ -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. diff --git a/content/docs/authorization/v2.0 Tech Preview/configuration/powermax/_index.md b/content/docs/authorization/v2.0 Tech Preview/configuration/powermax/_index.md index 5af0901933..8824b2050c 100644 --- a/content/docs/authorization/v2.0 Tech Preview/configuration/powermax/_index.md +++ b/content/docs/authorization/v2.0 Tech Preview/configuration/powermax/_index.md @@ -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. \ No newline at end of file diff --git a/content/docs/deployment/csmoperator/drivers/powerflex.md b/content/docs/deployment/csmoperator/drivers/powerflex.md index 8f6897a41e..0fc3abfa2a 100644 --- a/content/docs/deployment/csmoperator/drivers/powerflex.md +++ b/content/docs/deployment/csmoperator/drivers/powerflex.md @@ -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: @@ -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. \ No newline at end of file diff --git a/content/docs/deployment/csmoperator/drivers/powermax.md b/content/docs/deployment/csmoperator/drivers/powermax.md index 95e3bf8bf6..cbbcec6923 100644 --- a/content/docs/deployment/csmoperator/drivers/powermax.md +++ b/content/docs/deployment/csmoperator/drivers/powermax.md @@ -297,8 +297,42 @@ Create a secret named powermax-certs in the namespace where the CSI PowerMax dri ```bash kubectl create configmap powermax-reverseproxy-config --from-file config.yaml -n powermax ``` +4. Create a configmap using below sample file. Fill in the appropriate values for driver configuration. Example: X_CSI_TRANSPORT_PROTOCOL:"ISCSI" + ```yaml + # Copyright © 2024 Dell Inc. or its subsidiaries. All Rights Reserved. + # + # Licensed under the Apache License, Version 2.0 (the "License"); + # you may not use this file except in compliance with the License. + # You may obtain a copy of the License at + # http://www.apache.org/licenses/LICENSE-2.0 + # Unless required by applicable law or agreed to in writing, software + # distributed under the License is distributed on an "AS IS" BASIS, + # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + # See the License for the specific language governing permissions and + # limitations under the License. + # To create this configmap use: kubectl create -f powermax-array-config.yaml + apiVersion: v1 + kind: ConfigMap + metadata: + name: powermax-array-config + namespace: powermax + data: + powermax-array-config.yaml: | + X_CSI_POWERMAX_PORTGROUPS: "" # Portgroup is required in case of iSCSI only + X_CSI_TRANSPORT_PROTOCOL: "" # Defaults to empty + X_CSI_POWERMAX_ENDPOINT: "https://10.0.0.0:8443" + X_CSI_MANAGED_ARRAYS: "000000000000,000000000000," + ``` + +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). -4. 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. 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 | @@ -329,9 +363,9 @@ Create a secret named powermax-certs in the namespace where the CSI PowerMax dri | X_CSI_REVPROXY_PORT | Port number where reverseproxy will listen as defined in config map | Yes | "2222" | | X_CSI_CONFIG_MAP_NAME | Name of config map as created for CSI PowerMax | Yes | "powermax-reverseproxy-config" | -6. Execute the following command to create the PowerMax custom resource:`kubectl create -f `. The above command will deploy the CSI-PowerMax driver. -7. The mandatory module CSI PowerMax Reverseproxy will be installed automatically with the same command. -8. Refer https://github.com/dell/csi-powermax/tree/main/samples for the sample files. +7. Execute the following command to create the PowerMax custom resource:`kubectl create -f `. The above command will deploy the CSI-PowerMax driver. +8. The mandatory module CSI PowerMax Reverseproxy will be installed automatically with the same command. +9. Refer https://github.com/dell/csi-powermax/tree/main/samples for the sample files. ## Other features to enable ### Dynamic Logging Configuration diff --git a/content/docs/deployment/csmoperator/drivers/powerscale.md b/content/docs/deployment/csmoperator/drivers/powerscale.md index fa0fb25c33..4220665777 100644 --- a/content/docs/deployment/csmoperator/drivers/powerscale.md +++ b/content/docs/deployment/csmoperator/drivers/powerscale.md @@ -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: diff --git a/content/docs/deployment/csmoperator/drivers/powerstore.md b/content/docs/deployment/csmoperator/drivers/powerstore.md index 256d5c0cbd..d61f1e0fe1 100644 --- a/content/docs/deployment/csmoperator/drivers/powerstore.md +++ b/content/docs/deployment/csmoperator/drivers/powerstore.md @@ -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: diff --git a/content/docs/deployment/csmoperator/drivers/unity.md b/content/docs/deployment/csmoperator/drivers/unity.md index bae1ac5b4f..f145245b9c 100644 --- a/content/docs/deployment/csmoperator/drivers/unity.md +++ b/content/docs/deployment/csmoperator/drivers/unity.md @@ -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: diff --git a/content/docs/deployment/csmoperator/modules/observability.md b/content/docs/deployment/csmoperator/modules/observability.md index df8cffa335..da74dbaef3 100644 --- a/content/docs/deployment/csmoperator/modules/observability.md +++ b/content/docs/deployment/csmoperator/modules/observability.md @@ -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 ` 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. diff --git a/content/docs/deployment/csmoperator/modules/resiliency.md b/content/docs/deployment/csmoperator/modules/resiliency.md index 40cb14d606..341ca3850f 100644 --- a/content/docs/deployment/csmoperator/modules/resiliency.md +++ b/content/docs/deployment/csmoperator/modules/resiliency.md @@ -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. \ No newline at end of file diff --git a/content/v1/deployment/csminstallationwizard/src/package.json b/content/v1/deployment/csminstallationwizard/src/package.json index 51b347c5d5..90c788dfe1 100644 --- a/content/v1/deployment/csminstallationwizard/src/package.json +++ b/content/v1/deployment/csminstallationwizard/src/package.json @@ -1,5 +1,5 @@ { - "name": "csm-installation-wizard", + "name": "@dell/csm-installation-wizard", "version": "1.0.0", "description": "", "scripts": { diff --git a/content/v2/deployment/csminstallationwizard/src/package.json b/content/v2/deployment/csminstallationwizard/src/package.json index 51b347c5d5..90c788dfe1 100644 --- a/content/v2/deployment/csminstallationwizard/src/package.json +++ b/content/v2/deployment/csminstallationwizard/src/package.json @@ -1,5 +1,5 @@ { - "name": "csm-installation-wizard", + "name": "@dell/csm-installation-wizard", "version": "1.0.0", "description": "", "scripts": { diff --git a/content/v3/deployment/csminstallationwizard/src/package.json b/content/v3/deployment/csminstallationwizard/src/package.json index 51b347c5d5..90c788dfe1 100644 --- a/content/v3/deployment/csminstallationwizard/src/package.json +++ b/content/v3/deployment/csminstallationwizard/src/package.json @@ -1,5 +1,5 @@ { - "name": "csm-installation-wizard", + "name": "@dell/csm-installation-wizard", "version": "1.0.0", "description": "", "scripts": {