Upgrade Wizard for Digital.ai Deploy
- Here's a list of questions that you would have to answer to install Digital.ai Deploy or Release using the xl kube upgrade command.
- While some of the following questions are common for both Deploy and Release, some are relevant only for Deploy or Release 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.
Deploy Upgrade Wizard
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 | Openshift [Openshift] | |||||
| 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 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | daiRelease [Digital.ai Release] daiDeploy [Digital.ai Deploy] | |||||
| Default value | daiRelease [Digital.ai Release] | |||||
| Remarks | Select a product—Digital.ai Release or Digital.ai Deploy | |||||
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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | operatorToOperator [Operator to Operator] helmToOperator [Helm to Operator] | |||||
| Default value | operatorToOperator [Operator to Operator] | |||||
| Remarks | Select 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. | |||||
Enter the Repository Name
| Prompt | ? Enter the 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 | colspan="6">Type the repository name. It is recommended to go with the default, which is xebialabs. | |||||
Enter the Image Name
| Prompt | ? Enter the deploy server image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help] (xl-deploy) | |||||
|---|---|---|---|---|---|---|
| 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) (xl-deploy) | |||||
| Default value | (xl-release) or (xl-deploy) Depending on the product you chose to install earlier, the default value would either be xl-release or xl-deploy for Digital.ai Release and Deploy respectively. | |||||
| 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 wizards let you go with the default (latest) docker image tags available when you install or upgrade Digital.ai Deploy or Release. However, here are the Docker Hub links to verify all the the available image tags.
- Digital.ai Deploy Operator Image
- Digital.al Release Operator Image
- Digital.ai Deploy Image
- Digital.ai Release Image
- Digital.ai Deploy Task Engine Image
- Digital.ai Deploy Central Configuration Image
| Prompt | ? Enter the 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 available in the repository, for example 22.3.0 | |||||
| Remarks | Type the product version number you want to install, for example, 22.2.0 or 22.3.0. | |||||
Enter the Deploy Task Engine Image Name
| Prompt | ? Enter the deploy task engine image name for version 22 and above (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help] (deploy-task-engine) | |||||
|---|---|---|---|---|---|---|
| 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 | deploy-task-engine | |||||
| Remarks | Type the name of the Digital.ai Deploy task engine image you want to use. This is relevant for Digital.ai Deploy 22.0.0 and later. | |||||
Enter the Deploy Central Configuration Image Name
| Prompt | ? Enter the central configuration image name for version 22 and above (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): [? for help] (central-configuration) | |||||
|---|---|---|---|---|---|---|
| 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 | central-configuration | |||||
| Remarks | Type the name of the Digital.ai Deploy central configuration image you want to use. This is relevant for Digital.ai Deploy 22.0.0 and later. | |||||
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 | existing [Existing OIDC Configuration] external [External OIDC Configuration] identity-service [Identity Service Configuration] embedded [Embedded Keycloak Configuration] no-oidc [No OIDC Configuration] | |||||
| Default value | no-oidc [No OIDC Configuration] | |||||
| Remarks | Choose 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—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 xebialabs repository, for example, (xebialabs/release-operator:22.3.0-openshift) | |||||
| Remarks | Type the Kubernetes Operator Docker Hub image name you want to use. By default, the latest image for the product—Deploy or Release—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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | The list of all available CRDs. | |||||
| Default value | NA | |||||
| Remarks | Select 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—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 | CRDs 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—platform | EKS | AKS | GKE | OpenShift on AWS | Plain Multi-node Kubernetes Cluster On-premise | |
| Yes | Yes | Yes | Yes | Yes | ||
| Available values | The list of available custom resources. | |||||
| Default value | NA | |||||
| Remarks | Select 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 Deploy CR: [? for help] [Enter to launch editor] | |||||
|---|---|---|---|---|---|---|
| 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 | Press 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—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 | PVCs 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.