Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add general Enterprise upgrade instructions #1791

Merged
merged 1 commit into from
Feb 22, 2025
Merged

add general Enterprise upgrade instructions #1791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion content/docs/admonitions/_upgrade-versions.mdx
View file
Open in desktop

This file was deleted.

24 changes: 20 additions & 4 deletions content/docs/deploy/upgrading.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';

<Tabs>

Expand Down Expand Up @@ -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.

<UpgradeNotice />
:::

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.
Expand Down
Loading