End-to-end connectivity platform
Universal service mesh
Empower your developers
Manage all your services
Autonomously identify issues
Native Kubernetes Ingress Controller
Instantly implement policies
Monitor your Kong Enterprise
API Design and Testing
Ingress and CRDs
Kong Gateway and Enterprise features
Accelerate your journey into microservices
Empower teams to provide security, governance and
Rapidly design, publish and consume APIs and services
Take control of your microservices with the world’s most
popular API gateway
Own your Kubernetes cluster by using Kong as an Ingress
Build, secure and observe your modern Service Mesh
This document describes the various commands that are available in decK.
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, and is the canonical documentation.
This command can be used to verify connectivity between Kong and decK.
Under the hood, it sends a GET / request to Kong to verify if Kong’s
Admin API is reachable and decK can authenticate itself against it.
If decK is being used in automated environment (like in a CI), it is
recommended that you use this command before a diff/sync to ensure
This command can be used to export all of Kong’s configuration into a single
YAML file. All entities are exported by default.
--select-tag can be used to export entities with the specific tag only.
This flag can be used in the following cases:
If you are a Kong Enterprise user, you can specify a specific workspace that
you want to export using the --workspace flag, or use the --all-workspaces flag
to export routing configuration of all workspaces.
This command compares the content of the input file against the current
configuration of Kong.
You can use this command for drift detection, i.e. if the configuration
of Kong is out of sync with configuration of the input file.
This command will create, update, or delete entities in Kong to exactly match
as described via the input file. You can use diff command to display
the actions that decK will take and then use sync command to actually
perform these actions.
This command can be used to validate an existing state file or a set of files.
It can catch most errors including validation of the YAML/JSON file itself and
catching duplicates or malformed entities.
This command will delete all the entities in Kong. Please use this
command with extreme caution as this action is irreversible.
This command shows the version information of the decK binary that is currently
This command shows the help text of decK. Use --help flag on any of the
above command to get help in your terminal itself.
decK collects anonymized data to track feature adoption.
You can opt out of this by setting the environment variable
DECK_ANALYTICS to off.