deck file render

Uses: deck
Related Documentation
Related Resources

The deck file render command combines multiple complete configuration files and renders them as one Kong state file.

This command renders a full Kong Gateway configuration in JSON or YAML format by assembling multiple files and populating defaults and environment substitutions. This command is useful for observing what configuration would be sent prior to synchronizing to Kong Gateway.

In comparison to the deck file merge command, the render command accepts complete configuration files, while deck file merge can operate on partial files.

For example, the following command takes two input files and renders them as one combined JSON file:

deck file render kong1.yml kong2.yml

The deck file render command validates the configuration against a schema, and warns if any duplicate entities are detected.

Command usage

Usage:
  deck file render [flags]

Flags:
      --format string       output file format: json or yaml. (default "yaml")
  -h, --help                help for render
  -o, --output-file -       file to which to write Kong's configuration.Use - to write to stdout. (default "-")
      --populate-env-vars   Populate 'DECK_' environment variables in the output file. The default behavior
                            is to mock environment variable values.

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!