diff options
| author | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-04-06 21:45:59 +0200 |
|---|---|---|
| committer | Quentin Dufour <quentin@deuxfleurs.fr> | 2022-04-06 21:45:59 +0200 |
| commit | 8e3ee82c3e6370a0a5520f1abf60b09a3feb1050 (patch) | |
| tree | 81a732a46ba9a7e9e988812a668f18e5c784e702 | |
| parent | a122a8cb464e78e1b5f2454aef91f12d647b1b6c (diff) | |
| download | garage-doc/upgrading.tar.gz garage-doc/upgrading.zip | |
Be clearer on what upgrades are (not) supporteddoc/upgrading
| -rw-r--r-- | doc/book/cookbook/upgrading.md | 10 | ||||
| -rw-r--r-- | doc/book/working-documents/migration-06.md | 2 | ||||
| -rw-r--r-- | doc/book/working-documents/migration-07.md | 2 |
3 files changed, 4 insertions, 10 deletions
diff --git a/doc/book/cookbook/upgrading.md b/doc/book/cookbook/upgrading.md index 41e8b294..f7659921 100644 --- a/doc/book/cookbook/upgrading.md +++ b/doc/book/cookbook/upgrading.md @@ -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 diff --git a/doc/book/working-documents/migration-06.md b/doc/book/working-documents/migration-06.md index 60875b75..006b036b 100644 --- a/doc/book/working-documents/migration-06.md +++ b/doc/book/working-documents/migration-06.md @@ -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!** diff --git a/doc/book/working-documents/migration-07.md b/doc/book/working-documents/migration-07.md index d4ef4d9e..2d0444db 100644 --- a/doc/book/working-documents/migration-07.md +++ b/doc/book/working-documents/migration-07.md @@ -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!** |