Parameters
caution
This is internal documentation. This document can be used only if it was recommended by the Support Team.
caution
From 23.3 version this document is outdated. Use official Digital.ai documentation.
For deployment on Production environment, all parameters need to be configured as per users requirement and k8s setup which is under use. However, for deployment on test environment, most of the default values will suffice. The following parameters are required to be configured and rest of the parameters may remain as default.
| Parameter | Description |
|---|---|
| xldLicense | License for Digital.ai Deploy in base64 format |
| Persistence.SorageClass | Storage Class to be defined, Network File System (NFS) for OnPremise or Elastic File System (EFS) for AWS Elastic Kubernetes Service(EKS) |
| ingress.hosts | DNS name for accessing UI of Digital.ai Deploy |
| RepositoryKeystore | RepositoryKeystore for Digital.ai Deploy in base64 format |
| KeystorePassphrase | Passphrase for RepositoryKeystore |
The following table lists the configurable parameters of the Digital.ai Deploy chart, and their default values.
| Parameter | Description | Default |
|---|---|---|
| K8sSetup.Platform | Platform on which to install the chart. Allowed values are PlainK8s and AWSEKS | PlainK8s |
| XldMasterCount | Number of master replicas | 3 |
| XldWorkerCount | Number of worker replicas | 3 |
| ServerImageRepository | Image name for the Deploy master | xebialabs/xl-deploy |
| WorkerImageRepository | Image name for the Deploy worker | xebialals/deploy-task-engine |
| ImageTag | Image tag | 9.7 |
| ImagePullPolicy | Image pull policy, Defaults to 'Always' if image tag is 'latest',set to 'IfNotPresent' | Always |
| ImagePullSecret | Specify docker-registry secret names. Secrets must be manually created in the namespace | nil |
| haproxy-ingress.install | Install haproxy subchart. If you have haproxy already installed, set 'install' to 'false' | true |
| haproxy-ingress.controller.kind | Type of deployment, DaemonSet or Deployment | DaemonSet |
| haproxy-ingress.controller.service.type | Kubernetes Service type for haproxy. It can be changed to LoadBalancer or NodePort | NodePort |
| ingress.Enabled | Exposes HTTP and HTTPS routes from outside the cluster to services within the cluster | true |
| ingress.annotations | Annotations for ingress controller | ingress.kubernetes.io/ssl-redirect: "false" kubernetes.io/ingress.class: haproxy ingress.kubernetes.io/rewrite-target: / ingress.kubernetes.io/affinity: cookie ingress.kubernetes.io/session-cookie-name: JSESSIONID ingress.kubernetes.io/session-cookie-strategy: prefix ingress.kubernetes.io/config-backend: ` |
| ingress.path | You can route an Ingress to different Services based on the path | /xl-deploy/ |
| ingress.hosts | DNS name for accessing ui of Digital.ai Deploy | example.com |
| ingress.tls.secretName | Secret file which holds the tls private key and certificate | example-secretsName |
| ingress.tls.hosts | DNS name for accessing ui of Digital.ai Deploy using tls | example.com |
| AdminPassword | Admin password for xl-deploy | If user does not provide password, random 10 character alphanumeric string will be generated |
| xldLicense | Convert xl-deploy.lic files content to base64 | nil |
| RepositoryKeystore | Convert keystore.jks files content to base64 | nil |
| KeystorePassphrase | Passphrase for keystore.jks file | nil |
| resources | CPU/Memory resource requests/limits. User can change the parameter accordingly | nil |
| postgresql.install | Installs postgresql chart with single instance. If you have an existing database deployment, set 'install' to 'false'. | true |
| postgresql.postgresqlUsername | PostgreSQL user (creates a non-admin user when postgresqlUsername is not postgres) | postgres |
| postgresql.postgresqlPassword | PostgreSQL user password | random 10 character alphanumeric string |
| postgresql.postgresqlExtendedConf.listenAddresses | Specifies the TCP/IP address(es) on which the server is to listen for connections from client applications | * |
| postgresql.postgresqlExtendedConf.maxConnections | Maximum total connections | 500 |
| postgresql.initdbScriptsSecret | Secret with initdb scripts that contain sensitive information (Note: can be used with initdbScriptsConfigMap or initdbScripts). The value is evaluated as a template. | postgresql-init-sql-xlr |
| postgresql.service.port | PostgreSQL port | 5432 |
| postgresql.persistence.enabled | Enable persistence using PVC | true |
| postgresql.persistence.size | PVC Storage Request for PostgreSQL volume | 50Gi |
| postgresql.persistence.existingClaim | Provide an existing PersistentVolumeClaim, the value is evaluated as a template. | nil |
| postgresql.resources | CPU/Memory resource requests/limits | Memory: 256Mi, CPU: 250m |
| postgresql.nodeSelector | Node labels for pod assignment | |
| postgresql.affinity | Affinity labels for pod assignment | |
| postgresql.tolerations | Toleration labels for pod assignment | [] |
| UseExistingDB.Enabled | If you want to use an existing database, change 'postgresql.install' to 'false'. | false |
| UseExistingDB.XL_DB_URL | Database URL for xl-deploy | nil |
| UseExistingDB.XL_DB_USERNAME | Database User for xl-deploy | nil |
| UseExistingDB.XL_DB_PASSWORD | Database Password for xl-deploy | nil |
| rabbitmq-ha.install | Install rabbitmq chart. If you have an existing message queue deployment, set 'install' to 'false'. | true |
| rabbitmq-ha.rabbitmqUsername | RabbitMQ application username | guest |
| rabbitmq-ha.rabbitmqPassword | RabbitMQ application password | random 24 character long alphanumeric string |
| rabbitmq-ha.rabbitmqErlangCookie | Erlang cookie | DEPLOYRABBITMQCLUSTER |
| rabbitmq-ha.rabbitmqMemoryHighWatermark | Memory high watermark | 500MB |
| rabbitmq-ha.rabbitmqNodePort | Node port | 5672 |
| rabbitmq-ha.extraPlugins | Additional plugins to add to the default configmap | rabbitmq_shovel, rabbitmq_shovel_management, rabbitmq_federation, rabbitmq_federation_management, rabbitmq_jms_topic_exchange, rabbitmq_management, |
| rabbitmq-ha.replicaCount | Number of replica | 3 |
| rabbitmq-ha.rbac.create | If true, create & use RBAC resources | true |
| rabbitmq-ha.service.type | Type of service to create | ClusterIP |
| rabbitmq-ha.persistentVolume.enabled | If true, persistent volume claims are created | true |
| rabbitmq-ha.persistentVolume.size | Persistent volume size | 20Gi |
| rabbitmq-ha.persistentVolume.annotations | Persistent volume annotations | |
| rabbitmq-ha.persistentVolume.resources | CPU/Memory resource requests/limits | |
| rabbitmq-ha.definitions.policies | HA policies to add to definitions.json | {"name": "ha-all","pattern": ".*","vhost": "/","definition": {"ha-mode": "all","ha-sync-mode": "automatic", "ha-sync-batch-size": 1 } } |
| rabbitmq-ha.definitions.globalParameters | Pre-configured global parameters | {"name": "cluster_name", "value": "" } |
| rabbitmq-ha.prometheus.operator.enabled | Enabling Prometheus Operator | false |
| UseExistingMQ.Enabled | If you want to use an existing Message Queue, change 'rabbitmq-ha.install' to 'false' | false |
| UseExistingMQ.XLD_TASK_QUEUE_USERNAME | Username for xl-deploy task queue | nil |
| UseExistingMQ.XLD_TASK_QUEUE_PASSWORD | Password for xl-deploy task queue | nil |
| UseExistingMQ.XLD_TASK_QUEUE_URL | URL for xl-deploy task queue | nil |
| UseExistingMQ.XLD_TASK_QUEUE_DRIVER_CLASS_NAME | Driver Class Name for xl-deploy task queue | nil |
| HealthProbes | Would you like a HealthProbes to be enabled | true |
| HealthProbesLivenessTimeout | Delay before liveness probe is initiated | 90 |
| HealthProbesReadinessTimeout | Delay before readiness probe is initiated | 90 |
| HealthProbeFailureThreshold | Minimum consecutive failures for the probe to be considered failed after having succeeded | 12 |
| HealthPeriodScans | How often to perform the probe | 10 |
| nodeSelector | Node labels for pod assignment | |
| tolerations | Toleration labels for pod assignment | [] |
| affinity | Affinity labels for pod assignment | |
| Persistence.Enabled | Enable persistence using PVC | true |
| Persistence.StorageClass | PVC Storage Class for volume | nil |
| Persistence.Annotations | Annotations for the PVC | |
| Persistence.AccessMode | PVC Access Mode for volume | ReadWriteOnce |
| Persistence.XldExportPvcSize | XLD Master PVC Storage Request for volume. For production grade setup, size must be changed | 10Gi |
| Persistence.XldWorkPvcSize | XLD Worker PVC Storage Request for volume. For production grade setup, size must be changed | 5Gi |