Helm chart parameters
Refer to the following list when configuring Helm value files for the Delphix K8s driver. The various parameters have been organized into groups for legibility.
Parameter type terms explained:
-
Required: Parameter exists in
values.yaml. This parameter needs a valid value and it can be updated by the user. -
Optional: Parameter exists in
values.yaml. This parameter can be left as default and updated by the user. -
Required but protected: Parameter exists in
values.yaml. This parameter needs a valid value and should not be updated by the user.
Image Repositories: The following values describe where the six CSI Driver images should be pulled, the image versions, and the pull policy. Typically, these values can be ignored. However, if the Kubernetes Cluster does not have internet access, these values must be updated. Follow the Installation (Offline) for more information.
| Parameter | Description | Suggested values | Parameter type |
|---|---|---|---|
|
image.csiDePlugin.repository |
csi-de-plugin Docker image |
Required | |
|
image.csiDePlugin.tag |
csi-de-plugin Docker image tag |
<Latest released version e.g. v1.0.0) |
Required |
|
image.csiDePlugin.pullPolicy |
csi-de-plugin image pull policy |
Always |
Required |
|
image.csiAttacher.repository |
csi-attacher Docker image |
registry.k8s.io/sig-storage/csi-attacher |
Required but protected |
|
image.csiAttacher.tag |
csi-attacher Docker image tag |
v4.3.0 |
Required but protected |
|
image.csiAttacher.pullPolicy |
csi-attacher image pull policy |
IfNotPresent |
Required but protected |
|
image.csiResizer.repository |
csi-resizer Docker image |
registry.k8s.io/sig-storage/csi-resizer |
Required but protected |
|
image.csiResizer.tag |
csi-resizer Docker image tag. |
v1.8.0 |
Required but protected |
| image.csiResizer.pullPolicy | csi-resizer image pull policy | IfNotPresent | Required but protected |
| image.nodeDriverRegistrar.repository | csi-node-driver-registrar Docker image. | registry.k8s.io/sig-storage/csi-node-driver registrar | Required but protected |
| image.nodeDriverRegistrar.tag | csi-node-driver-registrar Docker image tag | v2.8.0 | Required but protected |
| image.nodeDriverRegistrar.pullPolicy | csi-node-driver-registrar image pull policy | IfNotPresent | Required but protected |
| image.csiSnapshotter.repository | csiSnapshotter Docker image. | registry.k8s.io/sig-storage/csi-snapshotter | Required but protected |
| image.csiSnapshotter.tag | csiSnapshotter Docker image tag | <Latest Released Version e.g. v6.3.3) | Required but protected |
| image.csiSnapshotter.pullPolicy | csiSnapshotter image pull policy | Always | Required but protected |
| image.externalSnapshotter.repository | externalSnapshotter Docker image | registry.k8s.io/sig-storage/snapshot-controller | Required but protected |
| image.externalSnapshotter.tag | externalSnapshotter Docker image tag | <Latest Released Version e.g. v6.3.3) | Required but protected |
| image.externalSnapshotter.pullPolicy | externalSnapshotter image pull policy | Always | Required but protected |
| image.externalSnapshotter.customResourceDefinitions.enabled | Install crds if not present |
(Default) Setting to true will create: VolumeSnapshot, VolumeSnapshotContent and VolumeSnapshotClass CRDs which enable the taking of snapshots. Set to false if the two CRDs already exist in a K8s cluster. |
Required |
Docker Registry Authentication: The following values describe how to connect to a protected registry. If the Kubernetes Cluster has internet access, then you may provide the credentials to authenticate with Delphix's Docker Registry. Follow the Installation (Online) for more information.
If the Kubernetes Cluster does not have internet access, then these values must be updated with a local registry's information. Follow the Installation (Offline) for more information.
| Parameter | Description | Suggested Values |
Parameter type
|
|---|---|---|---|
|
dockerRegistry.imageCredentials.registry |
Registry to pull Docker images from. |
Required | |
|
dockerRegistry.imageCredentials.username |
Username to log in to the Docker registry. |
<docker-registry-username> |
Required |
| dockerRegistry.imageCredentials.email |
Email address for the Docker registry. |
<docker-registry-email> | Optional |
|
dockerRegistry.imageCredentials.password |
Password to log in to the Docker registry. |
<docker-registry-password> |
Required |
Data Control Tower Connectivity: The following values describe how the Delphix K8s Driver will connect and communicate with Data Control Tower.
| Parameter | Description | Suggested values | Parameter type |
|---|---|---|---|
| dctCreds.dctUrl | URL for the DCT server | <dct-url> | Required |
|
dctCreds.dctKey |
DCT API Key for the DCT server. (e.g. |
<dct-key> *For further information, refer to the additional instructions below this table. |
Required |
|
default.scheme |
Host scheme of the DCT server. (e.g. https/http) |
https |
Required but protected |
|
default.tlsInsecureSkipVerify |
TRUE/FALSE value which determines whether to skip the TLS check. The value of TRUE is insecure and should only be used in safe environments. |
false |
Required but protected |
*The DCT API key is defined in plain text in the values.yaml configuration file. Following Helm chart rendering, the key is securely stored as a Kubernetes Secret with base64 encoding applied.
For enhanced security, instead of putting the API key directly (in plain text) in the values.yaml, you can store the API key in an external key vault. For example, you could install the driver on AKS with the DCT API key stored in Azure Key Vault, retrieve the key from the vault prior to executing the helm install command. The key will then need to be passed to Helm as an in-line parameter using the --set option, as demonstrated in the code sample below. For further details, refer to step number 9 in Installation (Online).
helm install delphix-k8s-driver delphix-k8s-driver-v1.X.X.tgz -f values.yaml --set dctCreds.dctKey=$(az keyvault secret show --vault-name <vault-name> --name <Secret-key> --query value -o tsv)Within the Helm chart, the dctCreds.dctKey field can remain as a blank string in values.yaml and be overridden by the command line parameter above.
Virtual Dataset: The following values describe the source dataset and how the volume will be virtualized. These parameters may be specified in either the values.yaml files for the helm chart or the PVC manifest. The PVC configuration will override the driver's values.yaml configuration.
Default PVC annotations in driver's values.yaml
| Parameter | Description | Suggested values | Parameter type |
|---|---|---|---|
|
default.Annotations.sourceDBName |
Source dataset (dSource or VDB) name or ID to provision from. |
<source-db-name-or-id> |
Optional |
|
default.Annotations.envName |
Environment name or ID of the staging host. |
<env-name> |
Optional |
|
default.Annotations.vdbRepositoryName |
Repository (Installation) name on the staging environment’s host. |
<repository-name> |
Deprecated as of v1.4.0 |
|
default.Annotations.vdbStageMountpath |
VDB mount path on the staging environment’s host. |
<stage-mount-path> |
Deprecated as of v1.4.0
|
|
default.Annotations.vdbGroupName |
The Dataset Group name where the created virtual database will be placed in Delphix Continuous Data. |
<dataset-group-name> |
Optional |
|
default.Annotations.engineName |
Specify the engine where the VDB will be provisioned. |
<engine-hostname-(FQDN)-or-IP> |
Optional |
|
default.Annotations.tags |
Tag the VDB with one or more key-value pairs. (Optional) |
Example: |
Optional |
General PVC annotations in PVC manifest: These parameters go under the metadata.annotations field in the PVC manifest for provisioning a K8s vFiles/PostgreSQL VDB. The optional parameters can be omitted from the manifest or kept blank as “”.
The following parameters apply to all supported data types, such as K8s vFiles, PostgreSQL and Oracle.
| Parameter | Description | Suggested values | Parameter type |
|---|---|---|---|
|
metadata.annotations.sourceDBName |
Source dataset (dSource or VDB) name or ID to provision from. |
<source-db-name> |
Required |
| metadata.annotations.envName | Environment name or ID of the staging host. | <env-name> | Required |
| metadata.annotations.vdbGroupName | The Dataset Group name where the created virtual database will be placed in Delphix Continuous Data. | <group-name> | Required |
| metadata.annotations.engineName | Specify the engine where the VDB will be provisioned. | <engine-hostname-(FQDN)-or-IP> | Required |
| metadata.annotations.tags | Tag the VDB with one or more key-value pairs. | Example: ”key1=value1, key2=value2” | Optional |
| metadata.annotations.ownershipSpec | Default User ID for the container image such as 'postgres' or 'oracle'. | Example: “999:999” | Optional |
| metadata.annotations.isMasked | Provision the K8s VDB as a Masked VDB without specifying the ‘Configure Clone’ hook. Default value is “false” | "true” , “True”, “false”, “False” | Optional |
Oracle annotations in the PVC manifest: In addition to the general PVC annotations above the following PVC annotations are specific PVC annotations for provisioning an Oracle VDB. The Optional parameters can be omitted from the manifest or kept blank as “”
The following parameters only apply to the Oracle data type.
| Parameter | Description | Suggested values | Parameter type |
|---|---|---|---|
|
metadata.annotations. surrEnvUserName |
Name of the primary user for the surrogate host environment on Delphix Engine. |
oracle |
Required |
| metadata.annotations. oracleServiceName | The name of the new Oracle service created on the Kubernetes node for the Oracle deployment within the container pod. | <oracle-service-name> | Required |
| metadata.annotations. oracleSID | The Dataset Group name where the created virtual database will be placed in Delphix Continuous Data. | <oracle-sid> | Optional |
| metadata.annotations. vdbConfigTemplate | Specify an existing VDB config template for Oracle. | <vdb-config-template-name> | Optional |