diff --git a/src/docs/self-hosted/releases.mdx b/src/docs/self-hosted/releases.mdx index a42dfad8f8..9d92118359 100644 --- a/src/docs/self-hosted/releases.mdx +++ b/src/docs/self-hosted/releases.mdx @@ -2,8 +2,6 @@ title: 'Self-Hosted Releases & Upgrading' --- -![CalVer: YY.MM.MICRO](https://img.shields.io/badge/calver-YY.MM.MICRO-ad6caa.svg) - Sentry cuts regular releases for self-hosting to keep it as close to [sentry.io](https://sentry.io) as possible. We decided to follow a monthly release schedule using the [CalVer](https://calver.org/#scheme) versioning scheme, with a primary release on the [15th of each month](https://github.com/getsentry/self-hosted/blob/704e4c3b5b7360080f79bcfbe26583e5a95ae675/.github/workflows/release.yml#L20-L24). We don't patch old versions, but if a bug is bad enough we may cut an out-of-cycle point release, which, like our regular monthly releases, is a snapshot of the latest versions of all of our components. You can find the [latest release](https://github.com/getsentry/self-hosted/releases/latest) over at the [releases section of our self-hosted repository](https://github.com/getsentry/self-hosted/releases/). @@ -20,7 +18,10 @@ Sentry cuts regular releases for self-hosting to keep it as close to [sentry.io] We encourage everyone to regularly update their Sentry installations to get the best and the most recent Sentry experience. -To upgrade, all you need to do is download or check out the version of self-hosted repository you want, replace your existing folder's contents with that, and then run `./install.sh`. + + If you upgrade infrequently, it's less likely that upgrading to latest will work. + Please refer to Hard Stops for how to incrementally upgrade to more recent versions. + We may have some updated configuration, especially for new features, so always check the example config files under the sentry directory and see if you need to update your existing configuration. We do our best to automate critical configuration updates, but you should always check your configs during upgrades. @@ -28,11 +29,7 @@ We may have some updated configuration, especially for new features, so always c Before starting the upgrade, we shut down all the services and then run some data migrations, so expect to have some downtime. There is an *experimental* `--minimize-downtime` option to reduce the downtime during upgrades. Use this at your own risk and see [the pull request it was implemented in](https://github.com/getsentry/self-hosted/issues/607) for more information. - - There are certain hard-stops you need to go through when upgrading from earlier versions. Please read the hard-stops section below for a list. - - -If you downloaded self-hosted repository using Git clone, the upgrade commands should look like this: +To upgrade, all you need to do is download or check out the version of self-hosted repository you want, replace your existing folder's contents with that, and then run `./install.sh`. If you downloaded self-hosted repository using Git clone, the upgrade commands should look like this: ```bash # Assuming your destination upgrade version is 24.3.0 @@ -44,26 +41,15 @@ sudo ./install.sh ### Hard Stops -We have three hards stops that you need to go through in order to pick up significant database changes: - -1. If you are coming from a version prior to `9.1.2`, you first need to upgrade to `9.1.2` and follow the next steps: - ``` - -> 9.1.2 -> 21.5.0 -> 21.6.3 -> 23.6.2 -> latest - ``` -1. If you are coming from `9.1.2`, you first need to upgrade to `21.5.0` and follow the next steps: - ``` - -> 21.5.0 -> 21.6.3 -> 23.6.2 -> latest - ``` -1. If you are coming from a version prior to `21.6.3`, you first need to upgrade to `21.6.3`: - ``` - -> 21.6.3 -> 23.6.2 -> latest - ``` -1. If you are coming from a version prior to `23.6.2`, you first need to upgrade to `23.6.2`: - ``` - -> 23.6.2 -> latest - ``` - -Any other case (`23.6.2+`), you should be able to upgrade to the latest version directly. We'd recommend you skip `23.7.0` to avoid issues around database migrations and the django 3 upgrade. +These are the hard stops that you need to go through in order to pick up significant database changes: + +``` + -> 9.1.2 -> 21.5.0 -> 21.6.3 -> 23.6.2 -> 23.11.0 -> latest +``` + +Versions to avoid: +- `23.7.0` (issues around database migrations and the Django 3 upgrade) + ## Nightly Builds