You are browsing documentation for an outdated version. See the
latest documentation here.
Backup and Restore of Kong Gateway's Configuration
You can use decK to back up and restore a subset or the entirety of
Kong Gateway’s entity configuration.
See the reference for Entities Managed by decK
to find out which entity configurations can be backed up.
Back up Kong Gateway’s entire configuration
To back up Kong Gateway’s configuration, use the
This generates a
kong.yaml file with the entire configuration of Kong Gateway, if possible.
Then, restore this file back to Kong Gateway using the
Preview the changes that decK will perform:
Re-create the entities in Kong Gateway:
Manage a subset of configuration
You can export, import, and manage a subset of Kong Gateway’s configuration using decK’s
select-tag feature. This is similar to adopting
distributed configuration for Kong Gateway.
select-tag feature assumes that all the entities you would like to manage
in Kong Gateway share a common tag(s).
Assuming you have such a common tag (for example, let’s call it
you can use it to export only a subset of the configuration:
deck dump --select-tag foo-tag
If you observe the file generated by decK, you will see the following section:
This subsection tells decK to filter out entities containing select-tags during
a sync operation.
Now, you can manage or sync back only this subset of Kong Gateway’s configuration.