Building a Self-Contained ACCELQ Docker Agent Image with Dependencies: A Step-by-Step Guide

This article provides insight into constructing the ACCELQ Docker image inclusive of all essential jar dependencies during the Docker build process. 

How it works

The setup process involves generating all the essential dependencies on the local machine (host machine) and subsequently transferring these cached dependencies to the Docker container. This approach significantly cuts down the startup duration of the agent when employing the "docker run" command, an aspect comprehensively discussed in the linked article below:

Read more about Using Dockerized Agents for ACCELQ Test Execution

Prerequisites

Before executing the setup script, ensure that the following prerequisites are met:

Java Development Kit (JDK) 11: The machine where the Docker build is to be performed must have JDK 11 installed. This is necessary for various operations, including running Java applications and compiling code. You can check your Java version using the following command:

java -version

Note: If you don't have JDK installed and wish for the setup process to handle the JDK download, you can use the flag --download-jdk=true.

Docker Engine: Make sure that Docker is installed and properly configured on your machine. You can check if Docker is installed using the following command:

docker --version

These prerequisites are essential to ensure that the setup script can function correctly and build the Docker container as intended.

Download the setup

wget <accelq_docker_setup zip file path>
unzip accelq_docker_setup.zip
cd accelq_docker_setup
chmod +x setup_docker_image.sh

Copy a valid agent.properties file from an existing agent:

Copy the agent.properties file from the existing agent and place it under the root folder of this setup folder.

Usage

The script is invoked using the following command:

./setup_docker_image.sh --image-name=<image-name>:<tag>

Example: 
./setup_docker_image.sh --image-name=accelq/accelq-agent:6.0

Argument Details

The script accepts the following command-line arguments:

• --image-name(Required):
  Specifies the Docker image name and tag.
  
  

• --download-jdk(Optional):
  

  Accepted values:

  • true

  • false
    Default: false