2.8 KiB
title, description, weight, type, cascade
| title | description | weight | type | cascade | ||
|---|---|---|---|---|---|---|
| Documentation of the apex fleet operations framework | Documentation for the apex fleet operations framework: a stdlib-python engine and a shared compose core for self-hosted nodes. | 1 | docs |
|
apex is the commons of a fleet of self-hosted nodes: a python3-stdlib engine that runs grouped actions as apex <group>/<action>, paired with a shared, ${env}-parameterized docker-compose core. Every node repository consumes the framework as the pinned commons/ git submodule. apex succeeds the bash root commons framework.
The stack is deliberately small: git plus the Python 3 standard library. There is no pip, Node, Go, or CUE, and compose files are hand-authored — no code generation.
Core features
- Single entrypoint on the local checkout —
apexalways acts on the checkout it runs from; there is no<node>argument to pass. - Explicit identity from
node.env— node identity is declared per node innode.env(APEX_NODE_FQDN,APEX_NODE_HOST,APEX_SUBNET); the framework assumes no particular domain, and the short nodenameis just the first label of the host. - Four-pillar node repositories — every node repository follows the same shape: the pinned
commons/submodule, node-local proprietaries, the node's compositions, and itsnode.env. - Proprietary overlay — node-local proprietaries are overlaid over the shared actions; commons holds only what every node shares.
- Tiered storage with privilege isolation — standardized storage tiers with per-project privilege isolation.
- Shared core composition — the core composition (
compositions/apex/docker-compose.yml) is${env}-parameterized and included in every node's compositions.
Sections
{{% cards %}} {{< card link="getting-started" title="Getting started" icon="map" subtitle="Prerequisites, bootstrap, and the first actions on a fresh node." >}} {{< card link="concepts" title="Concepts" icon="book-open" subtitle="Architecture, identity, the overlay, and the storage model." >}} {{< card link="guides" title="Guides" icon="map" subtitle="Task-oriented guides for operating and extending a node." >}} {{< card link="reference" title="Reference" icon="code" subtitle="Actions, the engine helper library, and exit codes." >}} {{< card link="troubleshooting" title="Troubleshooting" icon="shield-check" subtitle="Symptoms, diagnosis, and fixes for common failures." >}} {{% /cards %}}
See also: