From b9f12a17eda711301b19e0c1be737e8d40679024 Mon Sep 17 00:00:00 2001 From: Kenneth Jenkins <51246568+kenjenkins@users.noreply.github.com> Date: Fri, 21 Feb 2025 17:14:46 -0800 Subject: [PATCH] add general Enterprise upgrade instructions (#1784) --- .../docs/admonitions/_upgrade-versions.mdx | 1 - content/docs/deploy/upgrading.mdx | 24 +++++++++++++++---- 2 files changed, 20 insertions(+), 5 deletions(-) delete mode 100644 content/docs/admonitions/_upgrade-versions.mdx diff --git a/content/docs/admonitions/_upgrade-versions.mdx b/content/docs/admonitions/_upgrade-versions.mdx deleted file mode 100644 index c8ea445cc..000000000 --- a/content/docs/admonitions/_upgrade-versions.mdx +++ /dev/null @@ -1 +0,0 @@ -**Before you upgrade:** Set your Core and Enterprise instances to the same **MINOR** version number. For example, if your Core instance is on **v0.22.1**, Enterprise should be set to **v0.22.0**. diff --git a/content/docs/deploy/upgrading.mdx b/content/docs/deploy/upgrading.mdx index fe3c06d07..dcb9fb4e4 100644 --- a/content/docs/deploy/upgrading.mdx +++ b/content/docs/deploy/upgrading.mdx @@ -10,7 +10,6 @@ Below are upgrade notes for both **Pomerium Core** (the open-source edition) and import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import UpgradeNotice from '@site/content/docs/admonitions/_upgrade-versions.mdx'; @@ -278,13 +277,30 @@ No changes required. ## Upgrading Pomerium Enterprise -Please review these deprecations and important changes for Pomerium Enterprise before upgrading. +:::info -:::caution +Your Pomerium Enterprise version should always match the same **minor version number** as your Pomerium Core version. For example: +✅ Core **v0.27.0** with Enterprise **v0.27.3** is a supported configuration. +❌ Core **v0.27.0** with Enterprise **v0.28.0** is not supported. - ::: +To **upgrade** a Pomerium Enterprise deployment, we recommend that you: + +1. Reach out to your account manager to let us know you are planning an upgrade, especially if upgrading across multiple minor versions at once. +1. First review the version-specific upgrade notes on this page for **both** Pomerium Core and Pomerium Enterprise for any changes that might pertain to your deployment. (If you're not sure, please don't hesitate to reach out and ask for clarification.) +1. Take a database backup of the Pomerium Enterprise database. +1. Upgrade Pomerium Core to the new version. For a replicated deployment, instances can be updated one at a time to avoid downtime. +1. Upgrade Pomerium Enterprise to the new version. +1. Verify that your deployment continues to behave as expected. + +In case of trouble during the upgrade process, follow these steps to **roll back** to the previous version: + +1. Stop Pomerium Enterprise. +1. Restore the Pomerium Enterprise database from a backup taken before the upgrade. +1. Downgrade Pomerium Core to the previous version. +1. Start the previous version of Pomerium Enterprise. + ### v0.28.0 No breaking changes in v0.28.