Migrate from Kong Gateway OSS to Kong Gateway Enterprise

Uses: Kong Gateway
TL;DR

Install the Kong Gateway Enterprise package that matches your OSS version, point it at the same data store, then run kong migrations up and kong migrations finish.

Prerequisites

You have backed up your Kong Gateway data. See Backing up and restoring Kong Gateway.

Warning: Migration is irreversible, therefore we strongly recommend backing up your production data before migrating from Kong Gateway OSS to Kong Gateway Enterprise.

Review deployment options

Review Kong Gateway deployment topologies and choose a target deployment type.

  • Kong Gateway OSS supports only traditional and DB-less deployments.
  • Kong Gateway Enterprise supports traditional, DB-less, and also introduces hybrid mode, which separates the control plane and the data plane.

If you choose to migrate to hybrid mode, all data store operations will occur on the control plane. If you want to migrate to Konnect, first migrate to Kong Gateway Enterprise in hybrid mode, and then migrate to Konnect.

Download and install the Enterprise package

Download and install the Kong Gateway Enterprise package that matches your installed OSS version from the Kong Gateway install page. You can only migrate to an Enterprise version that supports the same OSS version. The latest supported OSS version is 3.9.3.

Run database migrations

Configure the new Kong Gateway Enterprise deployment to point to the same data store as your Kong Gateway OSS node. The migrations command expects the data store to be up to date on any pending migrations.

Run migrations from the new node, pointing to your existing configuration file:

kong migrations up [-c configuration_file]
kong migrations finish [-c configuration_file]

Caution: When adding new plugins to the existing installation (either manually or via the extension of bundled plugins), the kong migrations finish or kong migrations up must be run with the -f flag to forcefully upgrade the plugin schemas.

Confirm your entities

Start your Kong Gateway Enterprise node and confirm that all entities are available.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!