decK: Declarative configuration for Kong

decK provides declarative configuration and drift detection for Kong.

• Features
• Compatibility
• Installation
• Documentation
• Stale issue and pull request policy
• License

Features

• Export

• Import

• Diff and sync capabilities

• Reverse sync

• Validation

• Reset

• Parallel operations

• Authentication with Kong

• Manage Kong's config with multiple config file

• Designed to automate configuration management

Compatibility

decK is compatible with Kong Gateway >= 1.x and Kong Enterprise >= 0.35.

Installation

macOS

If you are on macOS, install decK using brew:

$ brew tap kong/deck
$ brew install kong/deck/deck

Linux

If you are Linux, you can either use the Debian or RPM archive from the GitHub release page or install by downloading the binary:

$ curl -sL https://github.com/kong/deck/releases/download/v1.68.0/deck_1.68.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 download the binary from the GitHub release page or via PowerShell:

$ curl -sL https://github.com/kong/deck/releases/download/v1.68.0/deck_1.68.0_windows_amd64.tar.gz -o deck.tar.gz
$ tar -xzvf deck.tar.gz

Docker image

Docker image is hosted on Docker Hub.

You can get the image with the command:

docker pull kong/deck

Documentation

You can use --help flag once you've decK installed on your system to get help in the terminal itself.

The project's documentation is hosted at https://docs.konghq.com/deck/overview.

Changelog

Changelog can be found in the CHANGELOG.md file.

Stale issue and pull request policy

To ensure our backlog is organized and up to date, we will close issues and pull requests that have been inactive awaiting a community response for over 2 weeks. If you wish to reopen a closed issue or PR to continue work, please leave a comment asking a team member to do so.

License

decK is licensed with Apache License Version 2.0. Please read the LICENSE file for more details.