deck file format

Uses: deck
Related Documentation
Related Resources

The format command converts Kong Gateway configuration files between two declarative configuration formats: decK and Kong’s built-in declarative format for DB-less mode.

The two formats differ in how Consumer Group-related entities are represented:

Format

Description

decK
  • Consumer Group plugins are nested under consumer_groups[*].plugins
  • Consumer Group memberships are nested under consumers[*].groups
  • Plugin partial links are nested under plugins[*].partials
Built-in DB-less
  • Consumer Group plugins are stored in a top-level consumer_group_plugins array
  • Memberships are stored in a top-level consumer_group_consumers array
  • Plugin partial links are stored in top-level plugins_partials

Command usage

Usage:
  deck file format [flags] deck|dbless filename

Examples:
# Convert a DBless file to decK format
deck file format deck dbless.yaml

# Convert a decK file to DBless format
deck file format dbless deck.yaml

Flags:
      --format string        Output file format: yaml or json. (default "yaml")
  -h, --help                 help for format
  -o, --output-file string   Output file to write to. Use - to write to stdout. (default "-")

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!