You are browsing unreleased documentation. See the latest documentation here.

Installation

decK is entirely written in Go. The build process builds a single static binary, which makes it easy and convenient to install decK.

Prerequisites

You have installed Kong Gateway (OSS) >= 1.x or Kong Gateway Enterprise >= 0.35.

You can follow along installation instructions based on your Operating System (OS):

macOS

If you are on macOS, install decK using brew:

Tap the kong/deck cask:
```
 brew tap kong/deck
```
Install decK:
```
 brew install deck
```

To update decK to the latest version:

brew upgrade deck

Linux

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.43.0/deck_1.43.0_linux_amd64.tar.gz -o deck.tar.gz
$ tar -xf deck.tar.gz -C /tmp
$ sudo cp /tmp/deck /usr/local/bin/

Windows

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.43.0/deck_1.43.0_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')"

Docker image

If your workflow requires a Docker image, then you can use kong/deck Docker 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.