Automation Host Docker Setup Instructions

In this article, we will walk you through how to set up the Automation Host in a Docker environment on an Ubuntu machine.

Before you start to integrate qTest Automation Host with Launch, make sure you turn on automation integration.

Setup the Automation Host

1. Create a Docker file at /path/to/agentctl/dockerfile.

   Enter this code snippet:

   Copy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   FROM ubuntu:24.04
   RUN apt-get update \
       && apt-get install -y git curl wget \
       && rm -rf /var/lib/apt/lists/*
   
   ENV AGENT_VERSION <<___AUTOMATION_HOST_VERSION____>>
   
   ENV PACKAGE_NAME agentctl-${AGENT_VERSION}-linux-x64-full.tgz
   ENV PACKAGE_URL https://qasymphony.jfrog.io/qasymphony/launch-release-local/automation-hosts/agentctl/${AGENT_VERSION}/agentctl-${AGENT_VERSION}-linux-x64-full.tgz
   ENV AGENT_HOME /usr/local
   
   # configure Automation Host parameters
   ENV PORT <<___AUTOMATION_HOST_PORT___>>
   ENV HOSTNAME <<___AUTOMATION_HOST_HOSTNAME___>>
   ENV QTEST_MANAGER <<___QTEST_MANAGER_URL___>>
   ENV QTEST_TOKEN <<___QTEST_MANAGER_TOKEN___>>
   
   WORKDIR $AGENT_HOME
   
   #COPY ./${PACKAGE_NAME} $AGENT_HOME/${PACKAGE_NAME}
   RUN set -x \
      && wget --no-check-certificate "$PACKAGE_URL"
   
   RUN tar xvf $PACKAGE_NAME -C $AGENT_HOME \
       && rm $PACKAGE_NAME \
       && mv agentctl-${AGENT_VERSION} agentctl
   
   # install a junit sample
   # COPY ./junit-sample ${AGENT_HOME}/junit-sample/
   
   # configure Automation Host
   RUN ./agentctl/agentctl config -Phostname=${HOSTNAME} -Pport=${PORT} -PqTest.url=${QTEST_MANAGER} -PqTest.token=${QTEST_TOKEN}
   
   EXPOSE $PORT
   
   COPY ./entrypoint.sh /entrypoint.sh
   RUN chmod u+wrx /entrypoint.sh
   ENTRYPOINT ["/entrypoint.sh"]

2. Update the following configurations in your Docker file:

   Parameter Name	Description
   ENV AGENT_VERSION	Enter version of Automation Host that you want to install, such as 2023.6.6.
   ENV HOSTNAME	Enter a name for this Automation Host instance. After your Automation Host has been successfully installed and started at least once, you won't be able to change your Automation Host name with the ./agentctl config -Phostname="Your new host name" command. However, you can change your Automation Host name in qTest Launch as an Elite user.
   ENV PORT	Specify the port that your Automation Host will run on. If this parameter is omitted, Automation Host uses port 6789.
   ENV QTEST_MANAGER	Enter the URL for your qTest Manager instance.
   ENV QTEST_TOKEN	Enter the qTest API token generated for your qTest Manager account. You can copy it from the API & SDK section in qTest Manager's Resource page.

3. Create a file called entrypoint.sh and make it executable.

4. Open entrypoint.sh in your preferred text editor and enter the following command:

#!/usr/bin/env bash
./agentctl/agentctl start

5. Build the image with the Docker Build -t agent: new . command.

   

   When Docker successfully builds the image, you'll see the following output:

   

6. Run the container with the desired port, such as $ Docker run -d -p 8080:6789 agent:new.

   

   After this command finishes, wait a few minutes for the Automation Host to start.

Register the Automation Host with qTest Manager

1. When you set up the Docker file at /path/to/agentctl/dockerfile, enter the parameter -Pui.enabled=true to enable the UI.

2. To enable the UI for the local host only, enter the parameter -Pui.ip=127.0.0.1 .

   If you want to enable the UI for your local network, enter your local IP address as the parameter.

3. Open a web browser and access the host using the following URL: http://[host-ip-address]:8080. You will be presented with host UI.

4. Enter the following on the host UI to register the Automation Host with the qTest Manager:Host.

   • Name: Name of the automation host

   • qTest URL: URL of your qTest Manager instance

   • Full Name: Your full name

   • qTest Token: The API token for the host to access the qTest Manager. Refer to Acquire your qTest API Token to get the API token.

     If your environment is behind a proxy, select the Configure Proxy link and specify the proxy configuration.

5. Select Register.

When the registration is successful, you'll be presented with the Automation Host home page.

What's next

Now that you've set up Automation Host on Docker, learn how to integrate JUnit for Java with a Universal Agent.