micropelago/garage
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Be clearer on what upgrades are (not) supported

Browse Source
This commit is contained in:
Quentin Dufour 2022-04-06 21:45:59 +02:00
parent a122a8cb46
commit 8e3ee82c3e
3 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/book/cookbook/upgrading.md
View File

@ -14,14 +14,8 @@ Following the [SemVer ](https://semver.org/) terminology, if only the *patch* nu
Example: an upgrade from v0.6.0 from v0.6.1 is a straightforward upgrade.
If the *minor* or *major* number changed however, you will have to do an advanced upgrade. Example: from v0.6.1 to v0.7.0.
Migrations are tested only from one stable version to another one, if you want to minimize your risks, you must ideally upgrade only to the direct next stable version, including patch ones.
Example: to go from v0.6.0 to v0.7.0, upgrade from v0.6.0 to v0.6.1 and then from v0.6.1 to v0.7.0.
Migrating from a minor version to another one without installing patch ones could work but are not tested, you must do your own tests in advance.
Example: going from v0.6.0 directly to v0.7.0 should work but is untested. Never, never, skip a minor or a major version.
Example: going from v0.6.0 directly to v0.8.0 is forbidden.
If you are very late in your upgrades, you should consider spawning a new cluster with the latest version and operate application level migrations
from the old cluster to the new one.
Migrations are designed to be run only between contiguous versions (from a *major*.*minor* perspective, *patches* can be skipped).
Example: migrations from v0.6.1 to v0.7.0 and from v0.6.0 to v0.7.0 are supported but migrations from v0.5.0 to v0.7.0 are not supported.
## Straightforward upgrades

2
doc/book/working-documents/migration-06.md
View File

@ -4,7 +4,7 @@ weight = 15
+++
**This guide explains how to migrate to 0.6 if you have an existing 0.5 cluster.
We don't recommend trying to migrate directly from older to 0.5.**
We don't recommend trying to migrate to 0.6 directly from 0.4 or older.**
**We make no guarantee that this migration will work perfectly:
back up all your data before attempting it!**

2
doc/book/working-documents/migration-07.md
View File

@ -3,7 +3,7 @@ title = "Migrating from 0.6 to 0.7"
weight = 14
+++
**This guide explains how to migrate to 0.7 if you have an existing 0.6 cluster.
We don't recommend trying to migrate directly from older to 0.6.**
We don't recommend trying to migrate to 0.7 directly from 0.5 or older.**
**We make no guarantee that this migration will work perfectly:
back up all your data before attempting it!**