feat(demo): deploy/demo and the wipe + baseline workflows (step 5)
The public demo's deployment (docs/website/DEMO_MODE.md §7, §10 step 5): - deploy/demo/docker-compose.yml: the app and its database only, DEMO_MODE on, a /status healthcheck, the fixture mounted for seed:demo, MODULES read from state/modules.env so the workflow never edits the .env with secrets. - deploy/demo/.env.example: every variable the host needs, including BOT_INTERNAL_KEY (the app refuses to start in production without it) and MODULE_SOURCE_HOSTS (a fresh database's install allowlist). - deploy/demo/seed.json: the four logins, settings, two posts, a wiki page, a published "Server greeting" event on a Rust console step, the rig's server link and demo-player's Steam link; secrets as "$env:NAME". - deploy/demo/rig.mjs: plan (latest Rust bundle + newest Module-Rust on the same protocol, keeping the previous set when none matches), restore (kill, write a changed bundle, delete + unpack demo-baseline.tar.gz, start), baseline (power stop saves the world, DM22; compress, rename, start) and smoke (the site, then the rig reporting in), on the Pterodactyl client API. - .gitea/workflows/demo-wipe.yml: every 2 h on the hour UTC, on a push to deploy/demo/, and by hand; rig first, then down -v / pull / up / seed. - .gitea/workflows/demo-baseline.yml: by hand only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY
This commit is contained in:
42
.gitea/workflows/demo-baseline.yml
Normal file
42
.gitea/workflows/demo-baseline.yml
Normal file
@@ -0,0 +1,42 @@
|
||||
# Capture the demo rig's baseline (docs/website/DEMO_MODE.md §7.2). Run by hand,
|
||||
# after setting the demo default set up through the demo site: the permission
|
||||
# groups, a few NPCs, a clan for the demo's Team. It stops the rig (a power stop
|
||||
# runs `quit`, which saves the world, DM22), compresses oxide/data, oxide/config
|
||||
# and server/<identity> into demo-baseline.tar.gz at the server root, and starts
|
||||
# it again. Every wipe from then on restores that archive.
|
||||
#
|
||||
# Run it right after a wipe has finished and the default set is in place, not
|
||||
# while visitors are mid-change: whatever is on the rig is what every later
|
||||
# cycle returns to.
|
||||
|
||||
name: Demo baseline
|
||||
|
||||
on:
|
||||
workflow_dispatch: {}
|
||||
|
||||
concurrency:
|
||||
group: demo-rig
|
||||
cancel-in-progress: false
|
||||
|
||||
env:
|
||||
DEMO_DIR: ${{ vars.DEMO_DIR || '/opt/demo.runicgateway.com' }}
|
||||
PTERODACTYL_URL: ${{ vars.PTERODACTYL_URL || 'http://192.168.0.12' }}
|
||||
PTERODACTYL_SERVER: ${{ vars.PTERODACTYL_SERVER || '6eb9d621' }}
|
||||
NODE_IMAGE: node:22.23.4-alpine
|
||||
|
||||
jobs:
|
||||
baseline:
|
||||
runs-on: demo-site
|
||||
if: github.ref == 'refs/heads/main'
|
||||
steps:
|
||||
- name: Check out the deploy files
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Capture the baseline
|
||||
env:
|
||||
PTERODACTYL_CLIENT_KEY: ${{ secrets.PTERODACTYL_CLIENT_KEY }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
docker run --rm -v "$PWD/deploy/demo:/demo:ro" \
|
||||
-e PTERODACTYL_URL -e PTERODACTYL_SERVER -e PTERODACTYL_CLIENT_KEY \
|
||||
"$NODE_IMAGE" node /demo/rig.mjs baseline
|
||||
114
.gitea/workflows/demo-wipe.yml
Normal file
114
.gitea/workflows/demo-wipe.yml
Normal file
@@ -0,0 +1,114 @@
|
||||
# The public demo's wipe (docs/website/DEMO_MODE.md §7). Every 2 hours on the
|
||||
# hour, UTC (DM7), it puts demo.runicgateway.com and its Rust server back to the
|
||||
# demo's starting point:
|
||||
#
|
||||
# 1. versions the latest Rust bundle and the newest Module-Rust release on the
|
||||
# same protocol (§7.5, DM12)
|
||||
# 2. the rig FIRST: kill, write the new bundle if it changed, restore
|
||||
# demo-baseline.tar.gz, start (§7.2). A fresh site imports what is
|
||||
# on the rig, so the rig must be back before the site talks to it (§7.1)
|
||||
# 3. the site down -v, pull, up, seed:demo (§7.3)
|
||||
# 4. smoke the site answers, then the rig reports in (bounded)
|
||||
#
|
||||
# A redeploy is the same path: a push to main that changes deploy/demo/ runs it,
|
||||
# and so does workflow_dispatch (§7.4).
|
||||
#
|
||||
# Runs on the `demo-site` runner, in host mode, on the demo host itself. The host
|
||||
# needs Docker with Compose, and node for actions/checkout; everything else runs
|
||||
# in containers. One-time host setup: deploy/demo/README.md.
|
||||
#
|
||||
# Secret: PTERODACTYL_CLIENT_KEY the demo subuser's client key (file + power)
|
||||
# Variables: PTERODACTYL_URL, PTERODACTYL_SERVER (defaults below), DEMO_DIR
|
||||
|
||||
name: Demo wipe
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 */2 * * *'
|
||||
workflow_dispatch: {}
|
||||
push:
|
||||
branches: [main]
|
||||
paths:
|
||||
- 'deploy/demo/**'
|
||||
- '.gitea/workflows/demo-wipe.yml'
|
||||
|
||||
# A wipe and a baseline capture must never overlap: both stop the rig.
|
||||
concurrency:
|
||||
group: demo-rig
|
||||
cancel-in-progress: false
|
||||
|
||||
env:
|
||||
DEMO_DIR: ${{ vars.DEMO_DIR || '/opt/demo.runicgateway.com' }}
|
||||
PTERODACTYL_URL: ${{ vars.PTERODACTYL_URL || 'http://192.168.0.12' }}
|
||||
PTERODACTYL_SERVER: ${{ vars.PTERODACTYL_SERVER || '6eb9d621' }}
|
||||
NODE_IMAGE: node:22.23.4-alpine
|
||||
|
||||
jobs:
|
||||
wipe:
|
||||
runs-on: demo-site
|
||||
if: github.ref == 'refs/heads/main'
|
||||
steps:
|
||||
- name: Check out the deploy files
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install the deploy files
|
||||
# Everything but .env, which only the host holds, and state/, which the
|
||||
# wipe itself writes.
|
||||
run: |
|
||||
set -euo pipefail
|
||||
test -f "$DEMO_DIR/.env" || { echo "::error::$DEMO_DIR/.env is missing; see deploy/demo/README.md"; exit 1; }
|
||||
mkdir -p "$DEMO_DIR/state" "$DEMO_DIR/logs" "$DEMO_DIR/modules"
|
||||
# The app runs as uid 1000 and unpacks the declared module into ./modules.
|
||||
chown 1000:1000 "$DEMO_DIR/modules" "$DEMO_DIR/logs" 2>/dev/null || true
|
||||
cp deploy/demo/docker-compose.yml deploy/demo/seed.json deploy/demo/rig.mjs "$DEMO_DIR/"
|
||||
|
||||
- name: Decide the versions
|
||||
run: |
|
||||
set -euo pipefail
|
||||
docker run --rm -v "$DEMO_DIR:/demo" -e STATE_DIR=/demo/state "$NODE_IMAGE" node /demo/rig.mjs plan
|
||||
|
||||
- name: Restore the rig
|
||||
id: rig
|
||||
# The site is wiped even when this fails: a demo left un-wiped is worse
|
||||
# than one whose rig kept a visitor's changes for a cycle. The last step
|
||||
# fails the run so the failure is seen.
|
||||
continue-on-error: true
|
||||
env:
|
||||
PTERODACTYL_CLIENT_KEY: ${{ secrets.PTERODACTYL_CLIENT_KEY }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
docker run --rm -v "$DEMO_DIR:/demo" -e STATE_DIR=/demo/state \
|
||||
-e PTERODACTYL_URL -e PTERODACTYL_SERVER -e PTERODACTYL_CLIENT_KEY \
|
||||
"$NODE_IMAGE" node /demo/rig.mjs restore
|
||||
|
||||
- name: Wipe and reseed the site
|
||||
run: |
|
||||
set -euo pipefail
|
||||
cd "$DEMO_DIR"
|
||||
docker compose pull
|
||||
docker compose down -v --remove-orphans
|
||||
docker compose up -d
|
||||
for attempt in $(seq 1 60); do
|
||||
STATUS="$(docker inspect -f '{{.State.Health.Status}}' rg-demo-app-1 2>/dev/null || echo starting)"
|
||||
[ "$STATUS" = healthy ] && break
|
||||
sleep 5
|
||||
done
|
||||
if [ "$STATUS" != healthy ]; then
|
||||
echo "::error::the app did not become healthy within 300s"
|
||||
docker compose logs --tail 100 app
|
||||
exit 1
|
||||
fi
|
||||
docker compose exec -T app npm run --silent --prefix server seed:demo -- /app/deploy/demo/seed.json
|
||||
docker compose ps
|
||||
|
||||
- name: Smoke check
|
||||
run: |
|
||||
set -euo pipefail
|
||||
docker run --rm --network rg-demo_default -v "$DEMO_DIR:/demo" \
|
||||
-e SITE_URL=http://app:3000 "$NODE_IMAGE" node /demo/rig.mjs smoke
|
||||
|
||||
- name: Report the rig restore
|
||||
if: steps.rig.outcome == 'failure'
|
||||
run: |
|
||||
echo "::error::the rig restore failed (see its step); the site was wiped and reseeded anyway"
|
||||
exit 1
|
||||
Reference in New Issue
Block a user