deck gateway

Uses: decK
Related Documentation
Related Resources

decK can configure a running Kong Gateway using the deck gateway command.

decK interacts with Kong Gateway using the Kong Admin API. This means that decK can manage any Kong Gateway instance running in hybrid or traditional mode, or in any Konnect deployment. However, it can’t manage Gateways running in DB-less mode.

To learn about decK’s APIOps capabilities, see deck file.

decK provides the following deck gateway subcommands:

Command

Description

ping Verify that decK can talk to the configured Admin API.
validate Validate the data in the provided state file against a live Admin API.
diff Diff the current state of Kong Gateway against the provided configuration.
sync Update Kong Gateway to match the state defined in the provided configuration.
apply Apply configuration to Kong without deleting existing entities.
dump Export the current state of Kong Gateway to a file.
reset Delete all entities in Kong Gateway.

All of these commands require access to a running Kong Gateway to function. If your Admin API requires a token, see the configuration page.

Something wrong?

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!