ACCELQ enables users to run test executions using Dockerized agents. This guide explains how to pull the latest ACCELQ Docker image, configure environment variables, and run Dockerized agents either for individual users or at the tenant level.
Important Notice: Repository Deprecation
The Docker repository accelq/accelq-agent
will be retired as part of our architectural modernization initiative. We are introducing a new Agent setup that offers enhanced scalability and simplified maintenance. The current repository will remain available until June 1, 2025 to ensure a smooth transition.
What You Need to Do
Transition to the new repository: accelq/accelq-acc-agent
before June 1, 2025.
Pull ACCELQ Agent Docker Image
There are 2 ways you can get the ACCELQ agent docker image
-
You can directly pull the image from the docker hub.
For the latest image:
docker pull accelq/accelq-acc-agent:latest
This Docker image, pulled from Docker Hub, is a generic image. After starting the container from this image (using thedocker run
command), the agent process takes some time to fully start. This delay occurs because the Docker agent needs to download all the necessary dependencies from the ACCELQ server based on the arguments passed in thedocker run
command. Once all dependencies are fetched and the agent is initialized, it becomes ready for test execution.
- You can customize the image locally using the below article:
Building a Self-Contained ACCELQ Docker Agent Image with Dependencies: A Step-by-Step Guide
This method allows you to build the Docker image locally with all the dependencies on your machine or VM (Linux - Ubuntu). This means the locally built image will contain all the required dependencies for your tenant. Upon executing thedocker run
command, the ACCELQ Agent Docker container will start instantly. This method is ideal for users who have their own private Docker repository for their organization. You can build the image locally and upload it to your preferred Docker repository.
Run ACCELQ Docker Agent(s)
ACCELQ docker image needs to take the agent.properties file’s key-value pairs as environment variables
You can pass any of the following keys as environment variables to the docker run command
Argument Name | Description | |
agent_port | Port on which the Agent should run. Please leave it blank to dynamically use an available port. | |
agent_type | Scope of the Agent, which defines its visibility | |
User | The agent is accessible only for the User starting this Agent | |
Project | This scope allows sharing the Agent for all Project users | |
Tenant | This scope allows all users on the Tenant to use this Agent | |
accelq_server_url | URL of the ACCELQ server | |
user_id | The user ID used for logging into ACCELQ | |
api_key | The authentication API key is available from the ACCELQ profile menu under "auth properties". | |
web_provider_type | Specifies the type of environment or service provider where the Agent operates. Supported values include LOCALHOST, SAUCE_LABS, BROWSER_STACK, PERFECTO, LAMBDATEST, HEADSPIN, and DIGITAL_AI. Each provider type may require additional configuration properties specific to the provider. Refer to the official documentation for the list of applicable properties and their usage for each provider. | |
web_provider_username | Username for accessing cloud providers (e.g., BrowserStack or Sauce Labs). | |
web_provider_password | Password for accessing cloud providers. | |
web_provider_hostname | The hostname of the cloud provider or environment where the Agent interacts. | |
web_provider_port | The port number used to connect to the specified cloud provider or testing environment. | |
sharing_type | Specifies the sharing type of the Agent. If agent_type is "User", set sharing_type to 0 (exclusive to the user starting the Agent). If agent_type is "Project" or "Tenant", set sharing_type to 1 (shared among users in the project or tenant). | |
project_code | List of project codes, separated by commas, defining where this Agent is accessible. Applicable only when agent_type is set to "Project". Project codes can be found in the ACCELQ profile menu. | |
tenant_code | Code representing the tenant where the Agent is configured. | |
num_concurrent_jobs | The number of concurrent jobs allowed to run on this Agent. Invalid values default to a single concurrent job. | |
num_parallel_tc_per_job | Number of parallel test cases to support within a single job. Invalid values default to single-threaded execution. | |
http_proxy_host | The hostname of the HTTP proxy server used for network routing when behind a proxy. | |
http_proxy_port | Port used for the HTTP proxy server connection. | |
http_proxy_user | Username for authenticating with the HTTP proxy server. | |
http_proxy_password | Password for authenticating with the HTTP proxy server. | |
http_proxy_nonproxyhosts | A list of hosts that should be reached directly, bypassing the HTTP proxy. The list consists of patterns separated by | | |
https_proxy_host | The hostname of the HTTPS proxy server used for secure network routing when behind a proxy. | |
https_proxy_port | Port used for the HTTPS proxy server connection. | |
https_proxy_user | Username for authenticating with the HTTPS proxy server. | |
https_proxy_password | Password for authenticating with the HTTPS proxy server. | |
https_proxy_nonproxyhosts | A list of hosts that should be reached directly, bypassing the HTTPS proxy. The list consists of patterns separated by | |
Start Agent from docker image [For a Dedicated User]
docker run -d -e agent_name=<agent_name> -e num_concurrent_jobs=1 -e num_parallel_tc_per_job=3 -e accelq_server_url=<url> -e user_id=<user_Id> -e api_key=<apikey> -e project_code=<projcode> -e tenant_code=<tenant_code> -e sharing_type=0 -e agent_type=user accelq/accelq-acc-agent:latest
Start Agent from docker image [At Tenant Level]
docker run -d -e agent_name=<agent_name> -e num_concurrent_jobs=1 -e num_parallel_tc_per_job=3 -e accelq_server_url=<url> -e user_id=<user_Id> -e api_key=<apikey> -e project_code=<projcode> -e tenant_code=<tenant_code> -e sharing_type=1 -e agent_type=Tenant accelq/accelq-acc-agent:latest
-p 47047:47047
argument in the docker run
command. This maps the container's port 47047
to the host's port 47047
. Once the container is running, you can access the agent dashboard UI via http://localhost:47047
.Once the docker run command succeeds, you will see a local agent registered with the ACCELQ server. You may log in to ACCELQ, navigate to Resources > Local Agents tab, and verify the agent with the given name is displayed.
Docker Run Command Generator (Live Tool)
To simplify the process, use the live web utility below to generate the full docker run
command by filling in the necessary details like Tenant ID, Access Key, and other configuration parameters.
🔔 Important Note
If you haven't accessed the Q Community Portal yet, simply log into ACCELQ and click "Community" or "What's New" in the Help Center. Setting up your account is just a few quick steps.
Running Test on Chrome browser with Docker Agent
Use the below driver profile
{
"headless": "new",
"args": [
"window-size=2000,1600",
"--no-sandbox",
"--disable-dev-shm-usage",
"--disable-gpu",
"--ignore-certificate-errors"
]
}
Comments
0 comments
Please sign in to leave a comment.