Skip to content

Reference

The pages in this section are lookup material. They assume the model is already understood and are arranged for finding a field or a definition instead of reading through.

Document format
Every field of the Fleet, Host and Layer documents, the resource envelope, matcher syntax, merge rules, and the validation errors raised before a host is read.
Agent configuration
Every key in /etc/datum/agent.yaml, with its default, and the one file that decides how much a machine trusts Datum.
Command line interface
Implemented commands, their flags, output and exit codes, with notes where behaviour is still proposed.
Status
The implemented per-host status report and the proposed fleet-wide status model.
Interfaces and stability
Which interfaces become contracts, and when. Everything is unstable before 1.0.
Glossary
One entry per concept, with links to the page that specifies it, and a list of terms this documentation avoids.
State and lifecycle
Resource and host state vocabulary, including the proposed reboot states.
Provider support matrix
Implemented providers and their platform coverage.

Per-type field references

Fields specific to each resource type are listed under Resource types in this section.

Domain Type Reference
Core Package resources/types/package
Core Repository resources/types/repository
Core File resources/types/file
Core Directory resources/types/directory
Core Symlink resources/types/symlink
Identity User resources/types/user
Identity Group resources/types/group
Runtime Service resources/types/service
Kernel Sysctl resources/types/sysctl

Stability

The v1alpha1 schema carries no compatibility promise. Field names, defaults and semantics can change without a compatibility or migration promise until the schema reaches a stable version. See project status for implementation coverage.