Repository navigation
docs(nas): the snapshot task is non-recursive because of what erebor/apps/home is (#484) - #561
Merged
Merged
Conversation
…or/apps/home is, not because it does not exist (#484) §4.1 said Recursive is off because nothing beneath erebor/apps is a dataset. Since 2026-09-19 21:53 one is: erebor/apps/home, which TrueNAS made a child dataset when §6.2 step 1 gave frodo a home directory there — and that step said "nothing new is created for it". Read from smaug: the child holds frodo's shell files and authorized key and nothing Jellyfin writes; jellyfin/config is a directory on erebor/apps itself, so a non-recursive snapshot freezes everything scripts/backup-nas.sh reads. The setting is right; both sentences were wrong, and now say why it is right — a recursive task would only be snapshotting an authorized key, and a child's snapshot is not visible in the parent's .zfs/snapshot/ anyway. Nothing on smaug is changed. Found while diagnosing why the first pull found no snapshots: the task itself has never run, which the operator owns. Refs #484. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
Two sentences in
docs/runbooks/build-the-nas.md. §4.1's snapshot-task table said Recursive is off because "nothing beneath it is a dataset"; §6.2 step 1 said givingfrodoa home undererebor/appsmeans "nothing new is created for it". Both are false since 2026-09-19 21:53, when TrueNAS madeerebor/apps/homea child dataset for that user. Both now say what the child is, what it holds, and why the setting is still right.Why
Read from
smaugwhile diagnosing the firstmake backup-nasfailure:erebor/apps/homeholdsfrodo's shell files and authorized key, nothing Jellyfin writes;jellyfin/configis a directory onerebor/appsitself. A non-recursive snapshot therefore freezes everythingscripts/backup-nas.shreads, and a recursive one would buy nothing — a child's snapshot is not visible in the parent's.zfs/snapshot/. The runbook's setting was right for a reason it did not state, and a reader checking its stated reason againstzfs listwould have concluded the task was misconfigured.The reason the pull failed is separate and the operator's: the periodic task has never produced a snapshot. Refs #484.
Blast radius
None. A runbook. Nothing on
smaugis changed, and the recommended setting does not change.secrets/*.sops.yamlVerification
make lintandscripts/check_docs.pypass🤖 Generated with Claude Code