Skip to Content

Secret group file

One secret group.

Schema definition: SecretGroupFile.

Example

A minimal secrets/<name>.yaml:

secrets/mail.yaml
# yaml-language-server: $schema=https://a-line.cloud/schemas/iac/v1.json
version: 1
environment: production
keys:
  SMTP_PASSWORD: {}

Fields

description

Type: string, optional.

What the group is for; absent leaves the stored description.

environment

Type: string, required.

The environment the group belongs to (e.g. "prod").

keys

Type: map of SecretKeySpec, optional, default {}.

KEY -> {mount, env}: {} (or null) injects an env var named after the key, mount makes it a file at that path, mount plus env: true does both.

name

Type: string, optional.

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

optional

Type: boolean, optional.

true: the whole group may stay unfilled (its feature is off until it is). The mgmt platform_secrets role then accepts a vault without it, while a group that is filled stays all-or-none. For the sync it is metadata: unfilled keys stay pending and never reach pods, and the link does not warn about them.

version

Type: SchemaVersion, required.

The IaC schema version this file is written for.

On this page