Automation Overview¶
This directory is the operational source of truth for the self-hosted services running under /home/steam.
The automation layer standardizes four things:
- app registration under
/home/steam/automation/apps/*.conf - deploy and status operations through
/home/steam/automation/deployctl.sh - dashboard-driven operations through the Jenkins stack in
/home/steam/automation/jenkins - host integration points such as nginx reverse proxy config and systemd timers
This docs set is now intended to be hosted as a static site behind nginx at docs.ilgaming.xyz.
What lives here¶
deployctl.sh: common deploy, restart, status, health, rollback, and hosted-image check entrypointapps/*.conf: one deployment contract per managed apponboard-managed-app.sh: low-friction onboarding helper for new appsjenkins/: Jenkins controller, JCasC seed jobs, init scripts, and job-generation helpersystemd/: host maintenance timers and servicesdocs-site/: containerized static site runtime for publishing these docs on the VM
How to preview these docs¶
cd /home/steam/automation
python3 -m venv .venv
. .venv/bin/activate
pip install -r docs-requirements.txt
mkdocs serve
Fast path¶
If you only need one answer quickly:
- deployment and runtime model: see
Architecture - current estate audit and cleanup plan: see
Estate Audit - full list of what physically exists under
/home/steam/apps: seeApp Inventory - current registered apps and ports: see
Managed Apps - what the Jenkins jobs mean: see
Jenkins - platform auth and shared login direction: see
Platform Auth - how to add a new app: see
Onboarding - how to author
.ilgaming-onboard.jsoncorrectly: seeManifest Authoring - backup, rollback, image updates, and nginx caveats: see
Runbooks - current VM host layout and infrastructure conventions: see
VM Box