querysurge/querysurge-docker-agent repository overview

QuerySurge is the smart data testing solution that automates the data validation of data warehouses, big data, BI reports and enterprise apps with full DevOps functionality for continuous testing.

⁠About QuerySurge

QuerySurge is the smart data testing solution that automates the data validation of data warehouses, big data, BI reports and enterprise apps with full DevOps functionality for continuous testing.

QuerySurge ensures that the data extracted from sources remains intact in the target systems by analyzing and pinpointing up to 100% of all data differences quickly.

⁠Use Cases:

• Data Warehouse/ETL testing
• DevOps for Data / Continuous Testing
• Data Migration testing
• Business Intelligence Report testing
• Big Data testing
• Enterprise App / ERP Testing

⁠Challenges we Solve:

• Providing data quality at speed. Validate up to 100% of all data up to 1,000 x faster than traditional testing.
• Automate your testing. Automate your data testing from the kickoff of tests to performing the validation to automated emailing of the results and updating your test management system.
• Your ability to test across platforms. Whether a big data lake, data warehouse, traditional database, NoSQL document store, BI reports, flat files, JSON files, SOAP or restful web services, xml, Excel, mainframe files, or any other data store.
• Integrate into your DevOps for Data pipeline. Integrate with most data integration/ETL solutions, build/configuration solutions, and QA/test management solutions.
• Your ability to analyze your data. Deep dive with our Data Analytics dashboard & Data Intelligence reports.

⁠Benefits of QuerySurge:

• Improve your data quality & data governance
• Accelerate your data testing cycles in your delivery pipeline
• Dramatically increase your data validation coverage
• Leverage analytics to optimize your critical data
• Improve your data quality at speed

⁠Learn More:

• QuerySurge Website⁠
• QuerySurge Knowledge Base⁠

⁠Get Started

QuerySurge Agents can be deployed as a Docker container, which allows for flexible Agent environments and the ability to run multiple Agents on a single machine. This article discusses how to add Agents using a Docker environment.

For general Agent installation and configuration information, please see the Adding or Upgrading Agents (Linux)⁠ or Adding or Upgrading Agents (Windows)⁠ articles.

⁠Getting Started with Docker

If you are unfamiliar with Docker and would like some more information on how to get started, please see the official Docker documentation for Getting Started with Docker.⁠

The QuerySurge Agent Docker image is built using the Fedora Linux Docker image. This can be run on either Docker for Linux or Docker for Windows. When running on Windows, there may be additional setup involving Hyper-V or WSL2 for emulating Linux for your Docker installation. WSL2 provides the best performance benefits, since it is a full Linux kernel built by Microsoft to work directly with your Windows instance. You can learn more in the WSL and Docker for Windows documentation⁠.

⁠Creating an Agent Container in Docker

The QuerySurge Docker Agent repository is hosted in the Docker Hub registry under the following organization and repository name: 

querysurge/querysurge-docker-agent

You will need to make sure that you have network access to Docker Hub in order to download the appropriate container image. If you are using QuerySurge in an offline environment, you can see the following Docker article on using Command Line Save⁠ to save and transfer the Docker image. 

⁠Using Docker Compose

If you have Docker Compose installed, this is the preferred method of running your container. To learn more about Docker Compose, you can view the official documentation for an Overview of Docker Compose⁠.

⁠Example:

<your_container_name>:
  container_name: <your_container_name>
  restart: unless-stopped
  image: querysurge/querysurge-docker-agent:<querysurge_version>
  volumes:
    - /opt/QuerySurge/agent/jdbc
    - /opt/QuerySurge/agent/config
  environment:
    QS_SERVER_HOSTNAME: <app_server_hostname>
    QS_SERVER_PORT: <app_server_port>
    QS_SSL: <use_ssl>
    QS_AGENT_HEAP: <agent_heap>

⁠Example using sample values:

querysurgeagent1:
  container_name: querysurgeagent1
  restart: unless-stopped
  image: querysurge/querysurge-docker-agent:9.0.10
  volumes:
    - /opt/QuerySurge/agent/jdbc
    - /opt/QuerySurge/agent/config
  environment:
    QS_SERVER_HOSTNAME: "192.168.0.120"
    QS_SERVER_PORT: 80
    QS_SSL: "N"
    QS_AGENT_HEAP: 8192

⁠Using Docker Run

The alternative to Docker Compose is to use Docker Run. To learn more about Docker Run, you can view the official Docker Run Reference⁠.

⁠Example:

docker run \
--name <your_container_name> \
-v /opt/QuerySurge/agent/jdbc \
-v /opt/QuerySurge/agent/config \
-e QS_SERVER_HOSTNAME='<app_server_hostname>' \
-e QS_SERVER_PORT=<app_server_port> \
-e QS_SSL='<use_ssl>' \
-e QS_AGENT_HEAP=<agent_heap> \
-h <your_container_hostname>
querysurge/querysurge-docker-agent:<querysurge_version>

Example using sample values:

docker run \
--name querysurgeagent1 \
-v /opt/QuerySurge/agent/jdbc \
-v /opt/QuerySurge/agent/config \
-e QS_SERVER_HOSTNAME='192.168.0.120' \
-e QS_SERVER_PORT=80 \
-e QS_SSL='N' \
-e QS_AGENT_HEAP=8192 \
-h querysurgeagent1
querysurge/querysurge-docker-agent:9.0.10

Note: Additional Agent settings are configured using the agentconfig.xml file in the config directory

⁠Configuring Your Docker Agent

When a container is started, it will mount the config and JDBC volumes that are specified for your container. If no files exist in these directories, they will be created. If you need to modify the Agent configuration settings, you can update your container's environment variables or modify the agentconfig.xml file directly in the mounted config folder volume. 

Note: The container's environment variables will overwrite the corresponding setting in the agentconfig.xml file when the container is started

To add or remote JDBC drivers for the Docker Agent, you can manage the driver files using the mounted JDBC folder volume. 

These mounted volumes can be used individually for each Agent container, or they may be shared among multiple Agent containers.