Reference
Reference
Where the details are, as the code defines them. The command line, the configuration files, the controller types and what leaves your network are generated from the code by tools/docgen, and CI fails when they differ from it.
| What | Where |
|---|---|
| Every command and flag of each binary | Command line, which each binary also prints with -h |
| The settings of an installed orchestrator or witness | orchestrator.env.example and witness.env.example |
| The configuration file, and the secrets providers file | Configuration files; complete examples in the demo lab’s qfence-lab.yaml and the swarm lab’s qfence-swarm.yaml |
| The controller types an orchestrator knows, and their capabilities | Controller types, which a running orchestrator also serves at GET /api/v1/controllers/types |
| The REST API every orchestrator serves | The REST API |
| The external controller protocol | The controller protocol |
| A controller type’s manifest | controller-type.v1.json |
| What an orchestrator sends to a hosted plane | What leaves your network |