Skip to content

update rolling upgrade guide #2892

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

Closed
wants to merge 1 commit into from
Closed

update rolling upgrade guide #2892

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
14 changes: 6 additions & 8 deletions en_US/deploy/rolling-upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,12 @@ When using RPM or DEB packages, you can upgrade EMQX by simply installing the ne

When using Docker, you can upgrade EMQX by simply pulling the newer version image and restarting the container.

## Upgrade from Open Source to Enterprise Edition
## Upgrade from Open Source (<5.9) to Enterprise Edition version 5.9+

If you are running an Open Source version of EMQX and would like to upgrade to the Enterprise Edition,
the process is the same as upgrading to a newer version of the Open Source Edition.
Starting from version 5.9.0, EMQX Enterprise is released under the Business Source License (BSL) 1.1, replacing the previous separate Open Source and Enterprise editions.

There is no difference in installation and upgrade between the Open Source and Enterprise Editions of EMQX. The only notice is that you need to manually [configure your License](./license.md) in `emqx.conf` for the Enterprise edition nodes after each upgrade. You cannot apply the License key to the whole cluster before all nodes are upgraded.
While the technical steps for upgrading EMQX (like replacing binaries) are similar to previous version upgrades, the licensing model introduced in 5.9.0 is different and requires attention, particularly if you are running a cluster:

For example, add the following line to `base.hocon`:
```
license.key = "your license"
```
1. **New Licensing Model**: EMQX 5.9.0+ includes a default BSL 1.1 license grant (sometimes referred to as a single-node Community License). This default license enables all features but restricts deployment to a single node only.
1. **Clustering Requirement**: The previous Open Source edition allowed clustering. Because the default 5.9.0+ license does not permit clustering, if you are upgrading a clustered Open Source deployment and wish to maintain clustering capabilities, you must [obtain a Commercial License](./license.md#apply-for-a-license).
1. **Upgrade Process**: It is crucial that this Commercial License is [configured on each node](./license.md#update-and-configure-license-settings) before you start that node with the 5.9.0+ version during the upgrade process. Failing to do so will prevent the node from operating correctly within the cluster.