RunR v0.7.5

Documentation

runr_runtime_source (Data Source)

A runtime source (runtime sources) and the runtimes it gives, each with its lifecycle: any source the token sees (runtimes.manage: every one; runtimes.use_custom: the organization's), RunR's own catalog of built-in runtimes too (name = "RunR runtimes", is_default). Look it up by name or id. A report to read, e.g. to check that a source was read (status) or to pick a runtime id for runr_project.runtime.

Example Usage#

# RunR's own catalog of built-in runtimes.
data "runr_runtime_source" "runr" {
  name = "RunR runtimes"
}

# A connected source and the runtimes it gives, with their lifecycle.
data "runr_runtime_source" "acme" {
  name = "acme-runtimes"
}

output "deprecated_runtimes" {
  value = [for rt in data.runr_runtime_source.acme.runtimes : "${rt.id} (sunset ${coalesce(rt.sunset_at, "-")}, use ${coalesce(rt.replacement, "-")})" if rt.state != "active"]
}

check "builtin_catalog" {
  assert {
    condition     = data.runr_runtime_source.runr.status == "ok"
    error_message = "RunR's catalog was not read: ${coalesce(data.runr_runtime_source.runr.error, data.runr_runtime_source.runr.status)}"
  }
}

Schema#

Optional#

  • id (String) Source id.
  • name (String) Source name (any case).

Read-Only#

  • checked_at (String) When RunR last read the source.
  • credentials (Attributes) Which credentials the source has (never a value). (see below for nested schema)
  • enabled (Boolean) RunR reads the source on its interval.
  • error (String) Why the last read failed.
  • interval_minutes (Number) Minutes between reads.
  • is_default (Boolean) RunR's own catalog (the built-in runtimes).
  • kind (String) git or oci-catalog.
  • patch_feed (String) The source's runtime patch feed.
  • path (String) git: directory of the runtimes.
  • problems (Attributes List) The problems of the last read. (see below for nested schema)
  • public_key (String) cosign public key the catalog must verify with.
  • ref (String) git: branch, tag or commit.
  • registry_host (String) Registry the registry credentials are for.
  • revision (String) Catalog digest or commit of the last good read.
  • runtimes (Attributes List) The runtimes of the source, each with its lifecycle (lifecycle). (see below for nested schema)
  • runtimes_count (Number) Runtimes the source gives.
  • scope (String) platform or organization.
  • signature_verified (Boolean) The last read's catalog verified.
  • status (String) The last read: never, ok, partial, unreachable, not_found, auth_failed, invalid_signature, invalid_catalog or disabled.
  • synced_at (String) When the last good read was.
  • url (String) Repository or catalog reference.

Nested Schema for credentials#

Read-Only:

  • git (String) token (HTTPS), ssh (a deploy key) or null.
  • git_token_hint (String) The token's last four characters behind a mask (tokens longer than eight characters).
  • git_username (String) User name of the Git token (null: x-access-token).
  • known_hosts_set (Boolean) known_hosts is set (without it the host key is accepted on first use).
  • registry_password_set (Boolean) A registry password is set.
  • registry_username (String) The registry user.
  • ssh_key_set (Boolean) A deploy key is set.

Nested Schema for problems#

Read-Only:

  • file (String) The file.
  • message (String) The problem.
  • path (String) JSON path in the manifest.
  • runtime (String) The runtime id or directory.

Nested Schema for runtimes#

Read-Only:

  • deprecated_at (String) Deprecated from this date.
  • id (String) Runtime id (runr_project.runtime).
  • name (String) Display name.
  • notice (String) Why it is deprecated or sunset.
  • orphaned_at (String) When it left its source.
  • path (String) Its directory in the source.
  • projects_count (Number) Projects that use it.
  • replacement (String) The runtime RunR suggests instead.
  • state (String) active, deprecated, sunset or orphaned.
  • sunset_at (String) After this date its projects can no longer be created, saved or deployed.
  • versions (Attributes List) Its versions. (see below for nested schema)

Nested Schema for runtimes.versions#

Read-Only:

  • deprecated_at (String) Deprecated from this date.
  • ends_at (String) The earlier of eol_at and sunset_at: the version leaves the picker, its projects can no longer be saved or deployed.
  • eol_at (String) End of life.
  • is_default (Boolean) The default version.
  • state (String) active, deprecated, eol or sunset.
  • sunset_at (String) Sunset.
  • version (String) Version.

RunR v0.7.5 · MIT License