Definitions

This section covers definition file authoring and code generation for Vector developers and contributing customers who extend or integrate Confµgami. Definition files describe the configuration schema model that downstream products and their end-users rely on.

TL;DR

Try it in the browser. The playground opens a definition and configuration sample holding one error to fix. Change the definition and see the configuration’s diagnostics and the merged result follow as you type.

Every sample in this manual has a Run button that opens it there.

Contents

  • Definition Development: a book style guide from the first definition to a reference manual, covering the type system, reuse, multi-file merging, annotations, and pitfalls.

  • Constraints: validate several values of a configuration.

  • Code Generation: Rust and Python bindings generated from definitions and how to consume them.

New to Confµgami? Read Getting Started first, it builds a working definition and configuration in four steps, then The Definition System for the model behind it. The remaining chapters are reference material.

For authoring configuration files against an existing definition, see How Configuration Files Work.