Migrating a V0 Serverless Gateway to V1

Uses: Kong Gateway

Note: Serverless Gateways V1 are currently available for Konnect organizations running in US and EU regions only.

Serverless Gateways V1 bring updates to the API, increased data plane provisioning speeds, and Terraform support.

You can upgrade to Serverless Gateways V1 using decK.

Breaking changes between V0 and V1

Review the following breaking changes before migrating to V1:

Change

V0 (old)

V1 (new)

Proxy URL format https://kong-0122456789.kongcloud.dev https://0123456789.us.serverless.gateways.konggateway.com
Control plane type CLUSTER_TYPE_SERVERLESS CLUSTER_TYPE_SERVERLESS_V1
Data plane kind serverless.v0 serverless.v1

Migration steps

  1. Create a personal access token in Konnect and export it as an environment variable:

    export KONNECT_TOKEN=YOUR_ACCESS_TOKEN
    
  2. Export your current Serverless V0 control plane configuration into a decK file:

    deck gateway dump -o kong.yaml \
     --konnect-token "$KONNECT_TOKEN" \
     --konnect-control-plane-name "MY_SERVERLESS_V0_CP"
    
  3. Create a new Serverless Gateway using the Konnect UI:

    1. In the Konnect sidebar, click API Gateway.
    2. Click the New button, then select New API Gateway.
    3. Select Serverless.
    4. Give your Gateway a name and an optional description.
    5. Click Create to save.

    This creates a control plane and deploys a data plane node so that you don’t have to run one yourself.

    If you prefer to use the API to create control planes and data planes, see the Serverless Gateway reference.

  4. Import the control plane configuration to your new Serverless V1 gateway, making sure to target the new control plane.

    First, check the configuration diff:

    deck gateway diff ./kong.yaml \
     --konnect-token "$KONNECT_TOKEN" \
     --konnect-control-plane-name "MY_NEW_SERVERLESS_V1_CP"
    
  5. If you’re satisfied with the update, run a sync to update your control plane:

    deck gateway sync ./kong.yaml \
     --konnect-token "$KONNECT_TOKEN" \
     --konnect-control-plane-name "MY_NEW_SERVERLESS_V1_CP"
    

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!