Skip to content

Reference

Lookup material rather than reading material. Nothing here is a narrative — if
you are trying to do something, start from Deploy
or Operations instead and let it send you here.

Hardware definitions

The schema that hardware is described with, shared by Nautobot and Ironic:

These are the definitions. For the operator procedures that use them, see
Device Types and
Flavors under Operations.

Components

A component is an ArgoCD Application generated by
charts/argocd-understack. One page per component, listing its sources, scope
and values:

  • Component Reference — the index, with
    every component and whether it deploys to a global or site cluster.

Configuration samples

Workflow templates

The Workflow Templates group in the navigation is generated at build time
from the Argo WorkflowTemplate definitions in workflows/ and
components/global-workflows/ — one page per template, showing its parameters
and the steps it runs. Enroll Server is the one
to read first, since server enrolment drives most of the others.

Because those pages are generated, they are not committed. Edit the
WorkflowTemplate YAML and re-run make wftmpls; do not edit the pages.

Elsewhere

  • Release Notes — what changed between versions, and
    what an operator has to do about it.
  • JSON schemas for deploy-repository files are published at /schema/, and are
    referenced directly by $schema= URLs in examples/deploy-repo/.