Skip to content

Commit

Permalink
update helm values and secret name.
Browse files Browse the repository at this point in the history 
- csireverseproxy.secretName is changed in favor of csireverseproxy.useSecret and global.defaultCredentialsSecret to match operator install implementation.
- default value for global.defaultCredentialsSecret changed to "powermax-config" to match operator implementation
  • Loading branch information
@lukeatdell
lukeatdell committed Jan 21, 2025
1 parent 5a67da6 commit a3929e6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 39 deletions.
42 changes: 7 additions & 35 deletions content/docs/deployment/helm/drivers/installation/powermax.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The CSI PowerMax Reverse Proxy is an HTTPS server and has to be configured with

The certificate and key are provided to the proxy via a Kubernetes TLS secret (in the same namespace). The SSL certificate must be an X.509 certificate encoded in PEM format. The certificates can be obtained via a Certificate Authority or can be self-signed and generated by a tool such as openssl.

Starting from v2.7.0 these secrets will be automatically created using the tls.key and tls.cert contents provided in my-powermax-settings.yaml file. For this to be used, we need to install cert-manager which manages the certs and secrets. Install cer-manager using the following command:
Starting from v2.7.0 these secrets will be automatically created using the tls.key and tls.cert contents provided in my-powermax-settings.yaml file. For this to be used, we need to install cert-manager which manages the certs and secrets. Install cert-manager using the following command:

```bash
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.11.0/cert-manager.yaml
Expand Down Expand Up @@ -417,21 +417,21 @@ CRDs should be configured during replication prepare stage with repctl as descri
```
4. Create the powermax-reverseproxy-secret Secret.
```bash
kubectl create secret generic powermax-reverseproxy-secret --namespace powermax --from-file=config=samples/secret/secret.yaml
kubectl create secret generic powermax-config --namespace powermax --from-file=config=samples/secret/secret.yaml
```
5. Download the default values.yaml file.
```bash
cd dell-csi-helm-installer && wget -O my-powermax-settings.yaml https://github.com/dell/helm-charts/raw/csi-powermax-2.14.0/charts/csi-powermax/values.yaml
```
6. Edit the newly created file and provide values for the following parameters
6. Edit the newly created file and provide values for the following parameters.
```bash
vi my-powermax-settings.yaml
```

| Parameter | Description | Required | Default |
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|----------|
| **global**| This section refers to configuration options for both CSI PowerMax Driver and Reverse Proxy | - | - |
| &nbsp;&nbsp; ~~defaultCredentialsSecret~~ | **Deprecated**. Use `csireverseproxy.secretName` below. <br> This secret name refers to:<br> 1. The proxy credentials if the driver is installed with proxy.<br>2. The default Unisphere credentials if credentialsSecret is not specified for a management server. | Yes | powermax-creds |
| &nbsp;&nbsp; defaultCredentialsSecret | The name of the reverse proxy secret, created in [installation step 3](#installation), used to specify PowerMax storage arrays and their login credentials. | Yes | powermax-config |
| &nbsp;&nbsp; ~~**storageArrays**~~ | **Deprecated**. Refer to [installation step 3](#installation) to configure storage arrays. <br> This section refers to the list of arrays managed by the driver and Reverse Proxy. | - | - |
| &nbsp;&nbsp;&nbsp;&nbsp; ~~storageArrayId~~ | **Deprecated**. Refer to [installation step 3](#installation) to configure storage arrays. <br> This refers to PowerMax Symmetrix ID. | Yes | 000000000001|
| &nbsp;&nbsp;&nbsp;&nbsp; ~~endpoint~~ | **Deprecated**. Refer to [installation step 3](#installation) to configure storage arrays. <br> This refers to the URL of the Unisphere server managing _storageArrayId_. If authorization is enabled, endpoint should be the HTTPS localhost endpoint that the authorization sidecar will listen on | Yes | https\://primary-1.unisphe.re:8443 |
Expand Down Expand Up @@ -482,7 +482,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
| &nbsp;&nbsp; tlsSecret | This refers to the TLS secret of the Reverse Proxy Server. | Yes | csirevproxy-tls-secret |
| &nbsp;&nbsp; deployAsSidecar | If set to _true_, the Reverse Proxy is installed as a sidecar to the driver's controller pod otherwise it is installed as a separate deployment. | Yes | "True" |
| &nbsp;&nbsp; port | Specify the port number that is used by the NodePort service created by the CSI PowerMax Reverse Proxy installation | Yes | 2222 |
| &nbsp;&nbsp; secretName | The name of the Kubernetes secret created in the previous steps, containing information for connecting to one or more Unisphere servers. | Yes | powermax-reverseproxy-secret |
| &nbsp;&nbsp; useSecret | Defines if the reverseproxy Secret should be used instead of the deprecated powermax-reverseproxy-config ConfigMap. If set to true, the contents of the secret specified by `global.defaultCredentialsSecret` will be used, in the new format, to specify Unisphere for PowerMax endpoints, array IDs, and login credentials. If set to false, the deprecated powermax-reverseprpoxy-config ConfigMap will be used. | Yes | true |
| &nbsp;&nbsp; **certManager** | Auto-create TLS certificate for csi-reverseproxy | - | - |
| &nbsp;&nbsp;&nbsp;&nbsp; selfSignedCert | Set selfSignedCert to `true` to use a self-signed certificate | No | true |
| &nbsp;&nbsp;&nbsp;&nbsp; certificateFile | certificateFile contains the tls.key contents in base64 encoded format | No | tls.crt.encoded64 |
Expand Down Expand Up @@ -516,7 +516,7 @@ CRDs should be configured during replication prepare stage with repctl as descri
tlsSecret: csirevproxy-tls-secret
deployAsSidecar: false
port: 2222
secretName: csi-reverseproxy-secret
useSecret: true
certManager:
selfSignedCert: false
certificateFile: |
Expand Down Expand Up @@ -553,34 +553,6 @@ CRDs should be configured during replication prepare stage with repctl as descri

A wide set of annotated storage class manifests has been provided in the `samples/storageclass` folder. Please use these samples to create new storage classes to provision storage.

## Volume Snapshot Class
## Volume Snapshot Classes

Starting with CSI PowerMax v1.7.0, `dell-csi-helm-installer` will not create any Volume Snapshot Class during the driver installation. There is a sample Volume Snapshot Class manifest present in the _samples/volumesnapshotclass_ folder. Please use this sample to create a new Volume Snapshot Class to use when creating Volume Snapshots.

## Sample values file

The following sections have useful snippets from `values.yaml` file which provides more information on how to configure the CSI PowerMax driver along with CSI PowerMax ReverseProxy.

### CSI PowerMax driver with Reverse Proxy

This is the most advanced configuration which provides you with the capability to connect to Multiple Unisphere servers.
You can specify primary and backup Unisphere servers for each storage array. If you have different credentials for your Unisphere servers, you can also specify different credential secrets.

```yaml
# "csireverseproxy" refers to the subchart csireverseproxy
csireverseproxy:
tlsSecret: csirevproxy-tls-secret
deployAsSidecar: true
port: 2222
secretName: powermax-reverseproxy-secret
certManager:
selfSignedCert: "true"
certificateFile: |
dGhpcyBzdHJpbmcgc2VydmVzIGFzIGFuIGV4YW1wbGUgb2Ygd2hhdCBhIGJhc2U2NCBlbmNvZGVk
IGNlcnRpZmljYXRlIGZpbGUgbWlnaHQgbG9vayBsaWtlIGluIG15LXBvd2VybWF4LXNldHRpbmdz
LnlhbWwgZmlsZQo=
privateKey: |
dGhpcyBzdHJpbmcgc2VydmVzIGFzIGFuIGV4YW1wbGUgb2Ygd2hhdCBhIGJhc2U2NCBlbmNvZGVk
IHByaXZhdGUga2V5IG1pZ2h0IGxvb2sgbGlrZSBpbiBteS1wb3dlcm1heC1zZXR0aW5ncy55YW1s
IGZpbGUK
```
10 changes: 6 additions & 4 deletions content/docs/deployment/helm/drivers/upgrade/powermax.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ Upgrades to the CSI Driver for Dell PowerMax can be made using Helm or Dell CSM
**Steps**

1. Run `git clone -b v2.14.0 https://github.com/dell/csi-powermax.git` to clone the git repository.
2. As of CSI PowerMax v2.14.0, the csi reverse proxy configuration and connectivity information has been migrated from a ConfigMap to a Secret. If a powermax reverse proxy secret was not previously created, reference [helm install instructions step 3](../../installation/powermax#installation) and your existing `my-powermax-settings.yaml` file to configure the new powermax reverseproxy Secret. Then create the `powermax-reverseproxy-secret` Secret.
2. As of CSI PowerMax v2.14.0, the csi reverse proxy configuration and connectivity information has been migrated from a ConfigMap to a Secret. If a powermax reverse proxy secret was not previously created, reference [helm install instructions step 3](../../installation/powermax#installation) and your existing `my-powermax-settings.yaml` file to configure the new powermax reverse proxy Secret. Then create the reverse proxy Secret.
```bash
kubectl create secret generic powermax-reverseproxy-secret --namespace powermax --from-file=config=samples/secret/secret.yaml
kubectl create secret generic powermax-config --namespace powermax --from-file=config=samples/secret/secret.yaml
```
> Note: The ConfigMap has been deprecated as of CSI PowerMax v2.14.0 and will be removed in a future release. The `powermax-reverseproxy-config` remains for backward compatibility only. Use of the powermax reverse proxy secret is recommended.
3. Download the latest helm values file and update as needed, making sure to update `csireverseproxy.secretName` to match the name of the Secret created above.
> Note: The `powermax-reverseproxy-config` ConfigMap has been deprecated as of CSI PowerMax v2.14.0 and will be removed in a future release.
The `powermax-reverseproxy-config` remains for backward compatibility only. Use of the powermax reverse proxy secret, as outlined above, is recommended.
If you would like to continue using the `powemax-reverseproxy-config` ConfigMap, set `csireverseproxy.useSecret: false` in your helm values file.
3. Download the latest helm values file and update as needed. Reference the [PowerMax Helm Installation steps](../../installation/powermax#installation) for more details on the available options.
```bash
wget -O my-powermax-settings.yaml https://github.com/dell/helm-charts/raw/csi-powermax-2.14.0/charts/csi-powermax/values.yaml
```
Expand Down

0 comments on commit a3929e6

Please sign in to comment.