Buildkite

Set up Buildkite for automated tests with TrustCloud!

Purpose

Once you set up your compliance program, TrustCloud TrustOps works to ensure that your systems remain compliant with your adopted controls. To do so, TrustCloud retrieves lists of resources against systems in your product and business stack to use for compliance evidence.

This document outlines the steps to grant TrustCloud access to retrieve the following items from Buildkite to be used as evidence:

1. A list of continuous integration/deployment pipelines
2. A list of users with access to Buildkite

TrustCloud will retrieve this information via the Buildkite REST and GraphQL API’s and will need an API token created by an Admin user in order to authenticate and fetch this data.

Instructions to grant TrustCloud read-only access to your Buildkite organization

1. Log in to Buildkite as a user with administrative privileges in your Buildkite organization.
2. Click on the user name dropdown in the upper-right corner of the page, then click Personal Settings.
3. Navigate to the API Access Tokens section, by clicking on the menu item in the sidebar on the left-hand side of the page, then click the New API Access Token button.
   
4. On the New API Access Token page, enter a description for the token, ex: “TrustCloud.”
5. Under Organization Access,  check the box corresponding to your organization
6. Under REST API Scopes, check the boxes corresponding to the following scopes:
   1. Read Builds: Permission to list and retrieve details of builds
   2. Read Organizations: permission to list and retrieve details of organizations
   3. Read Pipelines: Permission to list and retrieve details of pipelines
      
7. Under the GraphQL API section, check the box to Enable GraphQL API Access. Click the “Create New API Access Token” button to finish creating the API access token. Copy the token and save it to enter it in the Integration configuration page in TrustCloud.
   
8. Navigate to the Organization Settings page, then copy the value displayed in the Slug input field.
9. Provide the API Access Token obtained in Step 7 and the organization Slug from Step 8 when setting up your credentials for the Buildkite integration in TrustCloud.