Reference

Exact descriptions of the GitOps objects, the command line tools and the REST API.

The reference pages list facts: fields, defaults, flags, codes and limits. They describe the system and do not explain or instruct. For explanations see the concepts, for instructions the how-to guides.

PageContent
GitOps schemaEvery field of Fleet, Blueprint, RolloutPolicy, Executor and Inventory, the sample agent format, the template functions, selector operators, limits, the myrctl exit codes and JSON output, and the table of issue codes.
Command line referenceOne page per command of myriarchd, myrctl, myriarch-updater and myriarch-sim, generated from the commands themselves.
REST APIThe management API under /api/v1, generated from the OpenAPI 3.1 contract api/openapi.yaml: authentication, roles, error format, one page per tag with every operation and its permission, and the data types.
Helm chart and valuesInstallation, profiles, network policy, storage and the configuration values of the chart myriarch.
Collector chart and valuesModes, Pod Security, OpenShift, container mode and the values of the chart myriarch-collector.
Server configurationEvery key of the myriarchd configuration file with its type, default and effect, generated from the configuration struct and its doc comments.
Environment variablesThe MYRIARCH_* overrides of the configuration keys, the other variables the programs read and the variables of the deployment templates.
MetricsThe Prometheus metrics of myriarchd and myriarch-sim with type, labels and help text, and how to reach the endpoint.
Design contractsThe normative descriptions of version selection, the updater protocol, container mode and the OpAMP server.

Generated and checked references

The references are not written twice. Each one is generated from, or tested against, the source it describes, so that it cannot drift:

  • The command-line reference is generated from the command definitions with make docs-gen. A test and the docs gate fail when the committed pages differ from the generated output.
  • The GitOps schema is maintained by hand, and a test fails when a kind, field or option of the format is missing from it.
  • The REST API reference is generated from api/openapi.yaml with make docs-gen. A test and the docs gate fail when the committed pages differ from the generated output. The types of the web UI are generated from the same file and checked for drift.
  • The server configuration reference is generated with make docs-gen from the configuration struct and its doc comments, the defaults and the loader. A test and the docs gate fail when the committed page differs from the generated output.
  • The environment variable reference is generated with make docs-gen from the environment overrides of the loader, the documented environment reads of the programs and the deployment templates. A test and the docs gate fail on drift, and a test fails when the code reads an environment variable that the page does not list.
  • The metrics reference is generated with make docs-gen from the metric definitions in the sources. A test and the docs gate fail on drift, and a server test compares the metrics that the running server exposes with the reference.
  • The values of the Helm chart are checked against a strict schema, deploy/helm/myriarch/values.schema.json, which make docs-gen assembles from a hand-written source and the configuration struct. A test and the docs gate fail on drift, and the tests of the chart fail when values.yaml or a template uses a value that the schema lacks.
  • The Helm chart page is the README of the chart. Its table of the values is generated with make docs-gen from values.schema.json and values.yaml.

myriarchd config print shows the effective configuration of a file with all defaults, and myriarchd config validate checks it, see myriarchd config validate.

GitOps schema reference

Every field of every GitOps object kind with its type and default, the template functions, selector operators, limits, myrctl exit codes and the table of issue codes.

CLI reference

Reference of every command and option of the myriarch binaries, generated from the command line definitions.

REST API

The OpenAPI 3.1 contract of the management API under /api/v1: authentication, roles, error format and every operation with its permission.

Helm chart and values

Installation, profiles, network policy, storage and the configuration values of the myriarch Helm chart.

Collector Helm chart and values

Modes, Pod Security, OpenShift, container mode and the configuration values of the myriarch-collector Helm chart.

Server configuration

Every key of the myriarchd configuration file, with its type, default and effect.

Environment variables

The environment variables that the server, the updater and the tools read.

Metrics

The Prometheus metrics of the server and the simulator, with type, labels and help text.