Skip to content

Commit

Permalink
Helm driver images (#867)
Browse files Browse the repository at this point in the history
  • Loading branch information
coulof authored Nov 9, 2023
1 parent d9a076e commit f122723
Show file tree
Hide file tree
Showing 15 changed files with 18 additions and 48 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Create the karavi-authorization-config secret using this command:

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=

- Update `authorization.enabled` to `true`.

- Update `authorization.sidecarProxyImage` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.
- Update `images.authorization` to the image of the CSM Authorization sidecar. In most cases, you can leave the default value.

- Update `authorization.proxyHost` to the hostname of the CSM Authorization Proxy Server.

Expand Down
8 changes: 2 additions & 6 deletions content/docs/csidriver/installation/helm/isilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ CRDs should be configured during replication prepare stage with repctl as descri

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
| driverRepository | Set to give the repository containing the driver image (used as part of the image name). | Yes | dellemc |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" |
| logLevel | CSI driver log level | No | "debug" |
| certSecretCount | Defines the number of certificate secrets, which the user is going to create for SSL authentication. (isilon-cert-0..isilon-cert-(n-1)); Minimum value should be 1.| Yes | 1 |
| [allowedNetworks](../../../features/powerscale/#support-custom-networks-for-nfs-io-traffic) | Defines the list of networks that can be used for NFS I/O traffic, CIDR format must be used. | No | [ ] |
Expand Down Expand Up @@ -161,23 +161,19 @@ CRDs should be configured during replication prepare stage with repctl as descri
| autoProbe | Specify if automatically probe the PowerScale cluster if not done already during CSI calls | No | true |
| **authorization** | [Authorization](../../../../authorization/deployment) is an optional feature to apply credential shielding of the backend PowerScale. | - | - |
| enabled | A boolean that enables/disables authorization feature. | No | false |
| sidecarProxyImage | Image for csm-authorization-sidecar. | No | " " |
| 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 |
| **podmon** | [Podmon](../../../../resiliency/deployment) is an optional feature to enable application pods to be resilient to node failure. | - | - |
| enabled | A boolean that enables/disables podmon feature. | No | false |
| image | image for podmon. | No | " " |
| **encryption** | [Encryption](../../../../secure/encryption/deployment) is an optional feature to apply encryption to CSI volumes. | - | - |
| enabled | A boolean that enables/disables Encryption feature. | No | false |
| image | Encryption driver image name. | No | "dellemc/csm-encryption:v0.3.0" |

*NOTE:*

- ControllerCount parameter value must not exceed the number of nodes in the Kubernetes cluster. Otherwise, some of the controller pods remain in a "Pending" state till new nodes are available for scheduling. The installer exits with a WARNING on the same.
- Whenever the *certSecretCount* parameter changes in *my-isilon-setting.yaml* user needs to reinstall the driver.
- In order to enable authorization, there should be an authorization proxy server already installed.
- If you are using a custom image, check the *version* and *driverRepository* fields in *my-isilon-setting.yaml* to make sure that they are pointing to the correct image repository and driver version. These two fields are spliced together to form the image name, as shown here: <driverRepository>/csi-isilon:<version>

- If you are using custom images, update each attributes under the *images* field in *my-isilon-setting.yaml* to make sure that they are pointing to the correct image repository and version.
6. Edit following parameters in samples/secret/secret.yaml file and update/add connection/authentication information for one or more PowerScale clusters. If replication feature is enabled, ensure the secret includes all the PowerScale clusters involved in replication.

| Parameter | Description | Required | Default |
Expand Down
8 changes: 3 additions & 5 deletions content/docs/csidriver/installation/helm/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,15 +167,15 @@ Use the below command to replace or update the secret:
>Note: To connect to a PowerFlex 4.5 array, edit the powerflexSdc parameter in your values.yaml file to use dellemc/sdc:4.5:
>`powerflexSdc: dellemc/sdc:4.5`

8. If you are using a custom image, check the `version` and `driverRepository` fields in `my-vxflexos-settings.yaml` to make sure that they are pointing to the correct image repository and driver version. These two fields are spliced together to form the image name, as shown here: `<driverRepository>/csi-vxflexos:v<version>`
8. If you are using custom images, check the fields under `images` in `my-vxflexos-settings.yaml` to make sure that they are pointing to the correct image repository.

9. Look over all the other fields `myvalues.yaml` and fill in/adjust any as needed. All the fields are described here:

| Parameter | Description | Required | Default |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- |
| version | Set to verify the values file version matches driver version and used to pull the image as part of the image name. | Yes | 2.8.0 |
| driverRepository | Set to give the repository containing the driver image (used as part of the image name). | Yes | dellemc |
| powerflexSdc | Set to give the location of the SDC image used if automatic SDC deployment is being utilized. | Yes | dellemc/sdc:3.6.1 |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" |
| images.powerflexSdc | Set to give the location of the SDC image used if automatic SDC deployment is being utilized. | Yes | dellemc/sdc:3.6.1 |
| certSecretCount | Represents the number of certificate secrets, which the user is going to create for SSL authentication. | No | 0 |
| logLevel | CSI driver log level. Allowed values: "error", "warn"/"warning", "info", "debug". | Yes | "debug" |
| logFormat | CSI driver log format. Allowed values: "TEXT" or "JSON". | Yes | "TEXT" |
Expand Down Expand Up @@ -217,10 +217,8 @@ Use the below command to replace or update the secret:
| image | Image for vg snapshotter. | No | " " |
| **podmon** | [Podmon](../../../../resiliency/deployment) is an optional feature to enable application pods to be resilient to node failure. | - | - |
| enabled | A boolean that enables/disables podmon feature. | No | false |
| image | image for podmon. | No | " " |
| **authorization** | [Authorization](../../../../authorization/deployment) is an optional feature to apply credential shielding of the backend PowerFlex. | - | - |
| enabled | A boolean that enables/disables authorization feature. | No | false |
| sidecarProxyImage | Image for csm-authorization-sidecar. | No | " " |
| 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 |

Expand Down
9 changes: 2 additions & 7 deletions content/docs/csidriver/installation/helm/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,8 @@ CRDs should be configured during replication prepare stage with repctl as descri
| powerMaxDebug | Enables low level and http traffic logging between the CSI driver and Unisphere. Don't enable this unless asked to do so by the support team. | No | false |
| enableCHAP | Determine if the driver is going to configure SCSI node databases on the nodes with the CHAP credentials. If enabled, the CHAP secret must be provided in the credentials secret and set to the key "chapsecret" | No | false |
| fsGroupPolicy | Defines which FS Group policy mode to be used, Supported modes `None, File and ReadWriteOnceWithFSType` | No | "ReadWriteOnceWithFSType" |
| version | Current version of the driver. Don't modify this value as this value will be used by the install script. | Yes | v2.3.0 |
| images | Defines the container images used by the driver. | - | - |
| driverRepository | Defines the registry of the container image used for the driver. | Yes | dellemc |
| version | Current version of the driver. Don't modify this value as this value will be used by the install script. | Yes | v2.8.0 |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" || driverRepository | Defines the registry of the container image used for the driver. | Yes | dellemc |
| maxPowerMaxVolumesPerNode | Specifies the maximum number of volume that can be created on a node. | Yes| 0 |
| **controller** | Allows configuration of the controller-specific parameters.| - | - |
| controllerCount | Defines the number of csi-powerscale controller pods to deploy to the Kubernetes release| Yes | 2 |
Expand All @@ -282,7 +281,6 @@ CRDs should be configured during replication prepare stage with repctl as descri
| healthMonitor.enabled | Allows to enable/disable volume health monitor | No | false |
| topologyControl.enabled | Allows to enable/disable topology control to filter topology keys | No | false |
| **csireverseproxy**| This section refers to the configuration options for CSI PowerMax Reverse Proxy | - | - |
| image | This refers to the image of the CSI PowerMax Reverse Proxy container. | Yes | dellemc/csipowermax-reverseproxy:v2.4.0 |
| tlsSecret | This refers to the TLS secret of the Reverse Proxy Server.| Yes | csirevproxy-tls-secret |
| 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" |
| port | Specify the port number that is used by the NodePort service created by the CSI PowerMax Reverse Proxy installation| Yes | 2222 |
Expand All @@ -292,7 +290,6 @@ CRDs should be configured during replication prepare stage with repctl as descri
| privateKeyFile | privateKeyFile has tls.key content in encoded format | No | tls.key.encoded64 |
| **authorization** | [Authorization](../../../../authorization/deployment) is an optional feature to apply credential shielding of the backend PowerMax. | - | - |
| enabled | A boolean that enables/disables authorization feature. | No | false |
| sidecarProxyImage | Image for csm-authorization-sidecar. | No | " " |
| 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 |
| **migration** | [Migration](../../../../replication/migration/migrating-volumes-same-array) is an optional feature to enable migration between storage classes | - | - |
Expand All @@ -302,7 +299,6 @@ CRDs should be configured during replication prepare stage with repctl as descri
| migrationPrefix | enables migration sidecar to read required information from the storage class fields | No | migration.storage.dell.com |
| **replication** | [Replication](../../../../replication/deployment) is an optional feature to enable replication & disaster recovery capabilities of PowerMax to Kubernetes clusters.| - | - |
| enabled | A boolean that enables/disables replication feature. | No | false |
| image | Image for dell-csi-replicator sidecar. | No | " " |
| replicationContextPrefix | enables side cars to read required information from the volume context | No | powermax |
| replicationPrefix | Determine if replication is enabled | No | replication.storage.dell.com |
| **storageCapacity** | It is an optional feature that enable storagecapacity & helps the scheduler to check whether the requested capacity is available on the PowerMax array and allocate it to the nodes.| - | - |
Expand Down Expand Up @@ -383,7 +379,6 @@ global:
# "csireverseproxy" refers to the subchart csireverseproxy
csireverseproxy:
image: dellemc/csipowermax-reverseproxy:v2.4.0
tlsSecret: csirevproxy-tls-secret
deployAsSidecar: true
port: 2222
Expand Down
3 changes: 1 addition & 2 deletions content/docs/csidriver/installation/helm/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ CRDs should be configured during replication prepare stage with repctl as descri

| Parameter | Description | Required | Default |
|-----------|-------------|----------|---------|
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" |
| logLevel | Defines CSI driver log level | No | "debug" |
| logFormat | Defines CSI driver log format | No | "JSON" |
| externalAccess | Defines additional entries for hostAccess of NFS volumes, single IP address and subnet are valid entries | No | " " |
Expand All @@ -204,13 +205,11 @@ CRDs should be configured during replication prepare stage with repctl as descri
| node.tolerations | Defines tolerations that would be applied to node daemonset | Yes | " " |
| fsGroupPolicy | Defines which FS Group policy mode to be used, Supported modes `None, File and ReadWriteOnceWithFSType` | No | "ReadWriteOnceWithFSType" |
| controller.vgsnapshot.enabled | Allows to enable/disable the volume group snapshot feature | No | "true" |
| images.driverRepository | To use an image from custom repository | No | dockerhub |
| version | To use any driver version | No | Latest driver version |
| allowAutoRoundOffFilesystemSize | Allows the controller to round off filesystem to 3Gi which is the minimum supported value | No | false |
| storageCapacity.enabled | Allows to enable/disable storage capacity tracking feature | No | true
| storageCapacity.pollInterval | Configure how often the driver checks for changed capacity | No | 5m
| podmon.enabled | Allows to enable/disable [Resiliency](../../../../resiliency/deployment#powerstore-specific-recommendations) feature | No | false
| podmon.image | Sidecar image for resiliency | No | -

8. Install the driver using `csi-install.sh` bash script by running
```bash
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/installation/helm/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ cd dell-csi-helm-installer && wget -O my-unity-settings.yaml https://github.com/

| Parameter | Description | Required | Default |
| --------- | ----------- | -------- |-------- |
| images | List all the images used by the CSI driver and CSM. If you use a private repository, change the registries accordingly. | Yes | "" |
| logLevel | LogLevel is used to set the logging level of the driver | No | info |
| allowRWOMultiPodAccess | Flag to enable multiple pods to use the same PVC on the same node with RWO access mode. | No | false |
| kubeletConfigDir | Specify kubelet config dir path | Yes | /var/lib/kubelet |
Expand All @@ -129,7 +130,6 @@ cd dell-csi-helm-installer && wget -O my-unity-settings.yaml https://github.com/
| certSecretCount | Represents the number of certificate secrets, which the user is going to create for SSL authentication. (unity-cert-0..unity-cert-n). The minimum value should be 1. | No | 1 |
| imagePullPolicy | The default pull policy is IfNotPresent which causes the Kubelet to skip pulling an image if it already exists. | Yes | IfNotPresent |
| podmon.enabled | service to monitor failing jobs and notify | No | false |
| podmon.image| pod man image name | No | - |
| tenantName | Tenant name added while adding host entry to the array | No | |
| fsGroupPolicy | Defines which FS Group policy mode to be used, Supported modes `None, File and ReadWriteOnceWithFSType` | No | "ReadWriteOnceWithFSType" |
| storageCapacity.enabled | Enable/Disable storage capacity tracking | No | true |
Expand Down
4 changes: 1 addition & 3 deletions content/docs/replication/deployment/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,11 @@ Here is an example of how that would look:
# Set this to true to enable replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powerflex"
replicationPrefix: "replication.storage.dell.com"
...
```
You can leave other parameters like `image`, `replicationContextPrefix`, and
`replicationPrefix` as they are.
You can leave other parameters like `replicationContextPrefix`, and `replicationPrefix` as they are.
After enabling the replication module you can continue to install the CSI driver
for PowerFlex following the usual installation procedure, just ensure you've added
Expand Down
3 changes: 1 addition & 2 deletions content/docs/replication/deployment/powermax.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,11 @@ Here is an example of what that would look like:
# Set this to true to enable replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powermax"
replicationPrefix: "replication.storage.dell.com"
...
```
You can leave other parameters like `image`, `replicationContextPrefix`, and `replicationPrefix` as they are.
You can leave other parameters like `replicationContextPrefix`, and `replicationPrefix` as they are.
After enabling the replication module you can continue to install the CSI driver for PowerMax following
usual installation procedure, just ensure you've added necessary array connection information to secret.
Expand Down
3 changes: 1 addition & 2 deletions content/docs/replication/deployment/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,11 @@ controller:
# replication: allows to configure replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powerscale"
replicationPrefix: "replication.storage.dell.com"
...
```
You can leave other parameters like `image`, `replicationContextPrefix`, and `replicationPrefix` as they are.
You can leave other parameters like `replicationContextPrefix`, and `replicationPrefix` as they are.
After enabling the replication module, you can continue to install the CSI driver for PowerScale following the usual installation procedure. Just ensure you've added the necessary array connection information to the Kubernetes secret for the PowerScale driver.

Expand Down
3 changes: 1 addition & 2 deletions content/docs/replication/deployment/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,11 @@ controller:
# replication: allows to configure replication
replication:
enabled: true
image: dellemc/dell-csi-replicator:v1.6.0
replicationContextPrefix: "powerstore"
replicationPrefix: "replication.storage.dell.com"
...
```
You can leave other parameters like `image`, `replicationContextPrefix`, and `replicationPrefix` as they are.
You can leave other parameters like `replicationContextPrefix`, and `replicationPrefix` as they are.
After enabling the replication module you can continue to install the CSI driver for PowerStore following
usual installation procedure, just ensure you've added necessary array connection information to secret.
Expand Down
Loading

0 comments on commit f122723

Please sign in to comment.