Back up your configuration

decK can back up the configuration of your running Kong Gateway using the deck gateway dump command.

See the reference for Entities Managed by decK to find out which entity configurations can be backed up.

The exact command that you need to run changes if you’re using workspaces (on-prem only) or not.

The following commands will back up all of the configuration in to a single file. See tags to learn how to segment configuration.

Konnect

decK can export one control plane at a time from Konnect. To choose which control plane is backed up, specify the --konnect-control-plane-name flag:

deck gateway dump -o $YOUR_CP_NAME.yaml --konnect-control-plane-name $YOUR_CP_NAME --konnect-token $KONNECT_TOKEN

Single workspace

If you’re using Kong Gateway (OSS) or the default workspace in Kong Gateway Enterprise, decK automatically identifies the workspace to back up:

deck gateway dump -o kong.yaml

To back up a different workspace, pass the -w flag:

deck gateway dump -w $WORKSPACE_NAME -o $WORKSPACE_NAME.yaml

All workspaces

To back up all Kong Gateway Enterprise workspaces, pass the --all-workspaces flag. This creates multiple files in the current directory. Each file is named the same as its workspace:

deck gateway dump --all-workspaces