tencent cloud

Service Registry and Governance

DocumentationService Registry and GovernanceCloud Native GatewayMigration GuideMigrating Configurations from the Self-Built Cloud Native API Gateway to Tencent Cloud

Migrating Configurations from the Self-Built Cloud Native API Gateway to Tencent Cloud

PDF
Focus Mode
Font Size
Last updated: 2026-05-07 17:21:36
Note:
Currently, the Cloud Native Gateway supports the purchase of new allowlists only in microservice scenarios. New access is not supported in other scenarios. If you have a purchase requirement, please submit a ticket for processing.

Scenarios

This document describes how to use the official Cloud Native API Gateway tool decK to migrate configurations from a self-built Cloud Native API Gateway to Cloud Native API Gateway of Tencent Cloud.

Prerequisites

If you have purchased and created a gateway instance, refer to the Operations Guide and configure the admin-api.
A self-built Cloud Native API Gateway is available, and services, routes, and plugins are configured.
decK is installed on the terminal. Visit the Cloud Native API Gateway official website, download decK, and install it on your terminal.

Operation Steps

Step 1: Exporting Configurations of the Self-Built Cloud Native API Gateway Using decK

1. Start the terminal and run the following command to export the configurations of the self-built Cloud Native API Gateway:
# Replace kong-zj with the IP address or domain name of the self-built Cloud Native API Gateway.
deck --kong-addr http://kong-zj:8001/ dump
2. Check the generated kong.yaml file.
# Note that the kong.yaml content will be different from the actual situation.
cat kong.yaml
_format_version: "1.1"
plugins:
- config:
    per_consumer: false
  enabled: true
  name: prometheus
  protocols:
  - grpc
  - grpcs
  - http
  - https
services:
- connect_timeout: 60000
  host: 127.0.0.1
  name: admin-api
  path: /
  port: 8001
  protocol: http
  read_timeout: 60000
  retries: 5
  routes:
  - https_redirect_status_code: 426
    name: admin-api
    path_handling: v1
    paths:
    - /admin-api
    preserve_host: false
    protocols:
    - http
    - https
    regex_priority: 0
    request_buffering: true
    response_buffering: true
    strip_path: true
  write_timeout: 60000
- connect_timeout: 60000
  host: www.tencent.com
  name: tencent
  path: /
  port: 80
  protocol: http
  read_timeout: 60000
  retries: 5
  routes:
  - https_redirect_status_code: 426
    id: 040b0c62-4d31-4286-a595-1832e55bf568
    path_handling: v1
    paths:
    - /
    preserve_host: false
    protocols:
    - http
    - https
    regex_priority: 0
    request_buffering: true
    response_buffering: true
    strip_path: true
  write_timeout: 60000

Step 2: Importing Configurations to the Cloud Native Gateway Kong Using decK

1. Open the terminal and run the following command to view the configuration differences between Kong.yaml and the Cloud Native Kong Gateway.
# Replace kong-tencent with the proxy address of the Tencent Cloud Cloud Native Gateway Kong.
deck --kong-addr http://kong-tencent/admin-api diff
creating service tencent
creating route 040b0c62-4d31-4286-a595-1832e55bf568
creating plugin prometheus (global)
Summary:
  Created: 3
  Updated: 0
  Deleted: 0
2. Run the following command to import the configurations in Kong.yaml into Cloud Native API Gateway.
# Replace kong-tencent with the proxy address of the Tencent Cloud Cloud Native Gateway Kong.
deck --kong-addr http://kong-tencent/admin-api sync
creating service tencent
creating route 040b0c62-4d31-4286-a595-1832e55bf568
creating plugin prometheus (global)
Summary:
  Created: 3
  Updated: 0
  Deleted: 0
3. Log in to the Tencent Cloud console and check whether the configurations are imported successfully.







Must-Knows

For operational convenience, the security authentication plugin is not enabled on admin-api. It is strongly recommended to enable the security authentication plugin for admin-api after configuration synchronization is complete.

Reference

For details, see the decK Reference Document.
Previous Topic: Event CenterNext Topic: Enabling admin api and Configuring Security Authentication

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback