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

Welcome!

Welcome to the Tazuna documentation.

Tazuna is a CLI tool for managing the bootstrap lifecycle of multi-cluster Kubernetes environments. You declare in tazuna.yaml which manifests to apply to which clusters and in what order, and operate that definition consistently through commands such as apply / destroy / plan / status / state.

Main commands:

  • tazuna apply — applies tazuna.yaml to the cluster and writes State back. --sync applies only the diff, --sync --prune deletes obsolete resources, and --sync --atomic handles rolling State back on a mid-run error.
  • tazuna plan — shows, as a unified diff, which fields would change if you apply.
  • tazuna status — lists the readiness of the managed resources recorded in State.
  • tazuna state diff / tazuna state drift — detect declared drift and live drift separately.
  • tazuna destroy — removes Tazuna-managed resources from the cluster.

About this documentation

This documentation is organized for everyone from first-time Tazuna users, to those running it continuously as part of CI, to those modifying Tazuna itself, in the following flow.

  • Getting Started — Getting Tazuna up and running on your machine for the first time.
  • Concepts — The problem Tazuna aims to solve, and its design philosophy and architecture. Covers “why it is the way it is.”
  • Guides — Task-oriented, hands-on procedures such as writing tazuna.yaml. Covers “what to do, in what order, with which commands.”
  • Operations — Guidance for ongoing use, such as operating destroy, drift monitoring, and CI pipelines.
  • Reference — Specifications of input files, the CLI, and internal data structures. A spec-style reference for fields, types, defaults, and examples.
  • Contributing — Guidance for those making changes to Tazuna, covering the development environment, testing, documentation, and releases.

Where to start

  • If you have never touched Tazuna before, we recommend working through Getting Started in order.
  • If you want to grasp the design background and terminology first, start from Concepts.
  • If you just want to look up the specification of a particular command or field, consult Reference like a dictionary.