Tailscale Buildkite Plugin

A Buildkite plugin to connect to your Tailscale network.

Options

These are all the options available to configure this plugin's behaviour.

Required

tags (string)

The device tags this pipeline will use.

Optional

client-id (string)

The client ID. When set and no client-secret-env is supplied, workload identity federation is used.

client-secret-env (string)

The environment variable that the client secret is stored in.

audience (string)

The OIDC token audience. Defaults to tailscale.com.

hostname (string)

The hostname to use.

Defaults to buildkite-${BUILDKITE_AGENT_NAME:-$(hostname)}

timeout (number)

Connection timeout value in seconds.

Defaults to 120.

Examples

steps:
  - label: "🔨 Access my-service on the Tailnet"
    command: "curl http://my-service:8080"
    plugins:
    - groq/tailscale:
        # Export this value as part of the repo's hooks/pre-checkout
        client-secret-env: TAILSCALE_OAUTH_CLIENT_SECRET
        tags: tag:ci

📜 License

The package is available as open source under the terms of the MIT License.