Repository navigation
docs(ups): say the UPS shutdown is armed and not proved (#574) - #1338
Merged
Merged
Conversation
security.md's mains-loss row said nothing shuts down on the UPS's signal, which stopped being true on 2026-09-23 when NUT went on morpheus and Saruman and smaug subscribed. network.md never listed the two NUT pass/block pairs built that day. Both now say what is built, and the runbook's step-7 row for security.md names what the visit changes next. Refs #574 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for this documentation-only clarification of UPS shutdown behavior and pending verification.
No open issues 🎉
What changed in this PR
This documentation-only PR aligns the UPS shutdown documentation with the existing NUT deployment for #574, distinguishing configured shutdown behavior from the proof and runtime measurement still pending. No host configuration or firewall rules change.
Changes:
- Clarifies that UPS shutdown is armed but unproved, with
trinitystill awaiting subscription. - Documents the existing NUT firewall pass/block pairs for
Sarumanandsmaug. - Updates the runbook’s post-verification documentation requirements and records the correction in the changelog.
| File | Description |
|---|---|
docs/security.md |
Corrects the mains-loss protection status and identifies remaining work. |
docs/runbooks/shut-down-on-the-ups.md |
Specifies documenting the proved sequence and measured runtime after verification. |
docs/network.md |
Records existing NUT access rules on both subscriber segments. |
docs/changelog.md |
Adds a dated record of the documentation corrections and outstanding proof. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
security.md's mains-loss row now says the UPS shutdown is armed and not proved. Before, it said nothing shuts down on the signal.network.mdnow lists the two NUT pass/block pairs to the gateway's own address on3493, one onigc0.30forSarumanand one onigc0.40forsmaug. The runbook's step-7 row forsecurity.mdnow names what the rack visit will change next. There is also a changelog entry. Documentation only: nothing on the lab changes.Why
Refs #574. The issue text predates ADR-0049. Since then:
hardware.mdrecords each host's power. Its Rack table has a Powered by column, andsmaugis on PDU outlet 3.SmartDriveUnsafeShutdownsGrowing.shut-down-on-the-ups.mdwere built on 2026-09-23.Two current-state documents had not caught up with that build, so they stated things that are no longer true.
What still owes the close is the rack visit, runbook §5–§7:
trinity) and steps 3.6–3.8upsmon -c fsdproofBlast radius
None on the hosts. The two NUT pairs
network.mdnow describes were built on 2026-09-23, and theSarumanpass was re-made for.20on 2026-11-07. This PR only writes them down.secrets/*.sops.yamlVerification
python scripts/check_docs.py: docs OK (159 Prometheus + 20 Loki rules, 8 dashboards)../scripts/lint.sh: passed, but 11 checks were skipped, not run: markdownlint-cli2, shellcheck, actionlint, zizmor, packer ×2, tofu ×3, ansible-lint and editorconfig-checker. There was no docker daemon or pipx on this Windows box. yamllint and ruff passed using local binaries, not the pinned versions. CI's markdownlint is the real check for this diff.make validate: not run, for the same reason.Grep of the current-state docs for "nothing shuts down": the only hit left is the rewritten runbook step-7 row.
TrueNAS API, 2026-11-09:
smaugreports no active alerts. Its UPS reporting graphs hold no data points, which is expected for a NUT secondary and doesn't show whether it is subscribed.Not run:
upsc -c mjolnir@localhostonmorpheus, which would show whethersmauglogged in again after the 2026-11-06 rack move.make validatepassesDeployed to the lab and confirmed working
Docs updated (
docs/, service README, ordocs/roadmap.md)🤖 Generated with Claude Code