docs: add a backup and restore guide#709
Open
viniciusdc wants to merge 5 commits into
Open
Conversation
Add a how-to guide for Longhorn backup and restore: enabling off-cluster backups, confirming they are running, restoring a volume within a cluster, and recovering a JupyterHub user's home on a new cluster. Register it in the sidebar and cross-link from the Hetzner provider page.
✅ Deploy Preview for nebari-docs2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… notes Show static S3 keys in the enable example and present keyless EKS Pod Identity as the alternative rather than the default. Add a note that retention pruning never affects the backups you keep, and a prerequisite that backups apply to Longhorn-backed clusters.
…to backup guide Lead the guide with the opt-in fact (Longhorn backups stay off until a backups.longhorn block is added). Flag that Azure targets are not yet functional and fail nic validate. Surface retain_on_destroy in the example and warn that setting it false deletes the backup bucket on destroy. Link the annotated example config and note the *_env pair validation rule.
Move the Azure note up to the target-choice point before the YAML so it no longer stacks against the existing-cluster warning. Replace the em dashes reintroduced in the last commit with plain punctuation, and split the dense post-YAML paragraph so the reference and example-config links read cleanly.
tylerpotts
approved these changes
Jul 24, 2026
tylerpotts
left a comment
tylerpotts
left a comment
There was a problem hiding this comment.
Read through this and it looks good. Thanks for the docs!
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
2 participants
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.
Reference Issues or PRs
Documents the native Longhorn backups feature (
backups.longhorn) added in nebari-dev/nebari-infrastructure-core#443.What does this implement/fix?
A new how-to guide (
how-tos/backup-restore) covering how to enable off-cluster Longhorn backups, confirm they are running, restore a volume within a cluster, and recover a JupyterHub user's home on a new cluster.It complements the in-repo configuration reference (
docs/longhorn-backups.mdin nebari-infrastructure-core): this page owns the workflows and the JupyterHub cross-cluster recovery contract, while the in-repo doc stays the exhaustive schema reference. The page shows one minimal, tested enable example and links out for the full schema, rather than duplicating it.Testing
Every workflow on the page was run against a live EKS cluster, including a cross-cloud disaster-recovery drill (AWS to Hetzner) that recovered a user's home from an S3 backup and confirmed the user could log in through Keycloak and open their notebooks in a fresh singleuser session.
Documentation
docs/docs/how-tos/backup-restore.mdx.docs/sidebars.js.Follow-up (non-blocking): the same-cluster restore runbook also lives in the in-repo
docs/longhorn-backups.md. Worth later trimming that copy to a link so there is one canonical home for the procedure.Access-centered content checklist
title, no stray H1).