Cluster Secrets Buildkite Plugin

A Buildkite plugin used to fetch secrets from Buildkite Secrets,

Storing Secrets

The plugin expects that secrets will be stored base64 encoded in a secret with the key "env", in the format KEY=value in Buildkite secrets:

Foo=bar
SECRET_KEY=llamas
COFFEE=more

You can create a secret in your Buildkite cluster(s) from the Buildkite UI following the instructions in the documentation here.

Examples

Default Configuration

Add the plugin to your pipeline YAML to download. By default the plugin will fetch the secret with key env

steps:
    - command: build.sh
      plugins:
        - cluster-secrets#v0.1.0

Custom Secret Key

Alernatively, you can specify a custom key that will be fetched by the plugin, instead of the default env

steps:
    - command: build.sh
      plugins:
        - cluster-secrets#v0.1.0:
            key: "llamas"

Options

Currently, the plugin supports a single configurable option

key (optional, string)

The key to fetch from Buildkite secrets, see example

Testing

You can run the tests using docker-compose:

docker compose run --rm tests

License

MIT (see LICENSE)