Skip to main content

tharsis_runner

Defines and manages a group runner.

Example Usage​

resource "tharsis_runner" "this" {
  name              = "my-runner"
  description       = "A runner for a Kubernetes cluster."
  group_id          = tharsis_group.top_level.id
  run_untagged_jobs = false
  tags              = ["kubernetes", "us-east-2"]
}

Schema​

Required​

  • group_id (String) The ID or TRN of the parent group. Runners are group-scoped.
  • name (String) The name of the runner.

Optional​

  • description (String) A description of the runner.
  • disabled (Boolean) Whether the runner is prevented from claiming jobs. Defaults to false.
  • run_untagged_jobs (Boolean) Whether the runner claims jobs that carry no tags. Defaults to false.
  • tags (Set of String) Tags that route tagged jobs to this runner. Changing a non-empty set to empty forces replacement, because the API cannot clear tags through an update.

Read-Only​

  • id (String) String identifier of the runner.
  • resource_path (String) The path of the parent group plus the name of the runner.

Import​

Import is supported using the following syntax:

In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

# A runner is imported by its ID, shown by the "id" attribute or in the
# Tharsis UI.
import {
  to = tharsis_runner.this
  id = "<runner-id>"
}