Helm chart configuration parameters#
The Helm chart has the following values that can be overridden using the --set parameter.
Qualifier | Parameter | Definition | Allowed Value |
---|---|---|---|
image | pullPolicy | Image Pull Policy | Always, Never, or IfNotPresent. Defaults to Always |
repository | Name of image, including repository prefix (if required) | See Extended description of Docker tags | |
tag | Docker image tag | See Docker tag description | |
secret | An image pull secret used to authenticate with the image registry | Empty (default) if no authentication is required to access the image registry. | |
service | type | Specify type of service | Valid options are NodePort and LoadBalancer (for clusters that support LoadBalancer). Default is NodePort |
database | type | The type of database UCD will connect to | Valid values are db2, mysql, mariadb, oracle, and sqlserver |
name | The name of the database to use | ||
hostname | The hostname/IP of the database server | ||
port | The database port to connect to | ||
username | The user to access the database with | ||
password | The password of the database user | ||
secureConnections | required | Specify whether UCD server connections are required to be secure | Default value is "true" |
security | ucdInitPassword | The admin password for the UCD UI | Default value is "admin" |
extLibVolume | name | The base name used when the Persistent Volume and/or Persistent Volume Claim for the extlib directory is created by the chart. | Default value is "ext-lib" |
storageClassName | The name of the storage class to use when persistence.useDynamicProvisioning is set to "true". | ||
size | Size of the volume used to hold the JDBC driver .jar files | ||
existingClaimName | Persistent volume claim name for the volume that contains the JDBC driver file(s) used to connect to the UCD database. | ||
configMapName | Name of an existing ConfigMap which contains a script named script.sh. This script is run before UrbanCode Deploy server installation and is useful for copying database driver .jars to a Persistent Volume. | ||
persistence | enabled | Determines if persistent storage will be used to hold the UCD server appdata directory contents. This should always be true to preserve server data on container restarts. | Default value "true" |
useDynamicProvisioning | Set to "true" if the cluster supports dynamic storage provisoning | Default value "false" | |
confVolume | name | The base name used when the Persistent Volume and/or Persistent Volume Claim for the UCD server appdata directory is created by the chart. | Default value is "conf" |
existingClaimName | The name of an existing Persistent Volume Claim that references the Persistent Volume that will be used to hold the UCD server appdata directory. | ||
storageClassName | The name of the storage class to use when persistence.useDynamicProvisioning is set to "true". | ||
size | Size of the volume to hold the UCD server appdata directory | ||
resources | constraints.enabled | Specifies whether the resource constraints specified in this helm chart are enabled. | false (default) or true |
limits.cpu | Describes the maximum amount of CPU allowed | Default is 2000m. See Kubernetes - meaning of CPU | |
limits.memory | Describes the maximum amount of memory allowed | Default is 2Gi. See Kubernetes - meaning of Memory | |
requests.cpu | Describes the minimum amount of CPU required - if not specified will default to limit (if specified) or otherwise implementation-defined value. | Default is 1000m. See Kubernetes - meaning of CPU | |
requests.memory | Describes the minimum amount of memory required If not specified, the memory amount will default to the limit (if specified) or the implementation-defined value | Default is 1Gi. See Kubernetes - meaning of Memory | |
serverHostPort | UCD server hostname and JMS port in the form hostname:port. If specifying failover info, separate multiple hostname:port with a comma. For example, ucd1.example.com:7918,ucd2.example.com:7918) | ||
limits.cpu | Describes the maximum amount of CPU allowed | Default is 2000m. See Kubernetes - meaning of CPU | |
codeStationReplication | enabled | Specify true to enable artifact caching on the relay. | |
persisted | Specify true to persist the artifact cache when the relay container is restarted. | ||
serverUrl | The full URL of the central server to connect to, such as https://myserver.example.com:8443. | ||
serverPassword | An authentication token from the server. | ||
maxCacheSize | The size to which to limit the artifact cache, such as 500M for 500 MB or 5G for 5 GB. To not put a limit on the cache, specify none. | ||
geotags | If you choose to cache files on the relay, you can specify one or more component version statuses here, separated by semicolons. The agent relay automatically caches component versions with any of these statuses so that those versions are ready when they are needed for a deployment. A status can contain a space except in the first or last position. A status can contain commas. The special * status replicates all artifacts, but use this status with caution, because it can make the agent relay store a large amount of data. If no value is specified, no component versions are cached automatically. | ||
readinessProbe | initialDelaySeconds | Number of seconds after the container has started before the readiness probe is initiated | Default is 30 |
periodSeconds | How often (in seconds) to perform the readiness probe | Default is 30 | |
failureThreshold | When a Pod starts and the probe fails, Kubernetes will try this number times before giving up. In the case of the readiness probe, the Pod will be marked Unready. | Default is 10 | |
livenessProbe | initialDelaySeconds | Number of seconds after the container has started before the liveness probe is initiated | Default is 300 |
periodSeconds | How often (in seconds) to perform the liveness probe | Default is 300 | |
failureThreshold | When a Pod starts and the probe fails, Kubernetes will try this number times before giving up. Giving up in the case of the liveness probe means restarting the Pod. | Default is 3 |
Parent topic: Installing the server in a Kubernetes cluster