Skip to main content
Version: Deploy 23.3

Install or Upgrade Deploy on an Air-gapped Environment

You can install Deploy on an air-gapped environment disconnected from the public internet. This topic provides information about installing and upgrading Deploy in such environments using a Minikube cluster and a custom image registry. For other Kubernetes platforms, steps are similar to the ones listed here for Minikube as long as the custom image registry contains all the required images.

Note: The Amazon Elastic Container Registry (ECR) does not support having all necessary images in a single repository and hence, cannot be used as a custom image registry.

Prerequisites​

Install Deploy on an Air-gapped Cluster Environment​

Here's a detailed step-by-step.

Step 1 — Download Appropriate Blueprint Version​

  1. Run the following command:
xl kube help

It returns the following message:

Install, upgrade or clean Digital.ai Deploy or Digital.ai Release on a Kubernetes cluster using operator technology.

Installation blueprint files are used from https://dist.xebialabs.com/public/xl-op-blueprints/23.3.x/.

You need to have kubectl installed and configured for the target Kubernetes cluster.

Once you run the command, xl kube will search for blueprints from this location.

Note: 23.3.x denotes the appropriate version of xl-op-blueprints pointed by xl. You will use the specific version for your case.

  1. Download all the files from that location and place them in the server directory where you will execute the xl kube command.

Tip: Download the zipped version of the xl-op-blueprints from this location

  1. Unzip it to the server where you will execute the xl kube command.

When you run a Kubernetes cluster in an air-gapped environment, it's impossible to download images from public registries such as docker.io, gcr.io, or quay.io. Therefore, you need to set up an image registry also called as custom image registry. This should be either public (not password protected) or private (password protected), that is accessible to the Kubernetes cluster. This can be done by creating a private image repository on your cloud provider or a local image registry.

Step 2.1 — Get Prerequisite Images​

Note: The image versions may not match the latest release. We recommend checking the values.yaml for the most up-to-date versions.

Based on your installation plan, push the images to your image repository.

Note: Replace <version> with the version of Deploy you are trying to install.

  • docker.io/xebialabs/xl-deploy:<version>
  • docker.io/xebialabs/deploy-task-engine:<version>
  • docker.io/xebialabs/central-configuration:<version>
  • docker.io/library/busybox:stable
  • docker.io/xebialabs/deploy-operator:<version>
  • gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0*

For nginx

  • docker.io/bitnami/nginx:1.22.1-debian-11-r44
  • docker.io/bitnami/nginx-ingress-controller:1.6.4-debian-11-r5

For haproxy

quay.io/jcmoraisjr/haproxy-ingress:v0.14.2

For embedded postgresql

docker.io/bitnami/postgresql:15.4.0-debian-11-r54

For embedded rabbitmq

  • docker.io/bitnami/rabbitmq:3.12.7-debian-11-r0
  • docker.io/bitnami/os-shell:11-debian-11-r90

Step 2.2—Push Images to an Internally Accessible Docker Registry​

To ensure that the required images are available in an air-gapped Kubernetes cluster, you must pull them first on a Bastion instance with public internet connectivity, tag them, and push them to the previously created Docker image registry that's internally accessible. Once this is done, your Kubernetes cluster can pull the required images from the Docker registry.

For example:

In the Docker registry (myrepo_host), run the following command to push the Docker image (xl-deploy) to the repository (myrepo)

Note: Replace <version> with the version of Deploy you are trying to install. For instance, to install version 23.3, use 23.3.x.

docker pull docker.io/xebialabs/xl-deploy:<version>
docker tag docker.io/xebialabs/xl-deploy:<version> myrepo_host/myrepo/xl-deploy:<version>
docker push myrepo_host/myrepo/xl-deploy:<version>

Note: Ensure that you are logged in to the Docker registry before pushing the images.

Step 2.3 — Create a Secret for Private Image Registry with Password Protection​

Note: It's required only when you use a private image registry.

Run the following command:

kubectl create secret docker-registry regcred \
  --docker-server=myrepo_host \
  --docker-username=<reg-user> \
  --docker-password=<reg-password> \
  -n digitalai

This example creates a secret called regcred which can be used as pull secrets required for pulling images from a private image registry.

Step 4—Use xl kube install to Install Using Custom Docker Image Registry​

Note: For instructions on installing Deploy using the default image registry, see Install—Deploy—On-premise Kubernetes.

Here is an example of the installation on Minikube with a local Docker registry running at localhost:5000:

  • ? Enter the custom docker image registry name: localhost:5000
  • ? Enter the repository name (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): myrepo
  • ? Enter the Deploy server image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): xl-deploy
  • ? Enter the operator image to use (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): deploy-operator

Note: For the above mentioned prompts, override the default answers and specify answers in this format.

For more information about these prompts, see Installation Options Reference for Digital.ai Deploy.

❯ xl kube install -l c:\proj\xl-op-blueprints
? Following kubectl context will be used during execution: `minikube`? Yes
? Select the Kubernetes setup where the Digital.ai Devops Platform will be installed, updated or cleaned: PlainK8s [Plain multi-node K8s cluster]
? Do you want to use an custom Kubernetes namespace (current default is 'digitalai'): No
? Product server you want to perform install for: dai-deploy [Digital.ai Deploy]
? Select type of image registry: public [Custom Public Registry (Uses a specific custom registry)]
? Enter the custom docker image registry name: localhost:5000
? Enter the repository name (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): myrepo
? Enter the deploy server image name (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): xl-deploy
? Enter the image tag (eg: <tagName> from <repositoryName>/<imageName>:<tagName>): 23.3.x
? Enter the deploy task engine image name for version 22 and above (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): deploy-task-engine
? Enter the central configuration image name for version 22 and above (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): central-configuration
? Enter the deploy master server replica count: 1
? Enter PVC size for Deploy master (Gi): 1
? Select between supported Access Modes: ReadWriteOnce [ReadWriteOnce]
? Enter the deploy worker replica count: 1
? Enter PVC size for Deploy worker (Gi): 1
? Enter PVC size for Central Configuration (Gi): 0.500000
? Select between supported ingress types: haproxy [HAProxy]
? Do you want to enable an TLS/SSL configuration (if yes, requires existing TLS secret in the namespace): No
? Provide DNS name for accessing UI of the server: test.com
? Provide administrator password: 30Q5utfMV6O9wnHF
? Type of the OIDC configuration: no-oidc [No OIDC Configuration]
? Enter the operator image to use (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): deploy-operator
? Select source of the license: file [Path to the license file (the file can be in clean text or base64 encoded)]
? Provide license file for the server: c:\downloads\xld-license.lic
? Select source of the repository keystore: generate [Generate the repository keystore during installation (you need to have keytool utility installed in your path)]
? Provide keystore passphrase: 1uwAFCtUJEdwmaDi
? Provide storage class for the server: standard
? Do you want to install a new PostgreSQL on the cluster: Yes
? Provide Storage Class to be defined for PostgreSQL: standard
? Provide PVC size for PostgreSQL (Gi): 1
? Do you want to install a new RabbitMQ on the cluster: Yes
? Replica count to be defined for RabbitMQ: 1
? Storage Class to be defined for RabbitMQ: standard
? Provide PVC size for RabbitMQ (Gi): 1

...

? Do you want to proceed to the deployment with these values? Yes
For current process files will be generated in the: digitalai/dai-deploy/digitalai/20231023-121302/kubernetes
Generated answers file successfully: digitalai/generated_answers_dai-deploy_digitalai_install-20231023-121302.yaml
Starting install processing.
...

Once the installation is completed successfully, you will see the operator and other resource pods up and running.

Use xl kube upgrade to Upgrade Deploy Using a Custom Docker Image Registry​

The upgrade process for a custom Docker image registry is similar to the installation process except using xl kube upgrade instead of xl kube install.

Here is an example of running upgrade using the custom docker image registry option:

❯ xl kube upgrade -l ./xl-op-blueprints
...
? Select type of image registry: public [Custom Public Registry (Uses a specific custom registry)]
? Enter the custom docker image registry name: localhost:5000
? Enter the repository name (eg: <repositoryName> from <repositoryName>/<imageName>:<tagName>): myrepo
...
? Enter the operator image to use (eg: <imageName> from <repositoryName>/<imageName>:<tagName>): deploy-operator
...
? Edit list of custom resource keys that will migrate to the new Deploy CR: 
...
? Do you want to proceed to the deployment with these values? Yes
For current process files will be generated in the: digitalai/dai-deploy/digitalai/20221020-011911/kubernetes
Generated answers file successfully: digitalai/generated_answers_dai-deploy_digitalai_upgrade-20221020-011911.yaml
Starting upgrade processing.
...

Important: During the upgrade, for the prompt Edit list of custom resource keys that will migrate to the new Deploy CR:, you must add the following keys:

For Default Image Registry

.spec.nginx-ingress-controller.defaultBackend.image.registry
.spec.nginx-ingress-controller.defaultBackend.image.repository
.spec.nginx-ingress-controller.image.registry
.spec.nginx-ingress-controller.image.repository
.spec.haproxy-ingress.controller.image.repository
.spec.postgresql.image.registry
.spec.postgresql.image.repository
.spec.rabbitmq.image.registry
.spec.rabbitmq.image.repository
.spec.rabbitmq.volumePermissions.image.registry
.spec.rabbitmq.volumePermissions.image.repository

For Public Custom Docker Registry

.spec.busybox.image.registry
.spec.busybox.image.repository
.spec.nginx-ingress-controller.defaultBackend.image.repository
.spec.nginx-ingress-controller.image.repository
.spec.nginx-ingress-controller.global.imageRegistry
.spec.haproxy-ingress.controller.image.repository
.spec.postgresql.image.repository
.spec.postgresql.global.imageRegistry
.spec.rabbitmq.image.repository
.spec.rabbitmq.global.imageRegistry
.spec.rabbitmq.volumePermissions.image.repository

For Private Custom Docker Registry

.spec.busybox.image.registry
.spec.busybox.image.repository
.spec.nginx-ingress-controller.defaultBackend.image.repository
.spec.nginx-ingress-controller.image.repository
.spec.nginx-ingress-controller.global.imageRegistry
.spec.haproxy-ingress.controller.image.repository
.spec.postgresql.image.repository
.spec.postgresql.global.imageRegistry
.spec.rabbitmq.image.repository
.spec.rabbitmq.global.imageRegistry
.spec.rabbitmq.volumePermissions.image.repository
.spec.busybox.image.pullSecrets
.spec.nginx-ingress-controller.global.imagePullSecrets
.spec.postgresql.global.imagePullSecrets
.spec.rabbitmq.global.imagePullSecrets