1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

docs: add note about upgrading to version 5.7 and above (#6464)

Upgrading to 5.7 and above from earlier versions is a little
problematic. Let's document it.

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
This commit is contained in:
Thomas Heartman 2024-03-11 09:13:57 +01:00 committed by GitHub
parent c98b5ad64f
commit 62a7633ed5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -5,6 +5,14 @@ import VideoContent from '@site/src/components/VideoContent.jsx'
Generally, the intention is that `unleash-server` should always provide support for clients one major version lower than the current one. This should make it possible to upgrade `unleash` gradually. Generally, the intention is that `unleash-server` should always provide support for clients one major version lower than the current one. This should make it possible to upgrade `unleash` gradually.
## Upgrading to 5.7 and later from versions < 5.6.11
When running on high-availability (multiple Unleash instances), upgrading from versions lower than 5.6.11 to version 5.7 or higher will cause a temporary UI unavailability while old versions and new versions are both serving traffic, due to a compatibility issue. If you can afford having a small period of time with the UI unavailable (note the SDKs will not be affected), then you can safely upgrade.
If you rather want to avoid that, you should first update to 5.6.11 and ensure all your Unleash instances are running 5.6.11 before upgrading to 5.7 or later. Any Unleash instances left on earlier versions after the backing database has been updated will continue to work, but you will not be able to log in to them, but the SDKs will continue working fine.
Once you have upgraded to version 5.7 and above, you can no longer downgrade to versions before 5.7 without manual changes to the database.
## Upgrading directly from v3.x to v5.x ## Upgrading directly from v3.x to v5.x
<VideoContent videoUrls={["https://www.youtube.com/embed/qmusq_9mE2E"]}/> <VideoContent videoUrls={["https://www.youtube.com/embed/qmusq_9mE2E"]}/>