Skip to content
Ordo

Reference

The reference covers the surfaces operators interact with directly. It is generated from the Ordo source (cargo xtask gen-reference) so it stays in step with each release.

  • CLI — every command exposed by the ordo, ordo-orchestrator, ordo-agent, and ordo-state binaries.
  • Management API — the orchestrator’s HTTP management API, rendered from its OpenAPI document.
  • State file format & configuration — machine-readable JSON Schemas are published for editor autocompletion and CI validation:
    • Module files — https://getordo.dev/schemas/module/v1.json
    • Orchestrator config — https://getordo.dev/schemas/orchestrator-config/v1.json
    • Agent config — https://getordo.dev/schemas/agent-config/v1.json

Using the schemas

Section titled “Using the schemas”

VS Code (Red Hat YAML extension) — add a modeline to the top of a module file:

# yaml-language-server: $schema=https://getordo.dev/schemas/module/v1.json

or associate a file pattern via the yaml.schemas setting.

JetBrains IDEs — map the file pattern to the schema URL under Languages & Frameworks → Schemas and DTDs → JSON Schema Mappings.