Installing on Buildkite

caution

This section is a work in progress.

Configure a Pipeline

Create a new Pipeline for your Workflows build or choose an existing one and configure it to your preference. If you use GitHub, follow these steps to integrate your repo with Buildkite.

Click on Edit Steps and paste the following:

steps:
    - key: aspect_ci_setup
      label: ':aspect: Setup Aspect CI'
      commands:
          - 'rosetta steps | buildkite-agent pipeline upload'
      agents:
          queue: <RUNNER_GROUP>

Replace <RUNNER_GROUP> with the name of the runner group in your terraform module declaration.

tip

You can use the Buildkite provider for Terraform to set up your pipeline programatically.

Populate secrets

The Workflows terraform module creates two secrets to populate.

1. Buildkite gent token. The agent token allows our runners to connect to Buildkite. Under your organization, click on the Agents Tab then click Reveal Agent Token. Copy and paste this token into a secret named like aw-agent-token-<QUEUE>-XXXXXXXX.

2. Git SSH key. If you use a private repository, set up an SSH key that Workflows runners can use to check out your repository. Under your pipeline's GitHub settings, select the SSH radio button. Then, upload the private key to a secret with a name like aw-git-ssh-key-<QUEUE>-XXXXXXXX. If you use GitHub, we recommend using a Deploy Key with readonly access.

tip

The Workflows module exposes the names of the secrets it creates as an outputs. If you use a tool like Vault, you can wire in secret values automatically via Terraform.

Configure workflows

Add a Workflows configuration file to your repository.