Integrating with CI systems

In the RHACS portal, go to Platform Configuration → Policy Management.

Use global search to search for Lifecycle Stage:Build.

In the RHACS portal, go to Platform Configuration → Policy Management.

Click + New Policy.

Enter the Name for the policy.

Select a Severity level for the policy: Critical, High, Medium, or Low.

Choose the Lifecycle Stages for which the policy is applicable, from Build, Deploy, or Runtime. You can select more than one stage.

Enter information about the policy in the Description, Rationale, and Remediation fields. When CI validates the build, the data from these fields is displayed. Therefore, include all information explaining the policy.

Select a category from the Categories drop-down menu.

Select a notifier from the Notifications drop-down menu that receives alert notifications when a violation occurs for this policy.

Use Restrict to Scope to enable this policy only for a specific cluster, namespace, or label. You can add multiple scopes and also use regular expressions in RE2 Syntax for namespaces and labels.

Use Exclude by Scope to exclude deployments, clusters, namespaces, and labels. This field indicates that the policy will not apply to the entities that you specify. You can add multiple scopes and also use regular expressions in RE2 Syntax for namespaces and labels. However, you cannot use regular expressions for selecting deployments.

For Excluded Images (Build Lifecycle only), select all the images from the list for which you do not want to trigger a violation for the policy.

In the Policy Criteria section, configure the attributes that will trigger the policy.

Select Next on the panel header.

The new policy panel shows a preview of the violations that are triggered if you enable the policy.

Select Next on the panel header.

Choose the enforcement behavior for the policy. Enforcement settings are only available for the stages that you selected for the Lifecycle Stages option. Select ON to enforce policy and report a violation. Select OFF to only report a violation.

In the RHACS portal, go to Platform Configuration → Integrations.

Under the Image Integration section, look for highlighted Registry tiles. The tiles also list the number of items already configured for that tile.

After you have generated the authentication token, export it as the ROX_API_TOKEN variable by entering the following command:

$ export ROX_API_TOKEN=<api_token>

(Optional): You can also save the token in a file and use it with the --token-file option by entering the following command:

$ roxctl central debug dump --token-file <token_file>

Log in to the registry.redhat.io registry.

$ docker login registry.redhat.io

Pull the latest container image for the roxctl CLI.

$ docker pull registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.4.5

Log in to CircleCI and open an existing project or create a new project.

Click Project Settings.

Click Environment variables.

Click Add variable and create the following three environment variables:

Create a directory called .circleci in the root directory of your local code repository for your selected project, if you do not already have a CircleCI configuration file.

Create a config.yml configuration file with the following lines in the .circleci directory:

version: 2
jobs:
  check-policy-compliance:
    docker:
      - image: 'circleci/node:latest'
        auth:
          username: $DOCKERHUB_USER
          password: $DOCKERHUB_PASSWORD
    steps:
      - checkout
      - run:
          name: Install roxctl
          command: |
              curl -H "Authorization: Bearer $ROX_API_TOKEN" https://$STACKROX_CENTRAL_HOST:443/api/cli/download/roxctl-linux -o roxctl && chmod +x ./roxctl
      - run:
          name: Scan images for policy deviations and vulnerabilities
          command: |
              ./roxctl image check --endpoint "$STACKROX_CENTRAL_HOST:443" --image "<your_registry/repo/image_name>" (1)
      - run:
          name: Scan deployment files for policy deviations
          command: |
              ./roxctl image check --endpoint "$STACKROX_CENTRAL_HOST:443" --image "<your_deployment_file>" (2)
              # Important note: This step assumes the YAML file you'd like to test is located in the project.
workflows:
  version: 2
  build_and_test:
    jobs:
      - check-policy-compliance

After you commit the configuration file to your repository, go to the Jobs queue in your CircleCI dashboard to verify the build policy enforcement.