Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Reference

This section collects the specifications of the input files, CLI, and internal data structures that Tazuna accepts, in a form intended to be referenced as a contract.

For why it is shaped this way, see Concepts; for how to drive it, see Guides. The reference sticks to enumerating facts, focusing on fields, types, defaults, and examples.

Contents

Currently the reference includes the following pages. From here we will progressively expand into per-Manifest-type details, CLI, Test plugin, and the internal structure of State.

  • tazuna.yaml schema — the top-level structure of tazuna.yaml, the only input file to Tazuna, and the common-field specifications of spec.manifests[] / spec.context_matches / includes, and so on.
  • tazuna.hint.yaml schema — the schema of the hint file that declares constraints over the vars of a helmfile Manifest. Type, required, conditional-required, format-validation rules, and top-level rules such as oneof_required.
  • GenesisSecret schema — the YAML schema for generating Kubernetes Secrets from an external secret store (1Password). It is referenced from tazuna.yaml as a Manifest with type: genesissecret.
  • Test plugin — the common fields of TestPluginSpec (written under manifests[].tests and spec.tests) and the spec for the built-in WaitUntil / ExistNonExist plugins.
  • Internal Structure of State — State’s storage location (ConfigMaps in the tazuna namespace), the string format of State keys, ContentHash computation rules, and Diff type classification spec.
  • Per Manifest type — one page each for the 5 types kustomize / helmfile / oras / parallel / genesissecret, covering the meaning of path, type-specific fields, and apply / destroy / build behavior.
  • CLI — the spec of subcommands, global flags, and environment variables of the tazuna binary. Each subcommand has its own page summarizing flags and behavior.

Reading Conventions

  • Field names are shown in their YAML form (camelCase or snake_case).
  • All fields without a Required annotation are optional.
  • “Default” is the value Tazuna uses when the field is omitted. Zero values (empty string / empty slice / false / 0) are taken as-is unless otherwise noted.
  • Example YAML is written in its minimal form. Additional fields needed in real operation are described individually in each section.