Installation Options Reference for Digital.ai Release Runner
- Here's a list of questions that you would have to answer to install Digital.ai Release Runner using the xl kube install command.
- 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.
Release Runner Installation Options Reference
Here's a list of questions that you would have to answer to install Digital.ai Release Runner using the xl kube install command.
Important: The following questions will help you to install the Digital.ai Release Runner separately and not as a part of the Digital.ai Release installation. To learn more about installing Release Runner as a part of the Release installation, see Installation Options Reference for Digital.ai Release with 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
| 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 Runner or go with the default namespace, which is digitalai. | |||||
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 Runner] dai-deploy [Digital.ai Deploy] dai-release-remote-runner [Digital.ai Release Runner] | |||||
| Default value | - | |||||
| Remarks | Select a product—dai-release-remote-runner [Digital.ai Release 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 Runner 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 Release Runner Repository Name
| Prompt | ? Enter the Release 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 Release Runner Image Name
| Prompt | ? Enter the Release 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-runner | |||||
| Default value | release-runner | |||||
| Remarks | Type the name of the image you want to use for installation. | |||||
Enter the Release Runner 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—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 Runner 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 Release Runner Helm Chart release name
| Prompt | ? Enter the Release 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 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—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 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—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 local file system path of Helm chart for the Release runner or the URL of the Release Runner Helm Chart package. | |||||
Enter the Release URL used by Release Runner
| Prompt | ? Enter the Release URL that will be used by the Release 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 Release runner. This is specific to Release Runner. | |||||
Enter the Release Token used by Release Runner
Note: This question is asked during the installation process, and you already have a Release instance running, you will need to create a Personal Access Token on the Release.
| Prompt | ? Enter the Release Token that will be used by Release 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 Release runner. This is specific to Release Runner. | |||||
Enter the Release Runner replica count
| Prompt | ? Enter the Release 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 Release Runner replica count. | |||||
Enable truststore for Release Runner
| Prompt | ? Enable truststore for Release 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 Release Runner. | |||||
Once you are done answering the questions, the installer provides a summary of the installation choices you made.
It then proceeds with the installation by applying the resources to the cluster and completes the installation of the product.