docs: add a safe Docker Compose upgrade runbook#5
Open
shanzez wants to merge 1 commit into
Open
Conversation
Add guides/upgrading.md: a step-by-step upgrade procedure that includes reviewing MIGRATION.md, taking a backup, applying the version bump, verifying, and rolling back from a backup if needed. Link it from the README's Updating section. Addresses the recurring upgrade questions upstream in huly-selfhost Signed-off-by: Exaviz <info@exaviz.com> #221, #91, and #51.
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
1 participant
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.
Closes #4.
Adds
guides/upgrading.md, a step-by-step safe upgrade procedure for Docker Compose deployments, and links it from the README's Updating section.Flow
review
MIGRATION.md-> backup -> stop ->git pull-> setHULY_VERSION->docker compose pull->up -d-> verify -> roll back from the backup if it fails.Fills the gap between the existing terse "Updating" steps and what operators actually need to upgrade confidently (backup-first, verification, and a rollback path).
Note
The backup/restore steps reference
backup.sh/restore.shfrom #2 (Compose backup/restore). Best merged after, or alongside, that PR.Contributed by Exaviz (exaviz.com).