Skip to content

elastic/oblt-cli-buildkite-plugin

Repository files navigation

oblt-cli-buildkite-plugin

A Buildkite plugin to set up oblt-cli.

Note

This plugin does not provide a way to automatically download the latest version of oblt-cli to ensure that the used version is stable and the plugin is reproducible. If you don't provide both the version or version-file input, then the default version defined in .default-oblt-cli-version will be used. The default version will be updated by updatecli when a new version of oblt-cli is available. Only maintainers will decide to merge the PR created by updatecli to update the version.

Properties

Name Type Default Description
version string 7.3.0 The version of the oblt-cli to install.
version-file string - The file to get the version from. If both version and version-file are provided, the plugin will use version.
username string obltmachine The oblt-cli username
slack-channel string #observablt-bots The slack channel for oblt-cli notifications

Usage

steps:
  - command: oblt-cli cluster create serverless
    agents:
      provider: gcp # currently only works on the gcp provider
    plugins:
      - elastic/oblt-cli#v0.1.0:
          version-file: .tool-versions

GitHub Token

This plugin requires the VAULT_GITHUB_TOKEN, which is set by default in Buildkite agents.

Permissions

The plugin requires the following GitHub token permissions in the elastic/observability-test-environments repository:

contents: write
pull_requests: read