Skip to content

Commit 496ad16

Browse files
add general Enterprise upgrade instructions (#1791)
add general Enterprise upgrade instructions (#1784) Co-authored-by: Kenneth Jenkins <[email protected]>
1 parent 54b6a66 commit 496ad16

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

content/docs/admonitions/_upgrade-versions.mdx

-1
This file was deleted.

content/docs/deploy/upgrading.mdx

+20-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Below are upgrade notes for both **Pomerium Core** (the open-source edition) and
1010

1111
import Tabs from '@theme/Tabs';
1212
import TabItem from '@theme/TabItem';
13-
import UpgradeNotice from '@site/content/docs/admonitions/_upgrade-versions.mdx';
1413

1514
<Tabs>
1615

@@ -278,13 +277,30 @@ No changes required.
278277

279278
## Upgrading Pomerium Enterprise
280279

281-
Please review these deprecations and important changes for Pomerium Enterprise before upgrading.
280+
:::info
282281

283-
:::caution
282+
Your Pomerium Enterprise version should always match the same **minor version number** as your Pomerium Core version. For example:
283+
✅ Core **v0.27.0** with Enterprise **v0.27.3** is a supported configuration.
284+
❌ Core **v0.27.0** with Enterprise **v0.28.0** is not supported.
284285

285-
<UpgradeNotice />
286286
:::
287287

288+
To **upgrade** a Pomerium Enterprise deployment, we recommend that you:
289+
290+
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.
291+
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.)
292+
1. Take a database backup of the Pomerium Enterprise database.
293+
1. Upgrade Pomerium Core to the new version. For a replicated deployment, instances can be updated one at a time to avoid downtime.
294+
1. Upgrade Pomerium Enterprise to the new version.
295+
1. Verify that your deployment continues to behave as expected.
296+
297+
In case of trouble during the upgrade process, follow these steps to **roll back** to the previous version:
298+
299+
1. Stop Pomerium Enterprise.
300+
1. Restore the Pomerium Enterprise database from a backup taken before the upgrade.
301+
1. Downgrade Pomerium Core to the previous version.
302+
1. Start the previous version of Pomerium Enterprise.
303+
288304
### v0.28.0
289305

290306
No breaking changes in v0.28.

0 commit comments

Comments
 (0)