Skip to main content
Version: Release 24.3

Installation Options Reference for Digital.ai Release with Runner

  • Here's a list of questions that you would have to answer to install Digital.ai Release or Runner using the xl kube install command.
  • Some of the questions are common for Release and Runner, and some are only relevant for Release or Runner and has been called out in the descriptions accordingly.
  • You must select one of the available options for some of the questions.
  • Use the arrow keys to move up or down and press enter to select an option.

Important: We highly recommend you to go through the xl kube workshop to gain a comprehensive understanding on how to install or upgrade Digital.ai Release or Runner on a kubernetes cluster.

Release Installation Options Reference

Here's a list of questions that you would have to answer to install Digital.ai Release or Runner using the xl kube install command.

Important: The following questions will help you to install the Digital.ai Release separately or Digital.ai Release Runner as a part of the Digital.ai Release installation. To learn more about installing the Digital.ai Release Runner separately, see Installation Options Reference for Digital.ai Release Runner

Here's the list of questions

Confirm the kubectl Context

Prompt? Following kubectl context will be used during execution: <kubectl-context/username>? (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valueskubectl current context
Default valuekubectl current context
RemarksConfirm the kubectl context to proceed.

Choose a Kubernetes Platform

Prompt? Select the Kubernetes setup where the Digital.ai Devops Platform will be installed, updated or cleaned:
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesOpenshift [Openshift]
AWSEKS [AWS EKS]
PlainK8s [Plain multi-node K8s cluster]
AzureAKS [Azure AKS]
GoogleGKE [Google Kubernetes Engine]
Default value-
RemarksYou must have your cluster ready before you select an answer for this prompt.

Choose a Kubernetes Namespace

Important: If you want to enable the TLS protocol in your cluster, you must have the TLS secret created in the namespace before you start the installation or upgrade. This means that you must have created the namespace and the TLS secret already. Use the same namespace when you answer this prompt.

Prompt? Do you want to use an custom Kubernetes namespace (current default is digitalai): [? for help] (y/N)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valuedigitalai
RemarksType the name of a custom namespace where you want to install or upgrade Release or go with the default namespace, which is digitalai.
If you are going to enable the TLS protocol in your cluster, you must have created the namespace and the TLS secret already. Use the same namespace where you have the TLS secret created.

Choose the Product to Install

Prompt? Product server you want to perform install for [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesdai-release [Digital.ai Release with optional Runner]
dai-deploy [Digital.ai Deploy]
dai-release-remote-runner [Digital.ai Release Runner]
Default value-
RemarksSelect a product—dai-release [Digital.ai Release with optional Runner]

Select Type of Image Registry

Note: You can choose a custom public or private registry, which can be used to perform the setup of Release from a custom image registry and image repository. For more information, see Setup Custom Image Registry

PromptSelect type of image registry (current default is default): [? for help] (xebialabs)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesdefault [Default (Uses various public image registries for the installation images)]
public [Custom Public Registry (Uses a specific custom registry)]
private [Custom Private Registry - Password protected (Uses a specific custom registry with password)]
Default valuedefault [Default (Uses various public image registries for the installation images)]
RemarksType the image repository. It is recommended to go with the default, which is xebialabs.

Enter the Repository Name

Prompt? Enter the repository name for the application and operator images (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): [? for help] (xebialabs)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valuexebialabs
RemarksType the repository name. It is recommended to go with the default, which is xebialabs

Enter the Image Name

Prompt? Enter the image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesxl-release
Default valuexl-release
RemarksType the name of the image you want to use for installation.

Enter the Image Tag

The xl kube install and xl kube upgrade options reference let you go with the default (latest) docker image tags available when you install or upgrade Digital.ai Release or Runner. However, here are the Docker Hub links to verify all the available image tags.

Prompt? Enter the application image tag (eg: <tagName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueThe latest Release is available in the repository, for example, 23.3.0
RemarksType the product version number you want to install, for example, 23.3.0 or 23.3.1.

Enter the Product License

Prompt? Select source of the license: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesgenerate [Generate the license (this is only for temporary license that is used for evaluation)]
file [Path to the license file (the file can be in clean text or base64 encoded)]
editor [Copy/Paste the license to editor (the text can be in clean text or base64 encoded)]
Default valuegenerate
RemarksYou can either choose to type in the path to the license file (for example, /home/my_home/xl-release-license.lic) or choose to copy and paste the license information in the editor.
The license file can be in plain text format or in base64 encoded format. The generated license is a temporary evaluation license.
Prompt? Provide license file for the server: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesN/A
Default value-
RemarksIf you select a file input type for the license. Type in the path to the license file (for example, /home/my_home/xl-release-license.lic)

Enable Security Context Constraints (SCCs)

Prompt? Do you want to enable Security Context Constraints (SCCs)? (y/N)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
NoNoNoYesNo
Available valuesYes/No
Default valueNo
RemarksSCCs are disabled by default. If upgrading from a setup where SCCs are enabled, select 'Yes' to retain the configuration or manually configure SCCs to avoid pod failures.

Enter the Release Server Replica Count

Prompt? Enter the release server replica count: [? for help] (3)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value3
RemarksType the number of Release server replicas you want.

Enter the PVC Size for Release

Prompt? Enter PVC size for Release (Gi): [? for help] (8)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value8
RemarksType the persistent volume claim (PVC) size for Release.

Select Access Modes

Prompt? Select between supported Access Modes: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesReadWriteOnce [ReadWriteOnce]
ReadWriteMany [ReadWriteMany]
Default value for ReleaseReadWriteMany [ReadWriteMany]
RemarksSelect the access mode. For the Release pods is enough ReadWriteMany, so the selected storage class must minimally support selected access mode.

Tip: Before you enable HTTP2 for Release, you must understand its prerequisites. For detailed information and understanding, read through the Enable HTTP2 to Install Digital.ai Release on Kubernetes Cluster page.

Important: If you want to enable the HTTP2, you must create the keystore file in pkcs12 (p12) format before you start the installation or upgrade. Additionally, you must create a secret, if you are going to use the secret to provide the keystore file. For more information, see the Configuring Keystore for Release Server to Enable HTTP2 section in Enable HTTP2 to Install Digital.ai Release on Kubernetes Cluster page.

Select the Storage Class

Prompt? Provide storage class for the server: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesList that is set up on cluster by the cluster administrator
Default valueAs set up by the cluster administrator
RemarksSelect a storage class that you want to use for Digital.ai Release. The selected storage class must support selected access mode.

Select Resource Values

Prompt? Select source of the resource values (CPU and memory):
Available values

preset [Predefined resource values]
editor [Custom resource values]
none [None]

Default valuenone
RemarksYou can choose to enter the resources values either as a preset or define the custom resources values through the editor. If none is selected, resources will not be specified and has to be updated manually.

Note: Based on the selection, the resource values are prompted during installation. For example, if you select a preset, the following prompts for resource values will follow the preset configuration. Similarly, if you select custom resource values, the prompts will be based on the custom editor settings.

Enter Preset Resource Values Specific to Release Server

Prompt? Select one of the predefined resource values for Release server:
Available values

nano [Request - 500m cpu, 1Gi memory. Limit - 1.0 cpu, 2Gi memory]
micro [Request - 1.0 cpu, 2Gi memory. Limit - 2.0 cpu, 4Gi memory]
small [Request - 2.0 cpu, 5Gi memory. Limit - 4.0 cpu, 8Gi memory]
medium [Request - 5.0 cpu, 10Gi memory. Limit - 8.0 cpu, 16Gi memory]
large [Request - 10.0 cpu, 21Gi memory. Limit - 16.0 cpu, 32Gi memory]
xlarge [Request - 21.0 cpu, 42Gi memory. Limit - 32.0 cpu, 64Gi memory]
2xlarge [Request - 42.0 cpu, 85Gi memory. Limit - 64.0 cpu, 128Gi memory]

Default valuenano
RemarksThis question appears only when you select source of resource values as preset. You can choose to select any one of the resource presets.

Enter Custom Resource Values Specific to Release Server

Important: This prompt appears only when you select source of resource values as Custom resource values.

Prompt? Provide resource allocation for Release server:
Available valuesNA
Default value

resources: requests: cpu: memory: limits: cpu: memory:

RemarksYou can enter the resources requests and limits values here.

Select Ingress Type

Prompt? Select between supported ingress types: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

route [Openshift Route]
nginx [NGINX]
haproxy [HAProxy]
external [External - IngressClass resource should already exist]
none [None - Ingress will not be set up during installation]

Default value

nginx [NGINX]
in case of Openshift route [Openshift Route]

Remarks

Select one of the ingress controllers—nginx or haproxy.
You can also choose not to set up the ingress controller at the time of installation or choose to use an external ingress controller.
When HTTP2 is enabled, select external. Note that, the IngressClass resource must be available to handle HTTP2 backends.

No ingress controller needed, if you were to use an OpenShift cluster, in that case, you can use Openshift route resource.  

Enter Preset Resource Values Specific to Nginx Ingress

Prompt? Select one of the predefined resource values for Nginx ingress:
Available values

nano [Request - 100m cpu, 128Mi memory. Limit - 150m cpu, 192Mi memory]

micro [Request - 250m cpu, 256Mi memory. Limit - 375m cpu, 384Mi memory]
small [Request - 500m cpu, 512Mi memory. Limit - 750m cpu, 768Mi memory]
medium [Request - 500m cpu, 1024Mi memory. Limit - 750m cpu, 1536Mi memory]
large [Request - 1.0 cpu, 2048Mi memory. Limit - 1.5 cpu, 3072Mi memory]
xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 3.0 cpu, 6144Mi memory]
2xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 6.0 cpu, 12288Mi memory]

Default valuenano
RemarksThis question appears only when you select source of resource values as preset. You can choose to select any one of the resource presets.

Enter Custom Resource Values Specific to Nginx Ingress

Important: This prompt appears only when you select source of resource values as Custom resource values.

Prompt? Provide resource allocation for Nginx ingress:
Available values NA
Default value

resources: requests: cpu: memory: limits: cpu: memory:

Remarks

You can enter the resources requests and limits values here.

Enter Custom Resource Values Specific to HAproxy Ingress

Prompt? Provide resource allocation for HAProxy ingress:
Available valuesNA
Default value

resources: requests: cpu: memory: limits: cpu: memory:

Remarks

You can enter the resources requests and limits values here.

Select Ingress Protocol

Prompt

? Select ingress protocol: [Use arrows to move, type to filter, ? for more help]

Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

http [HTTP - not encrypted]
https [HTTPS - enable a TLS/SSL ingress configuration]

Default valuehttp [HTTP - not encrypted]
RemarksThis is prompted when the ingress type is not none.

Enter the Domain Name

Prompt? Provide DNS name for accessing UI of the server: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
Remarks

Type the domain name for accessing the Digital.ai Release server. For example, xlr-operator.apps.opcluster.p1.openshiftapps.com

Enter the Administrator Password

Prompt? Provide administrator password: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueRandomly generated administrator password.
Remarks

A default password is generated randomly and you can use it if you choose to, in which case you must copy the password and keep it handy.
You can also type your own administrator password at the prompt.

Select the OIDC Configuration

Prompt

? Type of the OIDC configuration: [Use arrows to move, enter to select, type to filter, ? for more help]

Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

external [External OIDC Configuration]
identity-service [Identity Service Configuration]
no-oidc [No OIDC Configuration]

Default valueno-oidc [No OIDC Configuration]
Remarks

Choose one of the options based on the OIDC authentication setup you have or want to have.

For more information, see:

Enter the Operator Image Name to Use

Prompt? Enter the operator image to use (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueThe latest image from the Digital.ai repository, for example, release-operator
RemarksType the Kubernetes Operator Docker Hub image name you want to use.
By default, the latest image for the product — Release — release-operator

Enter the Operator Image Tag to Use

Prompt? Enter the operator image to use (eg: <tageName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueThe latest image from the Digital.ai repository, for example, 23.3.0
RemarksType the Kubernetes Operator Docker Hub image tag you want to use.
By default, the latest image for the product — Release — which you install—would be used.
Example: 23.3.0

Select the Java Repository Keystore

Prompt

? Select source of the repository keystore: [Use arrows to move, enter to select, type to filter, ? for more help]

Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

generate [Generate the repository keystore during installation (you need to have keytool utility installed in your path)]
file [Path to the repository keystore file (the file can be in the raw format or base64 encoded)]
editor [Copy/Paste the repository keystore to editor (the content needs to be base64 encoded)]

Default value

generate [Generate the repository keystore during installation (you need to have keytool utility installed in your path)]

Remarks

Select if you want to generate a new JDK keystore file or use an existing one. The default is to generate a new JDK keystore.
If you have an existing keystore file, you can either choose to type in the path to the repository keystore file or copy and paste the keystore file in the editor.

Prompt? Provide repository keystore for the server: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value-
Remarks

If you select a file input type for the keystore. Type in the path to the keystore file (for example, /opt/kestore/daid)

Enter the Keystore Passphrase

Prompt? Provide keystore passphrase: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueA randomly generated password.
Remarks

Type a password for the JDK repository keystore.
A random password is auto-generated by default.
Copy the auto-generated password and keep it safe if you were to use the auto-generated password.

Create New PostgreSQL Server? Or Use Existing One?

Prompt? Do you want to install a new PostgreSQL on the cluster: [? for help] (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueYes
Remarks

Type Yes to install a new PostgreSQL database server in your cluster or No to use an existing PostgreSQL server.
If you enter No, you will need to provide connection parameters for the Release, check Using an Existing PostgreSQL Database

Select the PostgreSQL Storage Class

Prompt? Storage Class to be defined for PostgreSQL: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesAs set up by the cluster administrator
Default valueAs set up by the cluster administrator
RemarksIf you selected a new PostgreSQL, you need to select a storage class that you want to use for PostgreSQL. The storage class needs to support minimally ReadWriteOnce access mode.

Enter the PostgreSQL PVC size

Prompt? Provide PVC size for PostgreSQL (Gi): [? for help] (8)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value8
RemarksIf you selected a new PostgreSQL, you need to type the persistent volume claim for PostgreSQL. The default is 8.

Enter Preset Resource Values Specific to PostgreSQL

Prompt? Select one of the predefined resource values for Postgresql:
Available values

nano [Request - 100m cpu, 128Mi memory. Limit - 150m cpu, 192Mi memory]

micro [Request - 250m cpu, 256Mi memory. Limit - 375m cpu, 384Mi memory]
small [Request - 500m cpu, 512Mi memory. Limit - 750m cpu, 768Mi memory]
medium [Request - 500m cpu, 1024Mi memory. Limit - 750m cpu, 1536Mi memory]
large [Request - 1.0 cpu, 2048Mi memory. Limit - 1.5 cpu, 3072Mi memory]
xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 3.0 cpu, 6144Mi memory]
2xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 6.0 cpu, 12288Mi memory]

Default value nano
Remarks

This question appears only when you select source of resource values as preset. You can choose to select any one of the resource presets.

Enter Custom Resource Values Specific to PostgreSQL

Important: This prompt appears only when you select source of resource values as Custom resource values.

Prompt? Provide resource allocation for Postgresql:
Available values NA
Default value

resources: requests: cpu: memory: limits: cpu: memory:

Remarks

You can enter the resources requests and limits values here.

Create New RabbitMQ Server? Or Use Existing One?

Prompt? Do you want to install a new RabbitMQ on the cluster: [? for help] (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueYes
Remarks

Type Yes to install a new RabbitMQ server in your cluster or No to use an existing RabbitMQ server.
If you enter No, you will need to provide connection parameters for the Release, check Using an Existing Message Queue

Enter the RabbitMQ Replica Count

Prompt? Replica count to be defined for RabbitMQ: [? for help] (3)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value3
RemarksIf you select a new RabbitMQ, type the number of replicas you need for RabbitMQ server.

Select the RabbitMQ Storage Class

Prompt? Storage Class to be defined for RabbitMQ: [Use arrows to move, enter to select, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesAs set up by the cluster administrator
Default valueAs set up by the cluster administrator
RemarksIf you select a new RabbitMQ, select a storage class that you want to use for RabbitMQ. The storage class needs to support minimally ReadWriteOnce access mode.

Enter the RabbitMQ PVC Size

Prompt? Provide PVC size for RabbitMQ (Gi): [? for help] (8)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value8
RemarksIf you select a new RabbitMQ, type the persistent volume claim for RabbitMQ. The default is 8.

Enter Preset Resource Values Specific to RabbitMQ

Prompt?Select one of the predefined resource values for Rabbitmq:
Available values

nano [Request - 100m cpu, 128Mi memory. Limit - 150m cpu, 192Mi memory]

micro [Request - 250m cpu, 256Mi memory. Limit - 375m cpu, 384Mi memory]
small [Request - 500m cpu, 512Mi memory. Limit - 750m cpu, 768Mi memory]
medium [Request - 500m cpu, 1024Mi memory. Limit - 750m cpu, 1536Mi memory]
large [Request - 1.0 cpu, 2048Mi memory. Limit - 1.5 cpu, 3072Mi memory]
xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 3.0 cpu, 6144Mi memory]
2xlarge [Request - 1.5 cpu, 4096Mi memory. Limit - 6.0 cpu, 12288Mi memory]

Default value nano
Remarks

This question appears only when you select source of resource values as preset. You can choose to select any one of the resource presets.

Enter Custom Resource Values Specific to RabbitMQ

Prompt?Provide resource allocation for Rabbitmq:
Available valuesNA
Default value

resources: requests: cpu: memory: limits: cpu: memory:

Remarks

This question appears only when you select source of resource values as preset. You can choose to select any one of the resource presets.

Enable HTTP2

Prompt? Do you want to enable http2 for release: [? for help] (y/N)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNo
Remarks

Select Yes to enable HTTP2 or No otherwise. The default is No. If you want to enable HTTP2, keep the server keystore secret handy to enter at the next prompt.
For the Release server to start with HTTP2, an external ingress type needs to be selected. Additionally, an IngressClass resource must be configured to handle HTTP2 backend of the Release server.

Important: The next 4 prompts are enabled when you enable Http2 to install Release.

Select Source of the Keystore

Before you complete this step, see the Configuring Keystore for Release Server to Enable HTTP2 section in Enable HTTP2 to Install Digital.ai Release on Kubernetes Cluster page.

Prompt Select source of the keystore for the server: [Use arrows to move, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

file [Path to the keystore file (the file can be in the raw format or base64 encoded)]
editor [Copy/Paste the keystore to editor (the content needs to be base64 encoded)]
secret [Generic Secret containing keystore file with key as ssl-keystore.p12].

Default valuefile [Path to the keystore file (the file can be in the raw format or base64 encoded)]
Remarks

If you have an existing keystore file in p12 format, you can either choose to type in the path of the Release server keystore file.
Copy and paste the base64 encoded string of keystore file in the editor.
Select the generic secret created for the ssl-keystore.p12 file

Keystore File for the Server

Important: The keystore file must be in pkcs12 (p12) format.

Prompt? Provide keystore file for the server: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
Remarks

A keystore file for the server is used to securely store the private keys. Here, it indicates that the keystore file for the server is received.

Tip: The keystore password and keystore key passphrase are generated after running the openssl command. Keep these handy. For more information, see the see the Create Keystore and Certificate Using OpenSSL section in Enable HTTP2 to Install Digital.ai Release on Kubernetes Cluster page.

Server Keystore Password

Prompt? Provide the server keystore password: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
Remarks

A server keystore password is used to protect the keystore file and its contents from unauthorized access. Here, enter the server keystore password.

Server Keystore Key Passphrase

Note: This step is optional.

Prompt? Provide the server keystore key passphrase: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
RemarksA server keystore key passphrase is required only if provided during keystore file creation. Here, enter the server keystore key passphrase.

Enable TLS/SSL

Important: If you want to enable the TLS protocol in your cluster, you must have the TLS secret created in the namespace before you start the installation or upgrade. This means that you must have created the namespace and the TLS secret already. Use the same TLS secret when you answer this prompt.

Prompt

? Do you want to enable an TLS/SSL configuration (if yes, requires existing TLS secret in the namespace): [? for help] (y/N)

Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesNoYes
Available valuesNA
Default valueNA
Remarks

Type Yes to enable TLS/SSL or No otherwise. The default is No. If you want to enable TLS/SSL, keep the TLS secret handy to enter at the next prompt.

Prompt? Provide the TLS secret name with the key and certificate: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesNoYes
Available valuesThe list of secrets available in the selected namespace.
Default value-
Remarks

Input the TLS secret. Check the Configure SSL/TLS — Release - Step 3—Create Secret

Important: The next prompts are specific to installing Release Runner. With XL CLI, it is possible to install Release runner in 2 ways. One is as part of the Release installation, and the other is to install the Release runner separately. For more information, on how to install Release runner separately, see Installation Options Reference for Digital.ai Release Runner.

Install remote-runner as part of Release installation

Prompt? Install Digital.ai Release Runner: [Use arrows to move, type to filter, ? for more help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available values

no-install [Don't install Digital.ai Release Runner]
local-install [Install Release Runner from local setup]
cluster-install [Install Release Runner on the cluster]

Default valueno-install [Don't install Digital.ai Release Runner]
RemarksType yes to install the Digital.ai Release Runner. The installation will start after Release is ready on the cluster.

Enter the Release Runner Repository Name

Prompt? Enter the Release Runner repository name (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): [? for help] (xebialabs)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valuexebialabs
RemarksType the repository name. It is recommended to go with the default, which is xebialabs

Enter the Release Runner Image Name

Prompt? Enter the Release Runner image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesrelease-runner
Default valuerelease-runner
RemarksType the name of the image you want to use for installation.

Enter the Image Tag

The xl kube install and xl kube upgrade options reference let you go with the default (latest) docker image tags available when you install or upgrade Digital.ai Release or Runner. However, here are the Docker Hub links to verify all the available image tags.

Prompt? Enter the Release Runner image tag (eg: <tagName> from <repositoryName>/<imageName>:<tagName>): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueThe latest Release is available in the repository, for example, 23.3.0
RemarksType the product version number you want to install, for example, 23.3.0 or 23.3.1.

Use default version of the Release Runner helm chart

Prompt? Use default version of the Release Runner helm chart: [? for help] (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesYes/No
Default valueYes
Remarks

Type yes to use the default internal version of the Release Runner helm chart. Otherwise, you need to provide the path to the helm chart.

Enter the Release Runner Helm Chart release name

Prompt? Enter the Release Runner Helm Chart release name: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueremote-runner
RemarksEnter the Release Runner helm chart release name.

Source of the Release Runner Helm Chart

Prompt? Use default version of the Release Runner helm chart: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesYes/No
Default valueYes
RemarksIf selected Yes it is using the Release Runner provided with blueprints. If No you need to download the helm chart and reference through the path in the next question.

Enter the Release Runner Helm Chart path

Prompt? Enter the Release Runner Helm Chart path (URL or local path): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
RemarksEnter the Helm chart path of the Release runner. Use helm chart from release-remote-runner-helm-chart

Provide Release Runner User Email

Prompt? Provide release-runner user email (for the user on the Release to send PAT expiration notifications): [? for help] (release-runner@no.reply)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valuerelease-runner@no.reply
Remarks

Email address of the Release user to send PAT expiration notifications.

Provide Release Runner User Password

Prompt? Provide release-runner user password (user on the Release): [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
Remarks

Password of the Release user.

//token exp

Enter the Release Runner replica count

Prompt? Enter the Release Runner replica count: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default value1
RemarksEnter the Release Runner replica count.

Enable Truststore for Release Runner

Prompt? Enable truststore for Release Runner: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesYes/No
Default valueNo
RemarksEnable truststore for Release Runner.

Enter the Release Token used by Release Runner

Note: This question is asked during the installation process only when you already have a Release instance running.

Prompt? Enter the Release Token that will be used by Release runner: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
RemarksEnter the Release Token that will be used by Release runner. This is specific to Release Runner.

Enter the Release URL used by Release Runner

Note:

  • This question is asked during the installation process only when you already have a Release instance running.
  • If you're installing runner as part of Release installation, the Runner instance will automatically take the URL of the Release instance being installed.
Prompt? Enter the Release URL that will be used by the release runner: [? for help]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
Remarks

Enter the Release URL that will be used by Release runner. This is specific to Release Runner.

Once you are done answering the questions, the installer provides a summary of the installation choices you made. Here's an example.

Install Install

It then proceeds with the installation by applying the resources to the cluster and completes the installation of the product. Here's an example.

Install