Skip to main content
Version: Release 23.1

Upgrade Wizard for Digital.ai Release and Remote Runner

  • Here's a list of questions that you would have to answer to install Digital.ai Deploy or Release or Remote Runner using the xl kube upgrade command.
  • While some of the following questions are common for both Deploy and Release or Remote Runner, some are relevant only for Deploy or 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.

Upgrade Wizard

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

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 valueOpenshift [Openshift]
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 Deploy or 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 Upgrade

Prompt? Product server you want to perform upgrade 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 valuesdaiRelease [Digital.ai Release]
daiDeploy [Digital.ai Deploy]
dai-release-runner [Remote Runner for Digital.ai Release]
Default valuedaiRelease [Digital.ai Release]
RemarksSelect a product—Digital.ai Release or Digital.ai Deploy or Remote Runner for Digital.ai Release

Select the Type of Upgrade

Prompt? Select the type of upgrade you want: [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 valuesoperatorToOperator [Operator to Operator]
helmToOperator [Helm to Operator]
Default valueoperatorToOperator [Operator to Operator]
RemarksSelect operatorToOperator [Operator to Operator] or helmToOperator [Helm to Operator] depending on whether your existing site was installed using the Kubernetes Operator or the Helm Charts respectively.

Important: The following prompt (Select Type of Image Registry) is specific to upgrading Remote Runner and will not be available when you upgrade Release.

Select Type of 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 valuesNA
Default valuedefault
RemarksType the image repository. It is recommended to go with the default, which is xebialabs. This is specific to Remote Runner.

Enter the Repository Name

Prompt? Enter the 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 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 values(xl-release)
(xl-deploy)
Default value(xl-release) or (xl-deploy) or (xlr-remote-runner)

Depending on the product you chose to install earlier, the default value would either be xl-release or xl-deploy or xlr-remote-runner for Digital.ai Release and Deploy, and Remote Runner respectively.
RemarksType the name of the image you want to use for installation.

Enter the Image Tag

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

Prompt? Enter the 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 available in the repository, for example 23.1.0
RemarksType the product version number you want to install, for example, 23.1.0 or 22.3.0 or 0.1.34.

Important: The next 3 prompts are specific to upgrading Remote Runner and will not be available when you upgrade Release.

Enter the Remote Runner Helm Chart path

Prompt? Enter the Remote 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 Remote Runner. This is specific to Remote Runner.

Enter the Release URL used by Remote Runner

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

Enter the Release Token used by Remote Runner

Prompt? Enter the Release Token that will be used by remote 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 remote runner. This is specific to Remote Runner.

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 valuesexisting [Existing OIDC Configuration]
external [External OIDC Configuration]
identity-service [Identity Service Configuration]
embedded [Embedded Keycloak Configuration]
no-oidc [No OIDC Configuration]
Default valueno-oidc [No OIDC Configuration]
RemarksChoose existing [Existing OIDC Configuration] if you have an existing OIDC setup, which you want to use. Otherwise, choose one of the other options based on the OIDC authentication setup you want to have.

For more information, see Select the Type of OIDC Configuration.

Enter the Operator Image to Use

Prompt? Enter the operator image to use (eg: <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 xebialabs repository, for example, (xebialabs/release-operator:22.3.0-openshift)
RemarksType the Kubernetes Operator Docker Hub image name you want to use.
By default, the latest image for the product—Deploy or Release or Remote Runner—which you install—would be used.
Example: (xebialab/release-operator:22.3.0-openshift), if you are installing Digital.ai Release on OpenShift.
However, you can change it to an older image if required.

Enter the CRD Name

Prompt? Enter the name of custom resource definition you want to reuse or replace: [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 valuesThe list of all available CRDs.
Default valueNA
RemarksSelect one of the CRDs from the list you want to reuse or replace with a new one.

Confirm CRD's Reuse

Prompt? Should CRD be reused, if No we will delete the CRD <crd name>, and all related CRs will be deleted with it: [? for help] (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueYes
RemarksCRDs are reused by default unless you answer No to this prompt. Note that choosing to delete a CRD means deleting the associated custom resources as well. Exercise caution before you answer No to this question.

Enter the CR Name

Prompt? Enter the name of custom resource: [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 valuesThe list of available custom resources.
Default valueNA
RemarksSelect the name of the custom resource you want to use.

Edit the List of CR Keys

Prompt? Edit list of custom resource keys that will migrate to the new Release CR: [? for help] [Enter to launch editor]
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueNA
RemarksPress enter and edit the list of custom resource keys in the editor and save the changes.

Preserve Persisted Volume Claims?

Prompt? Should we preserve persisted volume claims? If not all volume data will be lost (Y/n)
Prompt valid for—platformEKSAKSGKEOpenShift on AWSPlain Multi-node Kubernetes
Cluster On-premise
YesYesYesYesYes
Available valuesNA
Default valueYes
RemarksPVCs are preserved by default unless you answer No to this prompt. Exercise caution before you answer No to this question.

Once you are done answering the questions, the installer proceeds with the upgrade and in the process prompts you to confirm whether to delete or keep the following resources such as:

  • custom resources
  • deployments
  • jobs
  • services
  • secrets
  • ingress class
  • cluster roles
  • cluster role bindings

YOu can skip these prompts if you want by using the --skip-prompts flag. See, XL Kube Command Reference for more information.

The installer then proceeds with the upgrade by applying the resources to the cluster and completes the upgrade.