Skip to content
Kong Logo | Kong Docs Logo
search
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Konnect
  • Home icon
  • Kong Konnect
  • Gateway Manager
  • Control Plane Groups
  • Migrate configuration into control plane groups
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Prerequisites
  • Prepare control planes for migration
  • Scenario: Migrate a control plane configuration into a control plane group
  • Scenario: Migrate workspaces to control plane groups

Migrate configuration into control plane groups

There are a few situations in which you might want to migrate existing configuration into a control plane group.

  • Migrate standard control plane configuration into a control plane group. In this scenario, you are migrating config from Konnect to a different control plane in Konnect.
  • Migrate self-managed Kong Gateway workspace configuration into a control plane group in Konnect. In this scenario, you are migrating from self-managed to cloud managed.

A control plane group can’t be configured directly. It compiles configuration from its member control planes.

Therefore, when migrating, you will need at least two new groups: a control plane group and a standard control plane.

Prerequisites

  • Control plane admin permissions
  • decK v1.12 or later installed
  • You have a Konnect access token and you have made sure that decK can connect to your account

Prepare control planes for migration

  1. Create a control plane group:

     curl -i -X POST https://<region>.api.konghq.com/v2/control-planes \
         -H "Authorization: Bearer <your_KPAT>" \
         --data name=CPG \
         --data cluster_type=CLUSTER_TYPE_COMPOSITE
    
  2. Create a new standard control plane:

     curl -i -X POST https://<region>.api.konghq.com/v2/control-planes \
         -H "Authorization: Bearer <your_KPAT>" \
         --data name=CP1 \
         --data cluster_type=CLUSTER_TYPE_HYBRID
    
  3. Add the new control plane to the group as a member:

     curl -i -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/group-memberships/add \
         -H "Authorization: Bearer <your_KPAT>" \
         --json '{"members": [{"id": "062e2f2c-0f42-4938-91b4-f73f399260f5"}]}'
    

    Note: When adding a standard control plane to a group, make sure it has no connected data plane nodes.

Scenario: Migrate a control plane configuration into a control plane group

If you want to migrate a standard control plane into a group, Kong recommends the following path:

  1. Create a control plane group.
  2. Create a new standard control plane and add as a member to the control plane group.
  3. Dump the configuration from the old standard control plane.
  4. Apply configuration to new standard control plane that is a member of the control plane group.
  5. Start new data plane nodes in control plane group and test routes.
  6. Decommission the old standard control plane.

We recommend this workflow because it gives you the opportunity to review shared entities and avoid conflicts. It also decouples any team, dev portal, or identity permissions from the standard control plane. This way, you won’t accidentally grant access to the wrong resources to a new group of users.

Assuming you already have a control plane group and a member control plane, you can export the configuration from the old control plane and apply it to the new one.

  1. Export the configuration of the old control plane via deck dump:

     deck dump \
         -o old-group.yaml \
         --konnect-token <your_KPAT> \
         --konnect-control-plane-name old-group
    
  2. Sync the configuration to the new group:

     deck sync \
         -s old-group.yaml \
         --konnect-token <your_KPAT> \
         --konnect-control-plane-name CP1
    

    Note that you can’t sync the configuration to the control plane group CPG. Control plane groups don’t have their own configuration. They inherit combined configuration from all of their member control planes.

Scenario: Migrate workspaces to control plane groups

Use decK to migrate a self-managed Kong Gateway workspace into a control plane group.

  1. Run deck dump to export workspace configuration into a file:

     deck dump --workspace ws1 -o ws1.yaml
    
  2. Open the file. Remove the following:

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

    • 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

  3. Preview the import with the deck diff command, pointing to the control plane that you want to target:

     deck diff --konnect-control-plane-name CP1 -s ws1.yaml
    
  4. If you’re satisfied with the preview, run deck sync:

     deck sync --konnect-control-plane-name CP1 -s ws1.yaml
    

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

  5. Log in to your Kong Konnect account.

  6. From the left navigation menu, open Gateway Manager, then open the control plane you just updated.

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

Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Gateway Enterprise Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2023