Installation Options Reference for Digital.ai Release with Remote Runner
- Here's a list of questions that you would have to answer to install Digital.ai Release or Remote Runner using the xl kube install command.
- While some of the following questions are common for Release and Remote Runner, some are relevant only for Release or Remote Runner and that 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 Remote Runner on a kubernetes cluster and how it can benefit you.
Release Installation Options Reference
Here's a list of questions that you would have to answer to install Digital.ai Release or Remote 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 Remote Runner as a part of the Digital.ai Release installation. To learn more about installing the Digital.ai Release Remote Runner separately, see Installation Options Reference for Digital.ai Release Remote 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | kubectl current context | |||||
| Default value | kubectl current context | |||||
| Remarks | Confirm 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | Openshift [Openshift] AWSEKS [AWS EKS] PlainK8s [Plain multi-node K8s cluster] AzureAKS [Azure AKS] GoogleGKE [Google Kubernetes Engine] | |||||
| Default value | - | |||||
| Remarks | You 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | digitalai | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | dai-release [Digital.ai Release with optional Remote Runner] dai-deploy [Digital.ai Deploy] dai-release-remote-runner [Remote Runner for Digital.ai Release] | |||||
| Default value | - | |||||
| Remarks | Select a product—dai-release [Digital.ai Release with optional Remote 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
| Prompt | Select type of image registry (current default is default): [? for help] (xebialabs) | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | default [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 value | default [Default (Uses various public image registries for the installation images)] | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | xebialabs | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | xl-release | |||||
| Default value | xl-release | |||||
| Remarks | Type 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 Remote 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | The latest Release is available in the repository, for example, 23.3.0 | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | generate [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 value | generate | |||||
| Remarks | You 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | N/A | |||||
| Default value | - | |||||
| Remarks | If 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) | |||||
Enter the Release Server Replica Count
| Prompt | ? Enter the release server replica count: [? for help] (3) | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 3 | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 8 | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | ReadWriteOnce [ReadWriteOnce] ReadWriteMany [ReadWriteMany] | |||||
| Default value for Release | ReadWriteMany [ReadWriteMany] | |||||
| Remarks | Select 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.
Enable HTTP2
| Prompt | ? Do you want to enable http2 for release: [? for help] (y/N) | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | No | 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| 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 value | file [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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| 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
opensslcommand. 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| Remarks | A server keystore key passphrase is required only if provided during keystore file creation. Here, enter the server keystore key passphrase. | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| 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. | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | No | Yes | ||
| Available values | NA | |||||
| Default value | No | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | No | Yes | ||
| Available values | The 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 | |||||
Enter the Domain Name
| Prompt | ? Provide DNS name for accessing UI of the server: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | Randomly 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | external [External OIDC Configuration] identity-service [Identity Service Configuration] no-oidc [No OIDC Configuration] | |||||
| Default value | no-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:
- for Release: Select the Type of OIDC Configuration.
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | The latest image from the Digital.ai repository, for example, release-operator | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | The latest image from the Digital.ai repository, for example, 23.3.0 | |||||
| Remarks | Type 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | N/A | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | A 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. | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | List that is set up on cluster by the cluster administrator | |||||
| Default value | As set up by the cluster administrator | |||||
| Remarks | Select a storage class that you want to use for Digital.ai Release. The selected storage class must support selected access mode. | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | Yes | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | As set up by the cluster administrator | |||||
| Default value | As set up by the cluster administrator | |||||
| Remarks | If 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 8 | |||||
| Remarks | If you selected a new PostgreSQL, you need to type the persistent volume claim for PostgreSQL. The default is 8. | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | Yes | |||||
| 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 3 | |||||
| Remarks | If 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | As set up by the cluster administrator | |||||
| Default value | As set up by the cluster administrator | |||||
| Remarks | If 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 8 | |||||
| Remarks | If you select a new RabbitMQ, type the persistent volume claim for RabbitMQ. The default is 8. | |||||
Important: The next prompts are specific to installing Remote Runner. With XL CLI, it is possible to install remote runner in 2 ways. One is as part of the Release installation, and the other is to install the remote runner separately. For more information, on how to install remote runner separately, see Installation Options Reference for Digital.ai Release Remote Runner.
Install remote-runner as part of Release installation
| Prompt | ? Install Remote Runner for Digital.ai Release: [? for help] (Y/n) | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | Yes/No | |||||
| Default value | No | |||||
| Remarks | Type Yes to install a new Remote runner in your cluster immediately after the Release startup. | |||||
Enter the Remote Runner Repository Name
| Prompt | ? Enter the Remote Runner repository name (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): [? for help] (xebialabs) | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | xebialabs | |||||
| Remarks | Type the repository name. It is recommended to go with the default, which is xebialabs | |||||
Enter the Remote Runner Image Name
| Prompt | ? Enter the Remote Runner image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | release-remote-runner | |||||
| Default value | release-remote-runner | |||||
| Remarks | Type 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 Remote Runner. However, here are the Docker Hub links to verify all the available image tags.
| Prompt | ? Enter the Release Remote Runner image tag (eg: <tagName> from <repositoryName>/<imageName>:<tagName>): [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | The latest Release is available in the repository, for example, 23.3.0 | |||||
| Remarks | Type the product version number you want to install, for example, 23.3.0 or 23.3.1. | |||||
Enter the Remote Runner Helm Chart release name
| Prompt | ? Enter the Remote Runner Helm Chart release name: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | remote-runner | |||||
| Remarks | Enter the Remote Runner helm chart release name. | |||||
Source of the Remote Runner Helm Chart
| Prompt | ? Use default version of the Remote Runner helm chart: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | Yes/No | |||||
| Default value | Yes | |||||
| Remarks | If selected Yes it is using the Remote Runner provided with blueprints. If No you need to download the helm chart and reference through the path in the next question. | |||||
Enter the Remote Runner Helm Chart path
| Prompt | ? Enter the Remote Runner Helm Chart path (URL or local path): [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| Remarks | Enter the Helm chart path of the Remote Runner. Use helm chart from release-remote-runner-helm-chart | |||||
Enter the Remote Runner replica count
| Prompt | ? Enter the Remote Runner replica count: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | 1 | |||||
| Remarks | Enter the Remote Runner replica count. | |||||
Enable truststore for Remote Runner
| Prompt | ? Enable truststore for Remote Runner: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | Yes/No | |||||
| Default value | No | |||||
| Remarks | Enable truststore for Remote Runner. | |||||
Enter the Release Token used by Remote 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 remote runner: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| Remarks | Enter the Release Token that will be used by remote runner. This is specific to Remote Runner. | |||||
Enter the Release URL used by Remote Runner
Note: This question is asked during the installation process only when you already have a Release instance running.
| Prompt | ? Enter the Release URL that will be used by the remote runner: [? for help] | |||||
|---|---|---|---|---|---|---|
| Prompt valid for—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | NA | |||||
| Default value | NA | |||||
| Remarks | Enter the Release URL that will be used by remote runner. This is specific to Remote Runner. | |||||
Once you are done answering the questions, the installer provides a summary of the installation choices you made. Here's an example.
It then proceeds with the installation by applying the resources to the cluster and completes the installation of the product. Here's an example.
