Skip to main content

Managing the SCA Agent

Warning

We have discontinued development of this tool, and do not plan on releasing new versions. Checkmarx technical support no longer provides support for its use.

Starting

Use the following command to start the agent with docker-compose: $ sudo docker-compose up -d

Stopping

Use the following command to stop the agent with docker-compose: $ sudo docker-compose down

Restarting

Use the following command to restart the agent with docker-compose: $ sudo docker-compose restart

Monitoring

The log file is written in the logs directory by default. The location can be changed by editing the .env file.

The log file does not have a size limit, but by default it is deleted each day automatically. You can configure how frequently the log file is deleted with the LOG_FILES_EXPIRATION_IN_DAYS in the .env file.

Checking Scan Status

Under the <sca-agnet>/tools folder, there is a show-scans-status.sh script. You can run this script to show a list of all the scans in the Agent logs, with the status of each scan.

To view more option, run the script with the --help flag.

Running the Health Check

The SCA Agent has a built-in health-check function that checks the basic functionality of the system components. To run the health check function, use the following command:

$ curl http://EXTERNAL_HOSTNAME/api/health

For EXTERNAL_HOSTNAME enter the value specified in the .env configuration file.

Using Multiple Nodes

Multiple SCA Agents can be installed on multiple nodes managed with a load balancer, such as F5. With such a setup, "sticky sessions" must be used so that each client always accesses the same SCA agent.

Support

For support, you must send the version of the SCA Agent to customer support. The version can be found in the VERSION file.