Repository files navigation

decK provides declarative configuration and drift detection for Kong.

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

• Export
  Existing Kong configuration to a YAML configuration fileThis can be used to backup Kong's configuration.
• Import
  Kong's database can be populated using the exported or a hand written configfile.
• Diff and sync capabilities
  decK can diff the configuration in the config file andthe configuration in Kong's DB and then sync it as well.This can be used to detect config drifts or manual interventions.
• Reverse sync
  decK supports a sync the other way as well, meaning if anentity is created in Kong and doesn't add it to the config file,decK will detect the change.
• Validation
  decK can validate a YAML file that you backup or modify to catch errorsearly on.
• Reset
  This can be used to drops all entities in Kong's DB.
• Parallel operations
  All Admin API calls to Kong are executed in parallel using multiplethreads to speed up the sync process.
• Authentication with KongCustom HTTP headers can be injected in requests to Kong's Admin APIfor authentication/authorization purposes.
• Manage Kong's config with multiple config file
  Split your Kong's configuration into multiple logical files based on a sharedset of tags amongst entities.
• Designed to automate configuration management
  decK is designed to be part of your CI pipeline and can be used to not onlypush configuration to Kong but also detect drifts in configuration.

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

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 fromthe GitHubrelease pageor install by downloading the binary:

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

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

Docker image is hosted onDocker Hub.

You can get the image with the command:

docker pull kong/deck

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

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

Changelog can be found in theCHANGELOG.md file.

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

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