Helm Chart Values

The values.yaml file provides configuration options for this chart. It contains documentation for the Helm chart values. Some important values are described in more detail below.

NOTE: You can also see all the Helm chart values from the repository by adding the repository to your machine and viewing the helm values.

To add the repository to your machine, run the following command:

helm repo add opentext-idol https://raw.githubusercontent.com/opentext-idol/idol-containers-toolkit/main/helm/distributed-idol

To show the Helm chart values, run the following command:

helm show values opentext-idol/distributed-idol

Required Values

The following table describes required Helm chart values that do not have default values. You must set these values by using one of the --set, --set-file, --set-string, or --values flags in the helm install command:

Value Description
licenseServerIp The IP address of the License Server containing the license key required to run the IDOL components in this chart.
licenseServerPort The port of the License Server containing the license key required to run the IDOL components in this chart.

NOTE: You can also modify the values.yaml file and include the values there if you don't want to specify them as part of the command.

Required Secrets

The following table describes the Helm chart secrets that are required to run the containers:

Secret Description
dockerhub-secret Used to pull images from Docker Hub
cm-adapter-serving-certs

Used for autoscaling, contains a TLS certificate and private key

By default, the Helm chart pulls images from Docker Hub, and it requires a Kubernetes secret called dockerhub-secret. This secret must contain the credentials required to retrieve the images from Docker Hub. You can create this secret by using the following command, substituting your own user name and API token.

kubectl create secret docker-registry dockerhub-secret
--docker-username=${DOCKERHUB_USER}
--docker-password=${DOCKERHUB_APITOKEN}

Access to the IDOL images on dockerhub is restricted to the user microfocusidolreadonly, so this will be the value of ${DOCKERHUB_USER} in the example.

If a different name is required for this Kubernetes secret, override the imagePullSecrets list value.

The cm-adapter-serving-certs secret used by the custom metrics adapter can be generated given certificate and key files by e.g. kubectl create secret generic cm-adapter-serving-certs --from-file=serving.crt --from-file=serving.key. See certgen/README.md directory for a helper script to generate these.

Optional Helm Chart Values

There are some Helm chart values and secrets that are optional:

Value/Secret Description
httpProxy The URL of a HTTP proxy that the installation will have to use to access the external internet. If not set, no http proxying is configured.
imagePullSecrets If a private repository is specified for pulling the IDOL images (i.e. by overriding idolImageRegistry) then imagePullSecrets will also require the name of a Kubernetes secret holding the credentials for pulling from this private repository.