Operating an instance
An instance is a directory made by archi init. It is a git repository that
holds configuration, never data or secrets in git. The day-to-day work is
small:
| Task | Command or page |
|---|---|
| Is everything healthy? | archi doctor. See Doctor. |
| Start or stop the stack | archi up, archi down. See Data persistence. |
| Add a source | archi add <pack>. See Adding a source. |
| See what drifted from the install | archi diff |
| Check that the instance answers | archi eval. See archi eval. |
| Move to a newer Archi | Upgrade and migration |
| Run automations | archi ops. See the operations layer. |
| Something looks wrong | Footgun ledger |
More detail on each command is in What each command does. The settings files are described in archi.yaml.
What lives where
archi.yaml: the instance's settings.archi.lock: which bundle and pack versions were installed..env: the generated secrets and your source credentials, readable only by you, ignored by git.profiles/,deployments/: the rendered profile and the OKG deployment.- The data root (
~/.local/share/archi/<name>by default): connector caches and repository checkouts. It is outside the instance on purpose, becauseokg install --forcedeletes everything inside a deployment.
OKG publishes only from a committed repository. Commit changes to
archi.yaml and ops.yaml before the next publish.