Skip to content

Reference

Authoritative shape-of-the-world docs. Every public surface OrbitalReg exposes is documented here.

TopicUse when
REST APIWriting a custom client or wiring an external system to events
API explorerBrowsing every endpoint, parameter and schema interactively
API code samplesCopy-paste curl / Python / Go / JavaScript snippets per operation
Environment variablesConfiguring a single-binary deployment
Helm chart valuesConfiguring a Kubernetes deployment
Terraform providerManaging OrbitalReg state from Terraform
GitLab CI componentsWiring uploads / scans / promotion gates into a GitLab pipeline
orbital CLIInstalling, configuring, and verifying the official orbital CLI
orbital migrateReference for the migrate plan / apply / verify / finalize suite

If you're looking for conceptual documentation, start at Core concepts. If you're looking for runbooks for specific operational tasks, see Operations.

Released under the Apache-2.0 License.