View on GitHub

decK

Declarative configuration for Kong and Kong Enterprise

decK Documentation

decK provides declarative configuration and drift detection for Kong.

Summary

Here is an introductory screen-cast explaining decK:

asciicast

Table of content

Design

Guides

References

The command-line --help flag on the main command or a sub-command (like diff, sync, reset, etc.) shows the help text along with supported flags for those commands.

A gist of all commands that are available in decK can be found here.

Frequently Asked Questions (FAQs)

You can find answers to FAQs here.

Explainer video

Harry Bagdi gave a talk on motivation behind decK and demonstrated a few key features of decK at Kong Summit 2019. Following is a recording of that session:

decK talk by Harry Bagdi

Changelog

Changelog can be found in the CHANGELOG.md file.

Licensing

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

Roadmap

decK’s roadmap is public and can be found under the open Github issues and milestones.

If you would like a feature to be added to decK, please open a Github issue, or add a +1 reaction to an existing open issues, if you feel that’s an addition you would like to see in decK. Features with more reactions take a higher precedence usually.

Security

decK does not offer to secure your Kong deployment but only configures it. It encourages you to protect your Kong’s Admin API with authentication but doesn’t offer such a service itself.

decK’s state file can contain sensitive data such as private keys of certificates, credentials, etc. It is left up to the user to manage and store the state file in a secure fashion.

If you believe that you have found a security vulnerability in decK, please submit a detailed report, along-with reproducible steps to Harry Bagdi (email address is first name last name At gmail Dot com). I will try to respond in a timely manner and will really appreciate it you report the issue privately first.

Getting help

One of the design goals of decK is deliver a good developer experience to you. And part of it is getting the required help when you need it. To seek help, use the following resources:

One thing I humbly ask for when you need help or run into a bug is patience. I’ll do my best to respond you at the earliest possible.

Reporting a bug

If you believe you have run into a bug with decK, please open a Github issue.

If you think you’ve found a security issue with decK, please read the Security section.