spotlight_workspace_runners

The spotlight_workspace_runners resource, and the workspace runners resource of the API: the runner pools and runner trusts of a workspace, named by key. A workspace has at most one. Writing it needs the manage-runners permission; see Roles and permissions.

KindEndpointTerraformAddress
workspace-runners/api/resources/workspaces/{workspaceId}/workspace-runnersspotlight_workspace_runners<workspace slug>

See Resource API for the operations, headers and errors every kind shares.

Example

resource "spotlight_workspace_runners" "acme" {
  workspace_id = spotlight_workspace.acme.id
  trusts       = [spotlight_runner_trust.production_cluster.key]
  pools        = [spotlight_runner_pool.ephemeral.key]
}

Fields

FieldTypeDefaultDescription
trustsarray of strings[]Runner trust keys, each once.
poolsarray of strings[]Runner pool keys, each once.

Warnings

PathWarning
pools[<n>]names <key>. Runner pool <key> doesn't exist in this workspace
trusts[<n>]names <key>. Runner trust <key> doesn't exist in this workspace

Delete

Deleting it leaves every runner pool and runner trust as it is.

On this page