You are browsing documentation for an outdated version. See the latest documentation here.
decK is entirely written in Go. The build process builds a single static binary, which makes it easy and convenient to install decK.
You have installed Kong Gateway (OSS) >= 1.x or Kong Enterprise >= 0.35.
You can follow along installation instructions based on your Operating System (OS):
If you are on macOS, install decK using brew:
$ brew tap kong/deck $ brew install deck
If you are Linux, you can either use the Debian or RPM archive from the Github release page or install by downloading a compressed archive, which contains the binary:
$ curl -sL https://github.com/kong/deck/releases/download/v1.12.3/deck_1.12.3_linux_amd64.tar.gz -o deck.tar.gz $ tar -xf deck.tar.gz -C /tmp $ sudo cp /tmp/deck /usr/local/bin/
If you are on Windows, you can either use the compressed archive from the Github release page or install using CMD by entering the target installation folder and downloading a compressed archive, which contains the binary:
curl -sL https://github.com/kong/deck/releases/download/v1.12.3/deck_1.12.3_windows_amd64.tar.gz -o deck.tar.gz mkdir deck tar -xf deck.tar.gz -C deck powershell -command "[Environment]::SetEnvironmentVariable('Path', [Environment]::GetEnvironmentVariable('Path', 'User') + [IO.Path]::PathSeparator + [System.IO.Directory]::GetCurrentDirectory() + '\deck', 'User')"
If your workflow requires a Docker image, then you can use
image from the official Docker hub:
docker pull kong/deck
You will have to mount the state files into the container as volumes so that decK can read the files during diff/sync procedures.
If you’re integrating decK into your CI system, you can either install decK into the system itself, use the Docker based environment, or pull the binaries from Github for each job.
For more information about how to manage decK using the Docker image, see Run decK with Docker.