If you want to run a single node instance of Deploy with caching using Docker, follow these steps.

Single node Deploy deployment

Docker run

Note: From Digital.ai Deploy 10.3, Docker images support only CentOS.

You can run the official XLD docker images from XebiaLabs using the docker run command as follows:

docker run -d  \
  -e ADMIN_PASSWORD=admin \
  -e ACCEPT_EULA=Y \
  -e USE_CACHE=true \
  -p 4516:4516 \
  --name xl-deploy xebialabs/xl-deploy:23.1.0

This will start the Deploy container and print out the container ID, you can also find running containers using the docker ps command. The USE_CACHE and XLD_IN_PROCESS environment variables must both be set to true to enable embedded caching. You can pass more environment variables to the command using -e flags.

You can stream the logs from the container using docker logs -f <container id>.

note

In our example we are mounting configurations and hotfix from local volumes.

docker run -d  \
  -e ADMIN_PASSWORD=admin \
  -e ACCEPT_EULA=Y \
  -e USE_CACHE=true \
  -e XLD_IN_PROCESS=true \
  -p 4516:4516 \
  -v $PWD/xl-deploy-server/conf:/opt/xebialabs/xl-deploy-server/conf \
  -v $PWD/xl-deploy-server/hotfix/lib:/opt/xebialabs/xl-deploy-server/hotfix/lib \
  -v $PWD/xl-deploy-server/hotfix/plugins:/opt/xebialabs/xl-deploy-server/hotfix/plugins \
  --name xl-deploy xebialabs/xl-deploy:23.1.0

Once the containers have started, you can access them at http://localhost:4516/, you might want to wait for a minute for the service to be up and running.

Docker compose

You can also use a Docker-compose file to run Deploy containers, as shown in the example below:

version: "2"
services:
  xl-deploy:
    image: xebialabs/xl-deploy:24.1.0
    container_name: xl-deploy
    ports:
     - "4516:4516"
    volumes:
     - xld:/opt/xebialabs/xl-deploy-server
    environment:
     - ADMIN_PASSWORD=admin
     - ACCEPT_EULA=Y
     - USE_CACHE=true
     - XLD_IN_PROCESS=true

Notes:

• The USE_CACHE and XLD_IN_PROCESS environment variables must both be set to true to enable Embedded caching.
• Ensure that all CI caches (CI_PK_CACHE, CI_PATH_CACHE, and CI_PROPERTIES_CACHE) are enabled or disabled together.

Save the above content to a file named docker-compose.yml in a folder and run docker-compose up -d from the same folder.

If you use a different file name, then run docker-compose -f <filename.yaml> up -d

Once the containers have started, you can access them at http://localhost:4516/, you might want to wait for a minute for the service to be up and running.