Install Deploy on OpenShift Cluster

This section describes the procedure of fresh installation of the Deploy application on OpenShift cluster using operator-based installer. You can install Deploy on the following platforms:

  • OpenShift cluster on AWS
  • OpenShift cluster on VMWare vSphere

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 OpenShift oc tool
  • Access to an OpenShift cluster version 4.5 or later
  • Kubernetes cluster configuration

Step 1—Create a folder for installation tasks

Create a folder on your workstation from where you will execute the installation tasks, for example, DeployInstallation.

Step 2—Download the Operator ZIP

  1. Download the file from the Deploy/Release Software Distribution site.
  2. Extract the ZIP file to the DeployInstallation folder.

Step 3—Update the platform information

To deploy the Deploy application on the Kubernetes cluster, update the infrastructure.yaml file parameters (Infrastructure File Parameters) in DeployInstallation folder with the parameters corresponding to the kubeconfig file (OpenShift Cluster Configuration File Parameters) as described in the table below. You can find the Kubernetes cluster information in the default location ~/.kube/config. Ensure the location of the kubeconfig configuration file is your home directory.

Note: The deployment will fail if the infrastructure.yaml is updated with wrong details.

Infrastructure File Parameters OpenShift Cluster Configuration File Parameters Parameter Value
ServerUrl server Enter the server details of the cluster.
openshiftToken NA This parameter defines the access token to access your OpenShift cluster.

Step 4—Update the Custom Resource Definitions (daideploy_cr.yaml)

  1. Run the following command to retrieve StorageClass values for Server, Postgres and Rabbitmq:

    oc get sc
  2. Run the keytool command below to generate the RepositoryKeystore:

    keytool -genseckey {-alias alias} {-keyalg keyalg} {-keysize keysize} [-keypass keypass] {-storetype storetype} {-keystore keystore} [-storepass storepass]


    keytool -genseckey -alias deployit-passsword-key -keyalg aes -keysize 128 -keypass deployit -keystore /tmp/repository-keystore.jceks -storetype jceks -storepass test123
  3. Convert the Deploy license and the repository keystore files to the base64 format:

    • To convert the xldLicense into base64 format, run:
    cat <License.lic> | base64 -w 0
    • To convert RepositoryKeystore to base64 format, run:
    cat <repository-keystore.jceks> | base64 -w 0
  4. Update the mandatory parameters as described in the following table:

    Note: For deployments on test environments, you can use most of the parameters with their default values in the daideploy_cr.yaml file.

    Parameters Description
    KeystorePassphrase The passphrase for repository-keystore file
    Persistence.StorageClass PVC Storage Class for volume
    RepositoryKeystore Convert the repository-keystore file content to Base 64 format.
    ingress.hosts DNS name for accessing UI of Deploy.
    postgresql.Persistence.StorageClass PVC Storage Class for Postgres
    rabbitmq.Persistence.StorageClass PVC Storage Class for Rabbitmq
    xldLicense Deploy license

    Note: For deployments on production environments, you must configure all the parameters required for your Openshift production setup in the daideploy_cr.yaml file. The table in Step 4.5 lists these parameters and their default values, which can be overridden as per your setup requirements and workload. You must override the default parameters, and specify the parameter values with those from the custom resource file.

  5. Update the default parameters as described in the following table based on your requirements:

    Note: The following table describes the default parameters in the daideploy_cr.yaml file. If you want to use your own database and messaging queue, refer Using Existing DB and Using Existing MQ topics, and update the daideploy_cr.yaml file. For information on how to configure AWS RDS with Deploy, see Configuring AWS RDS.

    Fields to be updated in daideploy_cr.yaml Description Default Values
    ImageRepository Image name xebialabs/xl-deploy
    ImageTag Image tag 10.2
    AdminPassword The administrator password for Deploy admin
    Resources CPU/Memory resource requests/limits. User can change the parameter accordingly. NA
    postgresql.install postgresql chart with single instance. Install postgresql chart. If you have an existing database deployment, set install to false. TRUE
    postgresql.postgresqlUsername PostgreSQL user (creates a non-admin user when postgresqlUsername is not postgres) postgres
    postgresql.postgresqlPassword PostgreSQL user password postgres
    postgresql.replication.enabled Enable replication false
    postgresql.postgresqlExtendedConf.listenAddresses Specifies the TCP/IP address(es) on which the server is to listen for connections from client applications *
    postgresql.postgresqlExtendedConf.maxConnections Maximum total connections 500
    postgresql.initdbScriptsSecret Secret with initdb scripts contain sensitive information
    Note: This paramete can be used with initdbScriptsConfigMap or initdbScripts. The value is evaluated as a template.
    postgresql.service.port PostgreSQL port 5432
    postgresql.persistence.enabled Enable persistence using PVC TRUE
    postgresql.persistence.size PVC Storage Request for PostgreSQL volume 50Gi
    postgresql.persistence.existingClaim Provide an existing PersistentVolumeClaim, the value is evaluated as a template. NA
    postgresql.resources.requests CPU/Memory resource requests/limits. User can change the parameter accordingly. cpu: 250m
    Memory: 256Mi
    postgresql.nodeSelector Node labels for pod assignment {}
    postgresql.affinity Affinity labels for pod assignment {}
    postgresql.tolerations Toleration labels for pod assignment []
    UseExistingDB.Enabled If you want to use an existing database, change postgresql.install to false. false
    UseExistingDB.XL_DB_URL Database URL for xl-deploy NA
    UseExistingDB.XL_DB_USERNAME Database User for xl-deploy NA
    UseExistingDB.XL_DB_PASSWORD Database Password for xl-deploy NA
    rabbitmq.install Install rabbitmq chart. If you have an existing message queue deployment, set install to false. TRUE
    rabbitmq.extraPlugins Additional plugins to add to the default configmap rabbitmqjmstopic_exchange
    rabbitmq.replicaCount Number of replica 3
    rabbitmq.rbac.create If true, create & use RBAC resources TRUE
    rabbitmq.service.type Type of service to create ClusterIP
    rabbitmq.persistence.enabled If true, persistent volume claims are created TRUE
    rabbitmq.persistence.size Persistent volume size 8Gi
    UseExistingMQ.Enabled If you want to use an existing Message Queue, change rabbitmq-ha.install to false false
    UseExistingMQ.XLD_TASK_QUEUE_USERNAME Username for xl-deploy task queue NA
    UseExistingMQ.XLD_TASK_QUEUE_PASSWORD Password for xl-deploy task queue NA
    UseExistingMQ.XLD_TASK_QUEUE_URL URL for xl-deploy task queue NA
    UseExistingMQ.XLD_TASK_QUEUE_DRIVER_CLASS_NAME Driver Class Name for xl-deploy task queue NA
    HealthProbes Would you like a HealthProbes to be enabled TRUE
    HealthProbesLivenessTimeout Delay before liveness probe is initiated 60
    HealthProbesReadinessTimeout Delay before readiness probe is initiated 60
    HealthProbeFailureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded 12
    HealthPeriodScans How often to perform the probe 10
    nodeSelector Node labels for pod assignment {}
    tolerations Toleration labels for pod assignment []
    Persistence.Enabled Enable persistence using PVC TRUE
    Persistence.Annotations Annotations for the PVC {}
    Persistence.AccessMode PVC Access Mode for volume ReadWriteOnce
    Persistence.XldMasterPvcSize XLD Master PVC Storage Request for volume. For production grade setup, size must be changed 10Gi
    Persistence. XldWorkPvcSize XLD Worker PVC Storage Request for volume. For production grade setup, size must be changed 10Gi
    satellite.Enabled Enable the satellite support to use it with Deploy false

Step 5—Set up the CLI

  1. Download the XL-CLI libraries.


    Note: For $VERSION, substitute with the version that matches your product version in the public folder.

  2. Enable execute permissions.

    chmod +x xl
  3. Copy the XL binary to a directory in your PATH.

    echo $PATH
    cp xl /usr/local/bin
  4. Verify the Deploy application release version.

    xl version

Step 6—Set up the Deploy container instance

  1. Run the following command to download and run the Deploy instance:

    docker run -d -e "ADMIN_PASSWORD=admin" -e "ACCEPT_EULA=Y" -p 4516:4516 --name xld xebialabs/xl-deploy:10.0
  2. Go the following URL to access the Deploy application:
    http://_host IP address_:4516/

Step 7— Activate the Deploy Deployment process

  1. Go to the root of the extracted file and run the following command to activate the deployment process:
xl apply -v -f digital-ai.yaml

Step 8—Verify the deployment status

  1. Check the deployment job completion using XL CLI.
    The deployment job starts the execution of various tasks as defined in the digital-ai.yaml file in a sequential manner. If you encounter an execution error while running the scripts, the system displays error messages. The average time to complete the job is around 10 minutes.

    Note: The running time depends on the environment.

Step 9—Verify if the deployment was successful

To verify the deployment succeeded, do one of the following:

  • Open the local Deploy application, go to the Explorer tab, and from Library, click Monitoring > Deployment tasks
  • Run the following command in a terminal or command prompt:

    kubectl get pod

To check the deployment status using CLI, run the following command:

oc get pod

Step 10—Perform sanity checks

Open the Deploy application and perform the required deployment sanity checks.