Run Docker Image for OnPrem Connector

Prerequisites

Before you begin, ensure your environment meets these requirements:

• Docker version 24.X or higher installed
• Virtual machine with:
  • 8 GB memory
  • 4 CPU cores
• Access to ETM platform
• CrowdStrike Spotlight credentials

Deployment Steps

Download Docker Image

Navigate to the OnPrem Connector > Select a connector and open the Quick Actions menu. Download the OnPrem Connector docker image. This image serves as the lightweight execution engine for collecting host asset and vulnerability data.

Prepare Image for Installation

Open your terminal and unzip the downloaded file:

gunzip onprem-execution-engine.tar.gz

Load Docker

Image Install the docker image using the following command:

docker load -i onprem-execution-engine.tar

Verify the docker images are loaded using the following command:

docker images

Create Environment Configuration 

Generate a .env file using the provided template. This file contains critical connection and execution parameters.

Here's a sample Environment file for your reference.

connector.api.url=https://<gateway POD URL> 
qualys.customerUuid=<Customer UUID>
qualys.connectionUuid=<Connection UUID>
qualys.profileUuid=<Profile UUID>
qualys.user.username= <Qualys Username>
qualys.user.password= <Qualys Password>
service.child-thread-pool=<Number of threads to run with for multithreaded support>

service.cron-expression=0 * * * * *
service.http.proxy.enabled=true
service.http.proxy.host=
service.http.proxy.scheme=http
service.http.proxy.port=8080

Run the docker container with your environment file:

docker run --env-file <env_filename> <image_id>

Execution Modes

You can edit the Environment configuration file to execute the OnPrem connector in two specific modes.

Scheduled Execution

Include a cron expression in your .env file. The connector runs periodically based on the specified schedule of the cron expression.

On-Demand Execution

Omit the cron expression and the connector runs once and exits after completion. You can run the connector again from the Quick Actions menu.