Telecraft

Reference

These pages describe what exists: every binary and subcommand, every field of every authored file format, the layout of an estate repository, and the rules each loader applies. They're written for lookup. To be walked through a task, read the guides. For the model behind the vocabulary, read the concepts.

Every page comes from the code that ships. Field names, defaults, and validation rules match the loaders.

Vocabulary

The glossary defines the vocabulary. Terms such as Tier, Service Class, Blueprint, Component, Allow-list, Grant, and Exemption mean exactly what the glossary says, on every page.

Pages

Command line
Command line reference covers telecraft and its subcommands (observe, check, palette, render, serve, snapshot, delivery, passwd), plus catalogue-import, blueprint-check and register-check: what each does, its flags, defaults, and exit codes.
Repository layout
Estate layout covers the estate repository: the root files, the team directories, where each authored object lives, the generated rendered/ tree and CODEOWNERS, and which paths you write.
Authored formats
Blueprints, Tiers, Requirements, Allow-lists and Grants, and Exemptions each document one file format: every field, its type, whether it's required, its default, and what the loader rejects.
Sign-in
Sign-in covers auth.yaml: the providers an Instance offers, how each is configured, how a secret is named rather than carried, and the mapping from identity provider groups to Owners.
Running several Organisations
Organisation register format covers the register a deployment reads to run several Organisations: the record, the rules the loader applies, and register-check. A deployment running one Organisation needs none of it.
Catalogue
Catalogue covers the versioned inventory of otelcol component types: how Telecraft builds it from upstream metadata.yaml, the (class, type) key, artefact versioning, and importing with catalogue-import.

Conventions on these pages

  • Field tables give the authored YAML or JSON key, not the Go field name.
  • A field marked required is one whose absence fails the load.
  • "Load error" means the loader refuses the whole file or tree and returns nothing. "Finding" means the load succeeds and Telecraft reports the problem to an owner instead.
  • Placeholders in commands use upper snake case, such as ESTATE_DIR, and are explained where they first appear.