decK in Docker

decK is provided as a Docker image for those that do not want to install decK locally.

To run decK using a Docker image, add the following alias to your shell:

alias deck='docker run --rm -v .:/files -w /files kong/deck'

As decK will run in a Docker container, you’ll need to provide the --kong-addr parameter when running commands such as deck sync. To sync with a Kong Gateway that is running on the host machine, use host.docker.internal:

deck gateway sync --kong-addr http://host.docker.internal:8001 my_deck_file.yaml

Windows

On Windows, the commands are slightly different based on the environment you are using.

Environment	Command
Bash, for example GitBash or MinGW bash	`MSYS_NO_PATHCONV=1 docker run --rm -v $(pwd):/files -w /files kong/deck`
PowerShell	`docker run --rm -v ${PWD}:/files -w /files kong/deck`
cmd	`docker run --rm -v %CD%:/files -w /files kong/deck`

Set a default kong-addr

If the kong-addr you use is fixed, you can set the DECK_KONG_ADDR variable in your alias and omit it from each command:

alias deck='docker run --rm -v .:/files -w /files -e DECK_KONG_ADDR=http://host.docker.internal:8001 kong/deck'
deck gateway sync  my_deck_file.yaml

Upgrade deck

To upgrade decK when using Docker, run:

docker pull kong/deck:latest