Jfrog Xray scanner reference
You can set up Jfrog Xray scans using a Security step: create a CI Build or Security Tests stage, add a Security step, and then add the
setting:value pairs as specified below.
Before you begin
To scan a container image, you must have Docker-in-Docker running as a background service in the stage where you're running the scan.
Set up a Docker-in-Docker background step
In the Execution tab, do the following:
- Click Add Step and then choose Background.
- Configure the Background step as follows:
- Dependency Name =
- Container Registry = The Docker connector to download the DinD image. If you don't have one defined, go to Docker connector settings reference.
- Image =
- Under Optional Configuration, select the Privileged checkbox.
Security step settings
Security step dialog box
Here's an example of how to set up a scan in a Security step.
policy_type are scanner-specific; the other settings are common to scans of container images.
fail_on_severity- See Fail on Severity.
Container image scan settings
The following settings apply to all scanners where the
- accepted value(s):
container_region: AWS default region
- accepted value(s):
|Target Name||Target Type|
Ingestion scan settings
The following settings are required for Security steps where the
target nameThe Identifier that you want to assign to the target you’re scanning in the pipeline. Use a unique, descriptive name such as codebaseAlpha or jsmith/myalphaservice.
variantAn identifier for a specific target to scan, such as the branch name or image tag. This identifier is used to differentiate or group results for a target. Harness maintains a historical trend for each variant.
ingestion_fileThe results data file to use when running an Ingestion scan. You should specify the full path to the data file in your workspace, such as
The following steps outline the general workflow for ingesting scan data into your pipeline:
Specify a shared folder for your scan results, such as
/shared/customer_artifacts. You can do this in the Overview tab of the Security stage where you're ingesting your data.
Create a Run step that copies your scan results to the shared folder. You can run your scan externally, before you run the build, or set up the Run step to run the scan and then copy the results.
Add a Security step after the Run step and add the
ingestion_filesettings as described above.
For a complete workflow description and example, go to Ingest Scan Results into an STO Pipeline.
Fail on Severity
Every Security step has a Fail on Severity setting. If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. You can specify one of the following:
NONE— Do not fail on severity
The YAML definition looks like this:
fail_on_severity : critical # | high | medium | low | info | none