Skip to Content

Key ring file

A key ring and its keys.

Schema definition: KeyRingFile.

Example

A minimal key-rings/<name>.yaml:

key-rings/payments.yaml
# yaml-language-server: $schema=https://a-line.cloud/schemas/iac/v1.json
version: 1
keys:
  invoices:
    rotation_period: 90d

Fields

destroy

Type: boolean, optional.

Delete the ring. Needs "Allow destroy" switched on for the ring or the organization in the console, and the ring must hold no keys (destroy them first with destroy: true on each). Removing the file never deletes the ring.

keys

Type: map of KeySpec, optional.

The ring's keys by name. A key left out of this map stays as it is (it is reported as unmanaged), it is never destroyed.

name

Type: string, optional.

Optional: defaults to the file name, and must match it when set.

version

Type: SchemaVersion, required.

The IaC schema version this file is written for.

On this page