bstein/ariadne
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
bstein 2026-06-19 20:43:38 +00:00
parent 02858ccafa
commit e67c057a52
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,21 +2,15 @@
Ariadne is the Atlas admin and account automation service. Ariadne is the Atlas admin and account automation service.
It sits behind the portal and handles the jobs that are annoying or risky to do It sits behind the portal and handles the jobs that are annoying or risky to do by hand: approving access, syncing account state, rotating service passwords, cleaning stale Kubernetes work, checking platform health, and keeping a few service integrations lined up.
by hand: approving access, syncing account state, rotating service passwords,
cleaning stale Kubernetes work, checking platform health, and keeping a few
service integrations lined up.
## How it works ## How it works
Ariadne is a FastAPI service with a small scheduler. It talks to Keycloak, Ariadne is a FastAPI service with a small scheduler. It talks to Keycloak, Vault, Mailu, Nextcloud, Wger, Firefly, Jenkins, Metis, Kubernetes, and a few Atlas-specific services through focused adapters under `ariadne/services/`.
Vault, Mailu, Nextcloud, Wger, Firefly, Jenkins, Metis, Kubernetes, and a few
Atlas-specific services through focused adapters under `ariadne/services/`.
The API is split between admin routes, account self-service routes, internal The API is split between admin routes, account self-service routes, internal event hooks, and Prometheus metrics. Background jobs store run history in the Ariadne database so failures can be inspected later instead of vanishing into logs.
event hooks, and Prometheus metrics. Background jobs store run history in the
Ariadne database so failures can be inspected later instead of vanishing into The following are notes for future Brad.
logs.
Useful routes: Useful routes:
@ -36,6 +30,4 @@ python -m pytest
ruff check . ruff check .
``` ```
Most runtime behavior is configured through environment variables in Most runtime behavior is configured through environment variables in `ariadne/settings.py`. Service-specific logic is in the small adapter modules; `ariadne/app.py` is focused on request flow and task orchestration.
`ariadne/settings.py`. Keep service-specific logic in the small adapter modules;
`ariadne/app.py` should stay focused on request flow and task orchestration.