recovery: give the incident tooling a permanent home (scripts/recovery/)
The 2026-08-03 cc-ci outage was recovered with ad-hoc tooling living in /tmp (leftover from a PREVIOUS incident, half-evaporated). Promoted to the repo: - scripts/recovery/hetzner.py — Hetzner API helper (status/actions/reboot/reset/ power/rescue-on|off/console), knows cc-ci=134485294 + orchestrator=134487234 by name; token from HCLOUD_TOKEN or /srv/cc-ci/.hcloud-token (0600, never in git). - scripts/recovery/hetzner-console.sh — shell-only VGA console: fresh console session -> websocat bridge -> vncdotool (venv auto-bootstrapped in ~/.cache). screenshot / key / type subcommands; encodes the reset-invalidates-session and single-connection-bridge gotchas. - scripts/recovery/README.md — the condensed 10-minute unreachable-server drill, incl. the GRUB submenu 1>N ids + clear-grubenv-after-switch rule. - hetzner-server-recovery skill: console/API sections now point at the repo tools instead of describing /tmp rebuilds. Smoke-tested: hetzner.py cc-ci status OK.
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# Recovery tooling — permanent home
|
||||
|
||||
Promoted from `/tmp` ad-hocery after the 2026-08-03 cc-ci 26.05 outage (see
|
||||
`.cc-ci-logs/server-update-2026-08-03.md` and the `hetzner-server-recovery` skill, which is
|
||||
the *procedure*; these are the *tools* it uses).
|
||||
|
||||
| Tool | What it does |
|
||||
|---|---|
|
||||
| `hetzner.py <server> <cmd>` | Hetzner Cloud API: status, actions, reboot/reset/poweroff/poweron, rescue-on/off, console credentials. Knows `cc-ci` (134485294) and `orchestrator` (134487234) by name. |
|
||||
| `hetzner-console.sh <server> screenshot\|key\|type` | Shell-only access to the VGA console: fresh console session → websocat bridge → vncdotool (venv auto-bootstrapped at `~/.cache/hetzner-console-venv`). |
|
||||
|
||||
**Token:** `HCLOUD_TOKEN` env, or `/srv/cc-ci/.hcloud-token` (chmod 600). Not in git, not in
|
||||
`.testenv`. Prefer per-incident tokens and revoke after — and never paste tokens into chat
|
||||
transcripts (the 2026-08-03 incident token was pasted mid-incident and had to be flagged for
|
||||
rotation).
|
||||
|
||||
## The 10-minute unreachable-server drill (condensed from 2026-08-03)
|
||||
|
||||
1. `hetzner.py cc-ci status` — "running" + no SSH/ping means booted-but-broken, not crashed.
|
||||
2. `hetzner-console.sh cc-ci screenshot /tmp/console.png` — look at the actual screen: which
|
||||
generation booted? login prompt or emergency shell?
|
||||
3. Plain `reboot` first. If the default boot is the broken generation, DON'T fight GRUB
|
||||
timing over VNC — go to rescue:
|
||||
`rescue-on` → `poweroff` → wait `status=off` → `poweron` → `ssh root@<public-ip>` (key
|
||||
113082420 = `~/.ssh/cc-ci-root-ed25519`; fresh `UserKnownHostsFile`).
|
||||
4. In rescue: `mount /dev/sda1 /mnt` and fix the boot default:
|
||||
- Generations live in a GRUB **submenu**: entry ids are `1>N` (top level: 0 = default
|
||||
entry, 1 = the submenu). A bare index like `2` silently falls back to the broken default.
|
||||
- Persistent: `grub-editenv /mnt/boot/grub/grubenv set 'default=1>N'` (survives reboots).
|
||||
- **Clear it after the next successful `nixos-rebuild switch`** — the regenerated grub.cfg
|
||||
shifts indices and a stale override points at the wrong generation.
|
||||
- Journal of the failed boot: `journalctl -D /mnt/var/log/journal --list-boots` / `-b <id>`.
|
||||
5. `rescue-off` → `poweroff` → `poweron` → verify → write the incident up in
|
||||
`cc-ci-plan/JOURNAL.md` and (if server) `.cc-ci-logs/`.
|
||||
|
||||
**Prevention:** `nixos-rebuild test` before `switch`, always (see AGENTS.md / the update
|
||||
skills) — `test` leaves the bootloader alone, so a power-cycle recovers by itself.
|
||||
Executable
+76
@@ -0,0 +1,76 @@
|
||||
#!/usr/bin/env bash
|
||||
# hetzner-console.sh — drive a Hetzner web-console (raw VNC over websocket) from a shell.
|
||||
# The screenshot/keyboard half of hetzner-server-recovery; proven in the 2026-08-03
|
||||
# cc-ci 26.05 outage (console screenshots identified the wrong-generation boot).
|
||||
#
|
||||
# Usage:
|
||||
# hetzner-console.sh <server> screenshot <out.png>
|
||||
# hetzner-console.sh <server> key <key> [key ...] # e.g. key Down Down Return
|
||||
# hetzner-console.sh <server> type "<text>"
|
||||
#
|
||||
# <server> = name/id understood by hetzner.py. Each invocation requests a FRESH console
|
||||
# session (they are cheap, and hard resets invalidate old ones), bridges it to a local
|
||||
# TCP port with websocat, and runs vncdo against it. The bridge is single-connection —
|
||||
# that is why every command re-requests + re-bridges.
|
||||
#
|
||||
# Gotchas encoded here so nobody rediscovers them at 2am:
|
||||
# - The wss_url from the API contains literal '&' — when it arrives via JSON it may be
|
||||
# &-escaped; parse the JSON properly (as below), never paste from raw output.
|
||||
# - A hard `reset` drops the console websocket mid-session: re-request and reconnect.
|
||||
# - GRUB menus: generations live in a SUBMENU — one-shot boot ids are "1>N", and any
|
||||
# persistent grubenv `default` must be cleared after the next switch regenerates
|
||||
# grub.cfg (indices shift). See the hetzner-server-recovery skill.
|
||||
set -o errexit -o nounset -o pipefail
|
||||
|
||||
HERE="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"
|
||||
SERVER="${1:?usage: hetzner-console.sh <server> screenshot|key|type ...}"
|
||||
CMD="${2:?need a command: screenshot|key|type}"
|
||||
shift 2
|
||||
|
||||
PORT="${CONSOLE_PORT:-5905}"
|
||||
VENV="${HOME}/.cache/hetzner-console-venv"
|
||||
|
||||
# 1. vncdotool venv (bootstrap once; durable across incidents, unlike /tmp)
|
||||
if [ ! -x "${VENV}/bin/vncdo" ]; then
|
||||
echo "bootstrapping vncdotool venv at ${VENV}..." >&2
|
||||
python3 -m venv "${VENV}"
|
||||
"${VENV}/bin/pip" -q install vncdotool
|
||||
fi
|
||||
|
||||
# 2. fresh console session
|
||||
CREDS="$(python3 "${HERE}/hetzner.py" "${SERVER}" console)"
|
||||
WSS="$(printf '%s' "${CREDS}" | python3 -c 'import json,sys; print(json.load(sys.stdin)["wss_url"])')"
|
||||
PW="$(printf '%s' "${CREDS}" | python3 -c 'import json,sys; print(json.load(sys.stdin)["password"])')"
|
||||
|
||||
# 3. bridge (single-connection; killed on exit)
|
||||
pkill -f "websocat.*${PORT}" 2>/dev/null || true
|
||||
sleep 0.5
|
||||
nix shell nixpkgs#websocat -c websocat --binary "tcp-listen:127.0.0.1:${PORT}" "${WSS}" \
|
||||
> /tmp/hetzner-console-websocat.log 2>&1 &
|
||||
BRIDGE=$!
|
||||
trap 'kill ${BRIDGE} 2>/dev/null || true; pkill -f "websocat.*${PORT}" 2>/dev/null || true' EXIT
|
||||
sleep 2
|
||||
|
||||
# 4. run the vncdo command
|
||||
case "${CMD}" in
|
||||
screenshot)
|
||||
OUT="${1:?screenshot needs an output path}"
|
||||
timeout 40 "${VENV}/bin/vncdo" -s "127.0.0.1::${PORT}" -p "${PW}" capture "${OUT}"
|
||||
echo "captured ${OUT}"
|
||||
;;
|
||||
key)
|
||||
[ $# -ge 1 ] || { echo "key needs at least one key name" >&2; exit 1; }
|
||||
ARGS=()
|
||||
for k in "$@"; do ARGS+=(key "$k" pause 0.3); done
|
||||
timeout 60 "${VENV}/bin/vncdo" -s "127.0.0.1::${PORT}" -p "${PW}" "${ARGS[@]}"
|
||||
echo "sent: $*"
|
||||
;;
|
||||
type)
|
||||
TEXT="${1:?type needs text}"
|
||||
timeout 60 "${VENV}/bin/vncdo" -s "127.0.0.1::${PORT}" -p "${PW}" type "${TEXT}"
|
||||
echo "typed"
|
||||
;;
|
||||
*)
|
||||
echo "unknown command ${CMD} (screenshot|key|type)" >&2; exit 1
|
||||
;;
|
||||
esac
|
||||
Executable
+105
@@ -0,0 +1,105 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Hetzner Cloud recovery helper — the API half of hetzner-server-recovery.
|
||||
|
||||
Promoted to the repo 2026-08-04 after the cc-ci 26.05 outage recovery was done with
|
||||
ad-hoc tooling living in /tmp (which had evaporated from the previous incident).
|
||||
|
||||
Token: $HCLOUD_TOKEN, else the file $HCLOUD_TOKEN_FILE, else /srv/cc-ci/.hcloud-token
|
||||
(chmod 600; ask the operator for a token if absent — and prefer a per-incident token
|
||||
that gets revoked afterwards).
|
||||
|
||||
Usage:
|
||||
hetzner.py <server> status
|
||||
hetzner.py <server> actions [n] # recent actions, newest first
|
||||
hetzner.py <server> reboot|reset|poweroff|poweron
|
||||
hetzner.py <server> rescue-on [ssh_key_id ...] # then poweroff+poweron to enter it
|
||||
hetzner.py <server> rescue-off
|
||||
hetzner.py <server> console # prints wss_url + password (JSON)
|
||||
|
||||
<server> is a name from SERVERS below or a numeric Hetzner server id.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
SERVERS = {
|
||||
"cc-ci": 134485294, # the CI server (nixos, `ssh cc-ci`, tailnet 100.95.31.88)
|
||||
"orchestrator": 134487234, # this host (cc-ci-orchestrator-1, tailnet 100.84.190.30)
|
||||
}
|
||||
# SSH keys registered in the Hetzner project (for rescue-mode injection):
|
||||
# 113082219 cc-ci-deploy · 113082420 cc-ci-orchestrator-deploy (= ~/.ssh/cc-ci-root-ed25519)
|
||||
DEFAULT_RESCUE_KEYS = [113082219, 113082420]
|
||||
|
||||
|
||||
def token() -> str:
|
||||
tok = os.environ.get("HCLOUD_TOKEN")
|
||||
if not tok:
|
||||
path = os.environ.get("HCLOUD_TOKEN_FILE", "/srv/cc-ci/.hcloud-token")
|
||||
try:
|
||||
tok = open(path).read().strip()
|
||||
except OSError:
|
||||
sys.exit(
|
||||
"ERROR: no Hetzner token. Set HCLOUD_TOKEN, or put one in "
|
||||
f"{path} (chmod 600). Ask the operator; prefer a revocable per-incident token."
|
||||
)
|
||||
return tok
|
||||
|
||||
|
||||
def api(path: str, method: str = "GET", body: dict | None = None) -> dict:
|
||||
req = urllib.request.Request(
|
||||
"https://api.hetzner.cloud/v1" + path,
|
||||
method=method,
|
||||
headers={"Authorization": "Bearer " + token(), "Content-Type": "application/json"},
|
||||
data=json.dumps(body).encode() if body is not None else None,
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=30) as r:
|
||||
raw = r.read()
|
||||
return json.loads(raw) if raw.strip() else {}
|
||||
except urllib.error.HTTPError as e:
|
||||
sys.exit(f"ERROR: HTTP {e.code} on {method} {path}: {e.read()[:300]!r}")
|
||||
|
||||
|
||||
def main() -> None:
|
||||
if len(sys.argv) < 3:
|
||||
sys.exit(__doc__)
|
||||
server, cmd, args = sys.argv[1], sys.argv[2], sys.argv[3:]
|
||||
sid = SERVERS.get(server) or (int(server) if server.isdigit() else None)
|
||||
if sid is None:
|
||||
sys.exit(f"ERROR: unknown server {server!r} (known: {', '.join(SERVERS)} or numeric id)")
|
||||
|
||||
if cmd == "status":
|
||||
d = api(f"/servers/{sid}")["server"]
|
||||
print(
|
||||
f"status={d['status']} rescue_enabled={d.get('rescue_enabled')} "
|
||||
f"locked={d['locked']} public_ip={d['public_net']['ipv4']['ip']}"
|
||||
)
|
||||
elif cmd == "actions":
|
||||
n = int(args[0]) if args else 10
|
||||
for a in api(f"/servers/{sid}/actions?sort=started:desc&per_page={n}")["actions"]:
|
||||
print(a["started"], a["command"], a["status"], a["progress"])
|
||||
elif cmd in ("reboot", "reset", "poweroff", "poweron"):
|
||||
r = api(f"/servers/{sid}/actions/{cmd}", "POST")
|
||||
print(cmd, r["action"]["status"], r["action"]["started"])
|
||||
elif cmd == "rescue-on":
|
||||
keys = [int(k) for k in args] or DEFAULT_RESCUE_KEYS
|
||||
r = api(f"/servers/{sid}/actions/enable_rescue", "POST", {"type": "linux64", "ssh_keys": keys})
|
||||
print("enable_rescue", r["action"]["status"], "| root password:", r.get("root_password"))
|
||||
print("NOTE: rescue boots on the next power cycle — run poweroff, wait for status=off, poweron.")
|
||||
elif cmd == "rescue-off":
|
||||
r = api(f"/servers/{sid}/actions/disable_rescue", "POST")
|
||||
print("disable_rescue", r["action"]["status"])
|
||||
elif cmd == "console":
|
||||
r = api(f"/servers/{sid}/actions/request_console", "POST")
|
||||
print(json.dumps({"wss_url": r["wss_url"], "password": r["password"]}))
|
||||
else:
|
||||
sys.exit(f"ERROR: unknown command {cmd!r}\n{__doc__}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user