docs(runbooks): light-enhance home-assistant-maintenance and index it
Rebase onto origin/main surfaced runbooks/home-assistant-maintenance.md (W1N-69) which predated the runbook reorg. Add Purpose/Scope/Safety headers and add it to the README routing index (now 17/17 consistent).
This commit is contained in:
@@ -17,6 +17,7 @@ runbooks start from [`_template.md`](_template.md).
|
|||||||
| RustDesk health check | [rustdesk-health.md](rustdesk-health.md) | read-only |
|
| RustDesk health check | [rustdesk-health.md](rustdesk-health.md) | read-only |
|
||||||
| Matrix health check | [matrix-health.md](matrix-health.md) | read-only |
|
| Matrix health check | [matrix-health.md](matrix-health.md) | read-only |
|
||||||
| AdGuard Home health check | [adguard-home-health.md](adguard-home-health.md) | read-only |
|
| AdGuard Home health check | [adguard-home-health.md](adguard-home-health.md) | read-only |
|
||||||
|
| Home Assistant maintenance | [home-assistant-maintenance.md](home-assistant-maintenance.md) | change (gated) |
|
||||||
| Routine Ansible operations | [ansible-operations.md](ansible-operations.md) | change (allowlisted) |
|
| Routine Ansible operations | [ansible-operations.md](ansible-operations.md) | change (allowlisted) |
|
||||||
| Linear issue → mergeable change | [issue-to-merge.md](issue-to-merge.md) | delivery |
|
| Linear issue → mergeable change | [issue-to-merge.md](issue-to-merge.md) | delivery |
|
||||||
| Failing health/playbook run | [fix-ci.md](fix-ci.md) | change |
|
| Failing health/playbook run | [fix-ci.md](fix-ci.md) | change |
|
||||||
|
|||||||
@@ -8,6 +8,32 @@ supervisor CLI**. All commands are wrapped by a single script
|
|||||||
[`scripts/ha-maintenance.sh`](scripts/ha-maintenance.sh); the sections below
|
[`scripts/ha-maintenance.sh`](scripts/ha-maintenance.sh); the sections below
|
||||||
document the exact commands it runs, for manual/agent use.
|
document the exact commands it runs, for manual/agent use.
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Run routine Home Assistant maintenance on `hass.windy.lan` (health snapshot,
|
||||||
|
config validation, log inspection, updates, and recovery) through the `ha`
|
||||||
|
supervisor CLI.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
Applies to `hass.windy.lan` only (HAOS, `machine: green`). Covers both
|
||||||
|
read-only checks and gated mutating operations; the "Command families
|
||||||
|
intentionally NOT scripted" table below lists what is deliberately out of
|
||||||
|
scope.
|
||||||
|
|
||||||
|
## Safety
|
||||||
|
|
||||||
|
- Prefer read-only checks first; the health snapshot mutates nothing.
|
||||||
|
- Every mutating mode (update / restart / rebuild / rollback / reboot /
|
||||||
|
backup / restore / add-on lifecycle) refuses to run without `--yes`.
|
||||||
|
- `--restore` overwrites the current installation; `--rollback-os`,
|
||||||
|
`--reboot`, and `--rebuild-core` are disruptive. Run them only from a
|
||||||
|
planned recovery with the backup verified.
|
||||||
|
- Never commit `SUPERVISOR_TOKEN` or a long-lived `HA_TOKEN`; read entity
|
||||||
|
state via Supervisor (`SUPERVISOR_TOKEN` after `sudo -n -i`).
|
||||||
|
- The `--restart-core` wrapper exits 1 silently on ssh failure — treat an
|
||||||
|
empty/exit-1 result as failure and confirm with `ha core info`.
|
||||||
|
|
||||||
## Access pattern
|
## Access pattern
|
||||||
|
|
||||||
`ha` authenticates to the Supervisor with `SUPERVISOR_TOKEN`. Interactive SSH
|
`ha` authenticates to the Supervisor with `SUPERVISOR_TOKEN`. Interactive SSH
|
||||||
|
|||||||
Reference in New Issue
Block a user