Skip to content
|
search
Kong Konnect

Import Kong Gateway Entities into Konnect

If you are an existing Kong Gateway user looking to use Konnect as your cloud-hosted control plane, you can use decK to import your Kong Gateway entity configuration into a runtime group in your Konnect organization.

You can also use this method to migrate between Konnect organizations.

Afterward, you must manually move over:

  • Dev Portal files, developer accounts, and applications
  • Application registrations
  • Convert roles and permissions into Konnect teams
  • Certificates
  • Custom plugins

You cannot import unsupported plugins.

Prerequisites

Generate a Personal Access Token

To use decK to import entity configurations, we recommend that you use a personal access token (PAT).

You can generate a personal access token (PAT) in Konnect for authentication with decK commands. This is more secure than basic authentication, and can be useful for organizations with CI pipelines that can’t use the standard username and password authentication.

There are two types of PATs available for Konnect:

  • Personal access tokens associated with user accounts
  • System account access tokens associated with system accounts

Learn more about system accounts in the Konnect System Accounts documentation.

Before you generate a PAT, keep the following in mind:

  • A PAT is granted all of the permissions that the user has access to via their most up-to-date role assignment.
  • The PAT has a maximum duration of 12 months.
  • There is a limit of 10 personal access tokens per user.
  • Unused tokens are deleted and revoked after 12 months of inactivity.

To generate a PAT for a user account in Konnect, select your name to open the context menu and click Personal access tokens, then click Generate token.

Create a system account token through the Konnect API.

Important: The access token is only displayed once, so make sure you save it securely.

Import entity configuration

Use decK to import entity configurations into a runtime group.

When you provide any Konnect flags, decK targets the cloud.konghq.com environment by default.

  1. Make sure that decK can connect to your Konnect account:

     deck ping \
   --konnect-runtime-group-name default \
   --konnect-token {YOUR_PERSONAL_ACCESS_TOKEN}

    If the connection is successful, the terminal displays the full name of the user associated with the account:

     Successfully Konnected to the Example-Name organization!

    You can also use decK with Konnect more securely by storing your personal access token in a file, then either calling it with --konnect-token-file /path/{FILENAME}.txt, or adding it to your decK configuration file under the konnect-token option:

     konnect-token: {YOUR_PERSONAL_ACCESS_TOKEN}

    The default location for this file is $HOME/.deck.yaml. You can target a different configuration file with the --config /path/{FILENAME}.yaml flag, if needed.

    The following steps all use a .deck.yaml file to store the Konnect credentials instead of flags.

  2. Run deck dump to export configuration into a file:

     deck dump

    This command outputs Kong Gateway’s object configuration into kong.yaml by default. You can also set --output-file /path/{FILENAME}.yaml to set a custom filename or location.

  3. Open the file. If you have any of the following in your configuration, remove it:

    • Any _workspace entries: There are no workspaces in Konnect. For a similar concept, see runtime groups.

    • Configuration for the Portal App Registration plugin: App registration is supported in Konnect, but not through a plugin, and decK does not manage it.

    • Any other unsupported plugins:

      • OAuth2 Authentication
      • Apache OpenWhisk
      • Vault Auth
      • DeGraphQL
      • GraphQL Rate Limiting Advanced
      • Key Authentication Encrypted

  4. Preview the import with the deck diff command, pointing to the runtime group that you want to target:

     deck diff --konnect-runtime-group-name default

    If you’re not using the default kong.yaml file, specify the filename and path with --state /path/{FILENAME}.yaml.

  5. If you’re satisfied with the preview, run deck sync:

     deck sync --konnect-runtime-group-name default

    If you don’t specify the --konnect-runtime-group-name flag, decK targets the default runtime group. If you have more than one runtime group in your organization, we recommend always setting this flag to avoid accidentally pushing configuration to the wrong group.

  6. Log in to your Kong Konnect account.

  7. From the left navigation menu, open Runtime Manager, then open the runtime group you just updated.

  8. Look through the configuration details of any imported entities to make sure they were migrated successfully.

Migrate data planes

You can keep any data plane nodes that are:

  • Running Kong Gateway (Enterprise, include free mode)
  • Are at least version 2.5 or higher

Turn any self-managed nodes into cloud data plane nodes by registering them through the Runtime Manager and adjusting their configurations, or power down the old instances and create new data plane nodes through Kong Konnect.

  1. Follow the runtime setup guide for your preferred deployment type.

  2. Once you have created or converted the data plane nodes, kong stop your old Gateway runtimes, then shut them down.

  3. If any of the old nodes have connected PostgreSQL or Cassandra instances, you can shut them down now.

Post-migration tasks

See the following docs to set up any additional things you may need:

  • Dev Portal files: You can migrate API specs and markdown service descriptions into Service Hub using the Kong Konnect GUI. Each Konnect service accepts one markdown description file, and each service version accepts one API spec. See Dev Portal Service Documentation.

  • Dev Portal applications and developers: If you have developers or applications registered through the Portal, those developers need to create new accounts in Kong Konnect and register their applications in the new location.
  • Prepare custom plugins for migration: Custom plugins are supported in Kong Konnect, but with limitations. As long as your plugins fit the criteria, or if you can adjust them to do so, contact Kong Support to get the plugin manually added to your account.
  • Review and set up teams and roles: Kong Konnect groups and roles don’t map directly to Kong Gateway teams and roles. Set up teams to mirror your Kong Gateway groups, then invite users to your org and assign them to a team on invite.