DevOps Plan Helm chart reference

Information about using the DevOps Plan Helm chart.

The following reference details the DevOps Plan Helm chart and the configuration options that are available for deploying DevOps Plan on Kubernetes.

It is recommended that you do not modify the default values.yaml configuration file for your deployment. Create a copy to use as your customized values file, for example, my-values.yaml. Creating a copy to customize will allow you to maintain your customized values for future deployments and upgrades.

The Helm chart has the following values that can be overridden by using the --set parameter command or specified by using -f my-values.yaml

Table 1. DevOps Plan Helm Chart Common Parameters
Parameter Description Default value
global.image.pullSecrets Array of your own secrets with credentials to HCL's docker repository. You must use this when control.enabled is set to true. ""
global.imageRegistry DevOps Plan docker image registry. cp.icr.io
global.licenseMetric DevOps Plan license metrics for concurrent users. false
global.passwordSeed PasswordSeed for the Keycloak and PostgreSQL password. ""
global.persistence.rwoStorageClass The global storageClassName with ReadWriteOnce access mode. ""
global.persistence.rwxStorageClass The global storageClassName with ReadWriteMany access mode. ""
replicaCount Number of replicas to deploy an instance of the DevOps Plan RESTful service. 1
image.repository DevOps Plan docker image repository path. cp/devops-plan/devopsplan
image.tag DevOps Plan image tag. 3.0.4
image.pullPolicy DevOps Plan image pull policy. Accepted values are:
  • IfNotPresent
  • Always
 IfNotPresent
hostname DevOps Plan Docker container hostname. devopsplan
timeZone DevOps Plan server Time Zone. It can be set based on a list of supported time zones and abbreviations. EST5EDT
serverQualifiedUrlPath If defined, overrides the mapping URL in the DevOps Plan application.properties file. For example: "https://[MAPPING_NAME].com" ""
service.type Service type. It can be set to ClusterIP, LoadBalancer, or NodePort. CliusterIP
service.exposePort Service expose port. ""
ingress.enabled Ingress service. True enables the ingress service. False disables the ingress service. Accepted values are:
  • true
  • false
 true
ingress.type Ingress service type. Accepted values are nginx, route, mapping. route
hosts List of hosts for the ingress service. devopsplan.ibm.com
swagger.enabled Enables or disables Swagger UI visibility. True enables Swagger UI visibility. False disables Swagger UI visibility. Accepted values are:
  • true
  • false
 false
Table 2. SMTP Server Parameters
Parameter Description Default value
global.platform.smtp.host SMTP server host ""
global.platform.smtp.port SMTP server port number ""
global.platform.smtp.username SMTP server username ""
global.platform.smtp.password SMTP server password ""
global.platform.smtp.sender The SMTP sender email address that must be delivered from the on-boarding process ""
global.platform.smtp.startTLS Sets the mail server to secure protol using TLS or SSL. True sets the protocol to TLS or SSL. False sets unsecure protocol. false
global.platform.smtp.smtps Sets the mail server protocol. True sets the protocol to SMTPS. False sets the protocol to SMTP. false

You must set SSL parameters to install SSL certificates. For more information, see Installing the SSL certificate.

Table 3. SSL Parameters.
Parameter Description Default value
ssl.enabled Enables installing DevOps Plan SSL certificate. Accepted values are:
  • true: enables installing SSL certificate.
  • false: disables installing SSL certificate.
 false
ssl.password Keystore password. This parameter is required if ssl.enabled=true. ""
ssl.keyAlias Keystore alias. 1
ssl.configMapName This is the configMap file name that contains the SSL certificate keystore.p12 file. This parameter is required if ssl.enabled=true. keystore-file