Skip to content
|
Kong Konnect
github-edit-pageEdit this page
report-issueReport an issue

Back Up and Restore Konnect Configuration

Use decK to back up and restore Konnect’s control plane configuration.

With deck gateway dump, decK generates state files for each control plane, which act as snapshots of the control plane’s configuration at that point in time. If a control plane’s configuration is ever corrupted, you can then use these snapshots to restore your control plane, or bring up another control plane with the same configuration.

Review the list of entities managed by decK to see what can be backed up.

Note: You can’t use this method to back up Dev Portal configuration and objects, such as documents, specs, and applications. There is currently no automated way to back up Dev Portal content.

Back up a Konnect control plane

Use deck gateway dump to back up your configuration:

deck gateway dump \
--konnect-token <your-PAT> \
--konnect-control-plane-name <example-name> \
--output-file /path/to/<my-backup.yaml>

We recommend using a personal access token to authenticate with the Konnect org. You can also choose a different form of authentication.

This command generates a state file for the control plane’s entity configuration, for example:

_format_version: "3.0"
_konnect:
    control_plane_name: us-west
consumers:
- username: example-user1
- username: example-user2
services:
- connect_timeout: 60000
    host: httpbin.konghq.com
    name: MyService
    tags:
    - _KonnectService:example_service
    ...

Restore a Konnect control plane

You can restore entity configuration for a control plane using a declarative configuration file. Note that you must do this for one group at a time.

Assuming you have a backup file, for example, my-backup.yaml:

Run a diff between your backup file and the control plane in Konnect to make sure you’re applying the configuration you want:

deck gateway diff /path/to/<my-backup.yaml> \
--konnect-token <your-PAT> \
--konnect-control-plane-name <example-name> \

If you’re satisfied with the diff result, run deck gateway sync to sync your configuration to a control plane:

deck gateway sync /path/to/<my-backup.yaml> \
--konnect-token <your-PAT> \
--konnect-control-plane-name <example-name> \

Check your control plane in Konnect to make sure the sync worked. Open Gateway Manager, select your control plane, and check through the configured entities.

More information