Upgrading to Operator Based Deploy Solution
This section describes how to upgrade to the latest Kubernetes Operator-based Release solution on various Kubernetes platforms. Release 10.3 supports the following upgrades on the supported Kubernetes platforms:
- Upgrade from Helm Charts-based Release Solution
- Upgrade from the previous Operator-based Release Solution
Supported Platforms
- Amazon EKS
- Azure Kubernetes Service
- Kubernetes On-premise
- OpenShift on AWS
- OpenShift on VMWare vSphere
- GCP GKE
Intended Audience
This guide is intended for administrators with cluster administrator credentials who are responsible for application deployment.
Before You Begin
The following are the prerequisites required to migrate to the operator-based deployment:
- Docker version 17.03 or later
- The
kubectl
command-line tool - Access to a Kubernetes cluster version 1.17 or later
- Kubernetes cluster configuration
-
If you are upgrading Deploy on OpenShift cluster, you will need:
- The OpenShift oc tool
- Access to an OpenShift cluster version 4.5 or later
- The Helm Chart that was used to install the Release application
- Back up of the Release application and Kubernetes cluster configuration
- Ensure the port 4516 is free
Backup and Restore
Before you upgrade to Kubernetes Operator-based solution, you must back up your existing database so that you can revert back to the earlier state in case of upgrade failures. You can use automated backups or snapshots of the database to back up your AWS Relational Database Service (RDS) instance. For more information about back up and restore using snapshots, refer to Backing up and restoring an Amazon RDS DB instance.
Note: We recommend that you use an external database instance (for example, PostgreSQL) for production grade installations. To back up the PostgreSQL database running on a virtual machine, use the native PostgreSQL commands—pg_dump
and pg_restore
.
Upgrading from Helm Charts-based Release Solution
You can upgrade to Release 10.3 from Release 10.1 and earlier versions that are installed using Helm Charts on the following platforms:
Amazon Elastic Container Service for Kubernetes (EKS)
Upgrading to Release 10.3 on Amazon EKS
Follow the steps below to upgrade to Release 10.3 on Amazon EKS.
Step 1—Check the status of the Helm Chart installation
Run the following command:
helm status <product name>
Sample Output
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Sample Output
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—AwsEKS [AWS EKS]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and Amazon EKS (AWS EKS) clusters, always type n (No). |
No |
Enter the K8sApiServerURL of your Kubernetes installation | Type the AWS Server URL, and press Enter. | NA |
What is the Amazon EKS cluster name? | Type the Amazon EKS Cluster Name, and press Enter. | NA |
Do you want to use the AWS credentials from your ~/.aws/credentials file? | If you want to use the AWS credentials from the credentials file, type y for Yes. Otherwise, type n for No. Press Enter. | Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Type the name of the Kubernetes namespace where the Helm Chart is deployed, and press Enter. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name(eg: <repositoryName>/<imageName>:<tagName>) | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name(eg: <repositoryName>/<imageName>:<tagName>) | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag(eg: <repositoryName>/<imageName>:<tagName>) | Type the image tag of the product—10.2, and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from Helm-based solution to Operator-based solution, select helmToOperator [Helm to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/release-operator:1.0.0 |
Enter the helm release name | Type the name of the release product installed using the Helm Chart. Note: To get the helm release name, run the following command in a separate command shell— helm ls , and copy the name of the release product |
NA |
A preview of the enter values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system start the local Deploy instance. This process will take some time.
After the process completes, the Helm-based release product is uninstalled, and the Operator-based release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local Deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
Sample Output
- Register your Load balancer external IP under the appropriate DNS.
After the registration, you can verify the newer version of Release (Operator-based product) using the same link that you used to access the earlier version (Helm-chart based release product).
Azure Kubernetes Service (AKS)
Upgrading to Release 10.3 on AKS
To upgrade to Release 10.3 on Azure Kubernetes Service (AKS) cluster, follow the installation steps — Step 1 to Step 4 from Installation topic, and perform the following steps:
Step 1—Upgrade the Operator
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—Azure AKS [Azure AKS]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For AKS cluster, always type y (Yes). |
Yes |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing Kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. Note: For Helm to Operator upgrade, always type y (Yes). |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Type the name of the Kubernetes namespace where the Helm Chart is deployed, or press Enter to select the default option. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys and select daiRelease [Digital.ai Deploy] | NA |
Enter the repository name(eg: <repositoryName>/<imageName>:<tagName>) | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name(eg: <repositoryName>/<imageName>:<tagName>) | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag(eg: <repositoryName>/<imageName>:<tagName>) | Type the image tag of the product—10.3.0, and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from Helm-based solution to Operator-based solution, select helmToOperator [Helm to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/release-operator:1.0.0 |
Enter the helm release name | Type the name of the release product installed using the Helm Chart, for example, dai-xlr-aks .Note: To get the helm release name, run the following command in a separate command shell— helm ls , and copy the name of the release product |
NA |
A preview of the enter values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system start the local Deploy instance. This process will take some time.
After the process completes, the Helm-based Deploy product is uninstalled, and the Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
To complete the upgrade process, follow the steps — Step 1 to Step 4 from Installation topic.
Kubernetes On-premise
Upgrading to Release 10.3 on Kubernetes On-premise Cluster
Follow the steps below to upgrade to Release 10.3 on Kubernetes On-premise Cluster.
Step 1—Check the status of the Helm Chart installation
Run the following command:
helm status <product name>
Sample Output
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Sample Output
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Run the following command:
xl op --upgrade
A set of questions is displayed.
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—PlainK8SCluster [Plain multi-node K8s cluster]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. | No |
Do you want to use an existing Kubernetes namespace? | If you want to use Kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. Note: For Helm to Operator upgrade, always type y for Yes. |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Type the name of the Kubernetes namespace where the Helm Chart is deployed, and press Enter. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name(eg: <repositoryName>/<imageName>:<tagName>) | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name(eg: <repositoryName>/<imageName>:<tagName>) | Type the image name of the product—xl-deploy, and press Enter. | xl-release |
Enter the image tag(eg: <repositoryName>/<imageName>:<tagName>) | Type the image tag of the product (version number), and press Enter. | 10.2 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from Helm-based solution to Operator-based solution, select helmToOperator [Helm to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Release from the official docker hub repository site. |
xebialabs/release-operator:1.1.1 |
Enter the helm release name | Type the name of the release product installed using the Helm Chart. Note: To get the helm release name, run the following command in a separate command shell— helm ls , and copy the name of the release product |
NA |
A preview of the enter values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the Helm-based release product is uninstalled, and the Operator-based release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get ingress
Sample Output
- Register your Load balancer external IP under the appropriate DNS.
After the registration, you can verify the newer version of the release (Operator-based product) using the same link that you used to access the earlier version (Helm-chart based release product). -
Replace the NodePort with the updated node port. To get the details about the services and the node port, run the following command:
kubectl get svc.
OpenShift
Upgrade to Release 10.3 on OpenShift Cluster
You can upgrade to Operator-based Release solution on the following OpenShift platforms:
Follow the steps below to upgrade to Release 10.3 on your OpenShift cluster.
Step 1—Check the status of the Helm Chart installation
Run the following command:
helm status <product name>
Sample Output
Step 2—Verify the pods running on the cluster
Run the following command:
oc get pods
Sample Output
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the Digital.ai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—OpenShift . Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and AWS EKS clusters, always type n (No). |
No |
Enter the K8sApiServerURL of your Kubernetes installation | Type the OpenShift Server URL, and press Enter. | NA |
Choose kubernetes authentication type | Use the Up/Down arrow keys to choose one of the authentication types for the OpenShift cluster:
|
token |
Provide authentication token for the existing service account | Enter the token. | NA |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing Kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. Note: For Helm to Operator upgrade, always type y (Yes). |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Type the name of the Kubernetes namespace where the Helm Chart is deployed, and press Enter. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name(eg: <repositoryName>/<imageName>:<tagName>) | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name(eg: <repositoryName>/<imageName>:<tagName>) | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag(eg: <repositoryName>/<imageName>:<tagName>) | Type the image tag of the product—10.2, and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from Helm-based solution to Operator-based solution, select helmToOperator [Helm to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/release-operator:1.0.0-openshift |
Enter the helm release name | Type the name of the release product installed using the Helm Chart. Note: To get the helm release name, run the following command in a separate command shell— helm ls , and copy the name of the release product |
NA |
A preview of the enter values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system start the local Deploy instance. This process will take some time.
After the process completes, the Helm-based release product is uninstalled, and the Operator-based release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local Deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Verify the Operator installation
Google Cloud Platform (GCP)
Upgrading to Release 10.3 on GCP GKE
Follow the steps below to Upgrading to Release 10.3 on Google Cloud Platform (GCP) Google Kubernetes Engine (GKE) cluster.
Step 1—Check the status of the Helm Chart installation
Run the following command:
helm status <product name>
Sample Output
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Sample Output
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—GoogleGKE [Google Kubernetes Engine]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and Amazon EKS (AWS EKS) clusters, always type n (No). |
No |
Enter the K8sApiServerURL of your Kubernetes installation | Type the GKE Server URL, and press Enter. | NA |
Choose Kubernetes authentication type | Use the Up/Down arrow keys to choose the type of authentication, and press Enter:
|
token |
Provide authentication token for the existing service account | Type the token, and press Enter. | NA |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. Note: For Helm to Operator upgrade, always select Yes. |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Type the name of the Kubernetes namespace where the Helm Chart is deployed, and press Enter. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name(eg: <repositoryName>/<imageName>:<tagName>) | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name(eg: <repositoryName>/<imageName>:<tagName>) | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.3.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from Helm-based solution to Operator-based solution, select helmToOperator [Helm to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/deploy-operator:1.2.0 |
Enter the helm release name | Type the name of the Deploy product installed using the Helm Chart. Note: To get the helm release name, run the following command in a separate command shell— helm ls , and copy the name of the Release product |
NA |
A preview of the enter values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system start the local Deploy instance. This process will take some time.
After the process completes, the Helm-based Release product is uninstalled, and the Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
- Register your Load balancer external IP under the appropriate DNS.
After the registration, you can verify the newer version of Deploy (Operator-based product) using the same link that you used to access the earlier version (Helm-chart based release product).
Upgrading from Previous Operator-based Release Solution
You can upgrade to Release 10.3 from Release 10.2 that is installed using Kubernetes Operator on the following platforms:
Amazon Elastic Container Service for Kubernetes (EKS)
Upgrading to Release 10.3 on Amazon EKS
Follow the steps below to Upgrading to Release 10.3 on Amazon EKS (AWS EKS).
Step 1—Check the status of the existing operator based Release instance
To check the status of the existing Operator version:
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Sample Output
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Run the following commands to get the custom resource definition (CRD) and custom resource (CR):
kubectl get crd
kubectl get <crd name>
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—AwsEKS [AWS EKS]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and Amazon EKS (AWS EKS) clusters, always type n (No). |
No |
Enter the K8sApiServerURL of your Kubernetes installation | Type the AWS Server URL, and press Enter. | NA |
What is the Amazon EKS cluster name? | Type the Amazon EKS Cluster Name, and press Enter. | NA |
Do you want to use the AWS credentials from your ~/.aws/credentials file? | If you want to use the AWS credentials from the credentials file, type y for Yes. Otherwise, type n for No. Press Enter. | Yes |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. Note: For Operator to Operator upgrade, always type y (Yes). |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed: | Enter the name of the existing Kubernetes namespace on which your operator is deployed. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name | Type the image name of the product—xl-release, and press Enter. | xl-deploy |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.2 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from the previous Operator-based solution, select operatorToOperator [Operator to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Release from the official docker hub repository site. |
xebialabs/deploy-operator:1.1.0 |
Enter the name of the custom resource | Type the name of the Operator CR. | NA |
Enter the name of the custom resource definition | Type the name of the Operator CRD. | NA |
A preview of the entered values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the previous Operator-based Release product is uninstalled, and the new Operator-based Deploy product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
- Register your Load balancer external IP under the appropriate DNS.
Step 6—Verify the version of the Release instance
After the registration, verify the newer version of Release (latest Operator-based Deploy product):
Azure Kubernetes Service (AKS)
Upgrading to Release 10.3 on AKS
Follow the steps below to Upgrading to Release 10.3 on Azure Kubernetes Service (AKS).
Step 1—Check the status of the existing operator based Deploy instance
To check the status of the existing Operator version:
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Run the following commands to get the custom resource definition (CRD) and custom resource (CR):
kubectl get crd
The system fetches the CRD details.
kubectl get <crd name>
The system fetches the CRD details.
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—Azure AKS [Azure AKS]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For AKS clusters, always type y (Yes). |
Yes |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. For Operator to Operator upgrade, always select Yes. |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed: | Type the name of the existing Kubernetes namespace on which your operator is deployed. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.3 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from the previous Operator-based solution, select operatorToOperator [Operator to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/deploy-operator:1.1.0 |
Enter the name of the custom resource | Type the name of the Operator CR (see Step 4). | NA |
Enter the name of the custom resource definition | Type the name of the Operator CRD (see Step 4). | NA |
A preview of the entered values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the previous Operator-based Release product is uninstalled, and the new Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
- Register your Load balancer external IP under the appropriate DNS.
Step 6—Verify the version of the Release instance
After the registration, verify the newer version of Release (latest Operator-based Release product):
Kubernetes On-premise Cluster
Upgrading to Release 10.3 on Kubernetes On-premise Cluster
Follow the steps below to Upgrading to Release 10.3 on Kubernetes On-premise Cluster.
Step 1—Check the status of the existing operator based Deploy instance
To check the status of the existing Operator version:
- Log in to Digital.ai Release.
- From the Settings icon, click About and verify the status.
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Run the following commands to get the custom resource definition (CRD) and custom resource (CR):
kubectl get crd
The system fetches the CRD details.
kubectl get <crd name>
The system fetches the CRD details.
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—PlainK8SCluster [Plain multi-node K8s cluster]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and Azure AKS clusters, always type n (No). |
Yes |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. For Operator to Operator upgrade, always select Yes. |
Yes |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed: | Type the name of the existing Kubernetes namespace on which your operator is deployed. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from the previous Operator-based solution, select operatorToOperator [Operator to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/deploy-operator:1.1.0 |
Enter the name of the custom resource | Type the name of the Operator CR (see Step 4). | NA |
Enter the name of the custom resource definition | Type the name of the Operator CRD (see Step 4). | NA |
A preview of the entered values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the previous Operator-based Release product is uninstalled, and the new Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
- Register your Load balancer external IP under the appropriate DNS.
Step 6—Verify the version of the Release instance
After the registration, verify the newer version of Release(latest Operator-based Release product):
- Log in to Digital.ai Release.
- From the Settings icon, click About and verify the version.
OpenShift Cluster
Upgrading to Release 10.3 on OpenShift Cluster
This section describes how to upgrade Deploy using the Release Operator on the OpenShift cluster. You can upgrade on the following OpenShift platforms:
- OpenShift cluster on AWS
- OpenShift cluster on VMWare vSphere
Step 1—Check the status of the existing operator based Release instance
To check the status of the existing Operator version:
- Log in to Digital.ai Release.
- From the Settings icon, click About and verify the status.
Step 2—Verify the pods running on the cluster
Run the following command:
oc get pods
Step 3—Upgrade the Operator
-
Run the following commands to get the custom resource definition (CRD) and custom resource (CR):
oc get crd
The system fetches the CRD details.
oc get <crd name>
The system fetches the CRD details.
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—Openshift [Openshift]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For OpenShift and Azure AKS clusters, always type n (No). |
No |
Do you want to use an existing Kubernetes namespace? | If you want to use the existing kubernetes namespace, type y for Yes. Otherwise, type n for No. Press Enter. For Operator to Operator upgrade, always select Yes. |
Yes |
Enter the K8sApiServerURL of your Kubernetes installation | Type the OpenShift Server URL, and press Enter. | NA |
Choose kubernetes authentication type | Use the Up/Down arrow keys to choose one of the authentication types for the OpenShift cluster:
|
token |
Provide authentication token for the existing service account | Enter the token. | NA |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed | Enter the name of the existing Kubernetes namespace on which your operator is deployed. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name | Type the image name of the product—xl-deploy, and press Enter. | xl-release |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from the previous Operator-based solution, select operatorToOperator [Operator to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/deploy-operator:1.1.0 |
Enter the name of the custom resource | Type the name of the Operator CR (see Step 4). | NA |
Enter the name of the custom resource definition | Type the name of the Operator CRD (see Step 4). | NA |
A preview of the entered values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the previous Operator-based Release product is uninstalled, and the new Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Verify the version of the Release instance
After the registration, verify the newer version of Release (latest Operator-based Release product):
- Log in to Digital.ai Release.
- From the Settings icon, click About.
Google Cloud Platform (GCP) Google Kubernetes Engine (GKE)
Upgrading to Release 10.3 on GCP GKE
Follow the steps below to Upgrading to Release 10.3 on GCP GKE.
Step 1—Check the status of the existing operator based Release instance
To check the status of the existing Operator version:
Step 2—Verify the pods running on the cluster
Run the following command:
kubectl get pods
Step 3—Download and set up the XL CLI
-
Download the XL-CLI binaries.
wget https://dist.xebialabs.com/public/xl-cli/$VERSION/linux-amd64/xl
Note: For
$VERSION
, substitute with the version that matches your product version in the public folder. -
Enable
execute
permissions.chmod +x xl
-
Copy the XL binary in a directory that is on your
PATH
.echo $PATH
Example
cp xl /usr/local/bin
-
Verify the release version.
xl version
Step 4—Upgrade the Operator
-
Run the following commands to get the custom resource definition (CRD) and custom resource (CR):
kubectl get crd
kubectl get <crd name>
-
Do one of the following:
-
If you want to retain the Operator artefacts, run the following command:
xl op --upgrade --no-cleanup
-
Otherwise, run the following command:
xl op --upgrade
A set of questions is displayed.
-
-
To continue with the upgrade, perform the actions described in the following table:
Note: The default values is displayed within square brackets (
[]
)
Question | Action | Default Value |
---|---|---|
Select the setup mode | Use the Up/Down arrow keys to choose one of the setup modes, and press Enter:
|
NA |
Select the Kubernetes setup where the digitalai Devops will be installed or uninstalled | Use the Up/Down arrow keys to select the platform from the list—GoogleGKE [Google Kubernetes Engine]. Press Enter. | NA |
Do you want to use kubernetes current-context from ~/.kube/config ? | If you want to use Kubernetes configuration, type y for Yes. Otherwise, type n for No. Press Enter. Note: For GoogleGKE [Google Kubernetes Engine] cluster, always select Yes. |
Yes |
Enter the K8sApiServerURL of your Kubernetes installation | Type the GCP GKE Server URL, and press Enter. | NA |
Choose kubernetes authentication type | Use the Up/Down arrow keys to choose one of the authentication types for the cluster:
|
token |
Provide authentication token for the existing service account | Provide the token from the kubeconfig file | NA |
Enter the name of the existing Kubernetes namespace where the XebiaLabs DevOps Platform will be installed, updated or undeployed: | Type the name of the existing Kubernetes namespace on which your operator is deployed. | default |
Product server you want to perform upgrade for | Use the Up/Down arrow keys to choose one of the products you want to upgrade, and press Enter:
|
NA |
Enter the repository name | Type the repository name from where you want to pull the product server image (Release/Deploy), and press Enter. | xebialabs |
Enter the image name | Type the image name of the product—xl-release, and press Enter. | xl-release |
Enter the image tag | Type the image tag of the product (version number), and press Enter. | 10.0.0 |
Select the type of the upgrade you want | Use the Up/Down arrow keys to choose one of the types of upgrades, and press Enter:
Note: To upgrade from the previous Operator-based solution, select operatorToOperator [Operator to Operator]. |
NA |
Operator image to use | Type the operator image name, and press Enter. Note: Get the latest Operator Docker image for Deploy from the official docker hub repository site. |
xebialabs/deploy-operator:1.1.0 |
Enter the name of the custom resource | Type the name of the Operator CR. | NA |
Enter the name of the custom resource definition | Type the name of the Operator CRD. | NA |
A preview of the entered values is displayed.
- Type y for Yes—to confirm the values. Otherwise, type n for No—to modify the values. After you confirm, the system starts the local Deploy instance. This process will take some time.
After the process completes, the previous Operator-based Release product is uninstalled, and the new Operator-based Release product is installed.
Note: The local Instance of Deploy will run on 4516 port; therefore, ensure you have the port 4516 free. Deployment status can be monitored on the local Deploy GUI. To access local deploy, use:http://localhost:4516
, and log in using the default username and password.
Step 5—Register the load balancer/node port services external IP
-
Run the following command:
kubectl get svc
-
Register your Load balancer external IP under the appropriate DNS.
Step 6—Verify the version of the Release instance
After the registration, verify the newer version of Release (latest Operator-based Release product):