Skip to content

Runbooks

Standard deploy

For a managed app:

/home/steam/automation/deployctl.sh deploy <app-id>

If you need to skip the git or image pull step:

/home/steam/automation/deployctl.sh deploy <app-id> --skip-pull

Rollback

Rollback currently applies only to supported git-managed apps.

/home/steam/automation/deployctl.sh rollback mybibliotheca HEAD~1
/home/steam/automation/deployctl.sh rollback PingPal HEAD~1

The rollback deploy checks out automation-rollback/<app-id>. A later normal deploy returns the app to its configured branch.

Backups and restore verification

Current backup coverage:

  • Harmonious Accord PostgreSQL: /home/steam/apps/harmonious-accord/backups/postgres
  • Affine PostgreSQL: /home/steam/apps/affine/backups/postgres
  • KP Calorie Tracking MongoDB: /home/steam/apps/KPCalorieTracking/backups/mongodb
  • FiveM MariaDB: /home/steam/fivem/iLGServer/backups/mariadb (via fivem-mariadb-backup.timer)
  • FiveM Resources: /home/steam/fivem/iLGServer/backups/resources (via fivem-resources-backup.timer)

Verification jobs perform a real restore into throwaway containers. They are the proof that an archive is actually usable.

Hosted image update checks

Use the shared command or Jenkins job when you want to see whether upstream hosted stacks changed:

/home/steam/automation/deployctl.sh check-image-updates

An UNSTABLE Jenkins result here means updates are available. It does not mean the running app is down.

Nginx changes

Generated or edited site files live under /etc/nginx/sites-available and /etc/nginx/sites-enabled.

After a new site is written and syntax is validated, the remaining host step is still:

sudo systemctl reload nginx

Docs site deployment

The docs site has its own compose stack and local reverse-proxy target:

  • compose stack: /home/steam/automation/docs-site/docker-compose.yml
  • local port: 127.0.0.1:8086
  • public hostname: docs.ilgaming.xyz

To rebuild and republish the docs manually:

/home/steam/automation/deployctl.sh deploy automation-docs

Keycloak deployment

The shared auth service is managed as keycloak:

  • app directory: /home/steam/apps/keycloak
  • local port: 127.0.0.1:8420
  • public hostname: keycloak.ilgaming.xyz

Deploy or refresh it with:

/home/steam/automation/deployctl.sh deploy keycloak

Basic post-deploy checks:

/home/steam/automation/deployctl.sh health keycloak
/home/steam/automation/deployctl.sh status keycloak

Useful inspection commands

/home/steam/automation/deployctl.sh list
/home/steam/automation/deployctl.sh show <app-id>
/home/steam/automation/deployctl.sh status <app-id>
/home/steam/automation/deployctl.sh health <app-id>
/home/steam/automation/deployctl.sh revisions <app-id> 10