This documentation is for a release that is no longer maintained
See documentation for the latest supported version.Chapter 5. Post-installation integrations
After installing RHTAP, there are a several scenarios that require you to complete some additional work, to ensure RHTAP functions properly.
If you integrated your own instance of Quay into RHTAP, or if you want to use private repositories in Quay, then you must now integrate Quay into ACS. This ensures ACS has access to the repositories you use in Quay.
If you integrated Jenkins into RHTAP, configure Jenkins using the Jenkins UI to ensure it can run the build pipelines provided by RHTAP.
Additionally, if you integrated GitLab into RHTAP, configure GitLab using the GitLab UI to set up webhooks for automated pipeline triggering.
If either of these scenarios apply to you, complete the appropriate procedures below.
5.1. (Optional) Integrating Quay into ACS Copy linkLink copied to clipboard!
Again, if you are using your own instance of Quay, instead of Quay.io, or if you plan to use private repositories in Quay, you must ensure ACS can access your images.
Procedure
-
Go to your instance of ACS. If you did not have ACS prior to installation, then the details you need for access were given in the output of the
rhtap-cli deploycommand. You saved this output in~/install_values.txt, near the end of the installation procedure. - Follow the instructions in this document to integrate Quay into ACS.
5.2. (Optional) Integrating RHTAP into Jenkins Copy linkLink copied to clipboard!
To ensure that your Jenkins pipeline can perform essential security tasks such as vulnerability scanning, image signing, and attestation, you need to configure Jenkins with the appropriate credentials. This procedure will guide you through the steps required to add these credentials to your Jenkins instance.
By completing these steps, you will enable Jenkins to integrate seamlessly with ACS (Advanced Cluster Security), Quay, and GitOps, and utilize Cosign for signing and verifying container images.
Prerequisites
- You must have the necessary permissions to create and manage Jenkins jobs.
- You must have appropriate ACS (Advanced Cluster Security), Quay, and GitOps credentials.
-
You must have the Cosign private key, Cosign public key, and Cosign password, which together are referred to as the “Cosign signing secret”. The values used for these credentials are already base64 encoded, so you do not need to convert them. You can find these credentials in your
~/install_values.txtfile.
Procedure
- Open your Jenkins instance in a web browser and log in with your admin credentials.
- Click on your username at the top right corner of the Jenkins dashboard.
- From the left sidebar, select Credentials.
- Choose the appropriate domain where you want to add the credentials. Typically, it’s Global credentials (unrestricted).
- Click Add Credentials.
- From the Kind drop-down list, select Secret text.
- Keep the default value in the Scope drop-down list as Global (Jenkins).
- In the Secret field, enter your ACS API token.
-
In the ID field, enter
ROX_API_TOKEN. - In the Description field, enter an appropriate description for the credentials.
Repeat steps 5-10 for the following credentials:
Expand ID
Secret
ROX_CENTRAL_ENDPOINTThe route to your ACS instance. If not provided, the ACS task in the pipeline will operate as a NOOP.
GITOPS_AUTH_PASSWORDThe token the system uses to update the GitOps repository for newly built images.
GITOPS_AUTH_USERNAME(optional)The parameter required for Jenkins to work with GitLab.
You also need to uncomment a line with this parameter in a Jenkinsfile:
GITOPS_AUTH_USERNAME = credentials('GITOPS_AUTH_USERNAME'). By default, this line is commented out.QUAY_IO_CREDSThe credentials for Quay used to push the images.
COSIGN_SECRET_KEYThe signing secret used to sign images and attestations.
COSIGN_PUBLIC_KEYThe public key used to verify images created by your build pipeline.
COSIGN_SECRET_PASSWORDThe password required to use the signing secret for signing images.
By following these steps, you can ensure that Jenkins has the necessary credentials to perform vulnerability scanning, image signing, and attestation during the build process.
5.3. (Optional) Configuring GitLab Webhooks for automated pipeline triggers Copy linkLink copied to clipboard!
Set up webhooks and secrets in GitLab to automatically trigger pipeline runs in RHDH upon code updates.
Prerequisites
- You have an existing GitLab project.
-
You have a Webhook URL and a Secret Token. You can find these credentials in your
~/install_values.txtfile.
Procedure
- Within your GitLab repository, navigate to Settings > Webhooks.
- In the URL field, enter the webhook URL.
- In the Secret Token field, enter the secret token.
In the Trigger section:
- Select Push events.
- Select Merge request events.
- Click Add Webhook.
Verification
- Push your code changes to the GitLab repository.
- Navigate to the CI tab in RHDH.
- Verify that a pipeline run is triggered for your code push.
Revised on 2025-01-13 15:10:50 UTC