Skip to content
|
decK
1.9.x
github-edit-pageEdit this page
report-issueReport an issue
You are browsing documentation for an older version. See the latest documentation here.

decK

Manage Kong Konnect, Kong Gateway, and Kong Ingress Controller configuration declaratively

Install decK
CLI Reference

Introducing decK

decK is a command line tool that facilitates API Lifecycle Automation (APIOps) by offering a comprehensive toolkit of commands designed to orchestrate and automate the entire process of API delivery. APIOps involves leveraging automation frameworks to streamline and enforce best practices throughout the API lifecycle. This enables developers and operations teams to manage APIs from development through deployment, ensuring consistency, reliability, and speed in API integrations.

decK operates on state files. decK state files describe the configuration of Kong API Gateway. State files encapsulate the complete configuration of Kong in a declarative format, including services, routes, plugins, consumers, and other entities that define how requests are processed and routed through Kong.

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

Looking for help or need to report an issue?

Find help

One of the design goals of decK is to deliver a good developer experience. To find help, use the following resources:

  • The --help flag gives you the necessary help in the terminal itself and should solve most of your problems.
  • If you still need help, open a Github issue to ask your question.
  • decK has very wide adoption by Kong’s community and you can seek help from the larger community at Kong Nation.

Report a bug

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

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

Security

decK does not offer to secure your Kong deployment but only configures it. It encourages you to protect your Kong Admin API implementation 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 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, submit a detailed report, along with reproducible steps to security@konghq.com.

Licensing

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

More resources

  • decK FAQs
  • References: The command line --help flag on the main command or a subcommand (like diff, sync, reset, and so on) shows the help text along with supported flags for those commands. You can also see the references for all commands available with decK in the decK documentation.
  • Video: Kong Summit motivation behind decK. Harry Bagdi gave a talk on the motivation behind decK and demonstrated a few key features of decK at Kong Summit 2019.
  • Changelog: See the CHANGELOG file in the Kong/deck repository.