You are browsing documentation for an outdated version.
See the latest documentation here.
decK and Kong Gateway (Enterprise)
All features of decK work with both Kong Gateway (OSS) and Kong Gateway Enterprise.
For Kong Gateway Enterprise, decK provides a few additional features leveraging the
power of enterprise features.
decK is compatible with Kong Gateway Enterprise 0.35 and above.
Entities managed by decK
decK manages only the core proxy entities in Kong Gateway Enterprise. It doesn’t
manage enterprise-only entities such as admins, RBAC permissions, RBAC roles,
or any entities related to Dev Portal.
For a full list, see the reference for entities managed by decK.
If you have authentication and RBAC configured for Kong’s Admin API, provide the
RBAC token to decK so that decK can authenticate itself against the Admin API.
--headers flag to pass the RBAC token to decK. For example, you can pass the token as a string:
deck diff --headers "kong-admin-token:<your-token>"
However, passing the token directly is not secure and should only be used for testing. The command and all of its flags are logged to your shell’s history file, potentially leaking the token.
For a more secure approach, you can store the token in a file and load the file as you execute the command. For example:
deck diff --headers "kong-admin-token:$(cat token.txt)"
You can also use the
DECK_HEADERS environment variable to supply the same token with an environment variable.
It is advised that you do not use an RBAC token with super admin privileges
with decK, and always scope down the exact permissions you need to give
decK is workspace-aware, meaning it can interact with multiple workspaces.
Manage one workspace at a time
To manage the configuration of a specific workspace, use the
--workspace flag with
reset. For example, to
export the configuration of the workspace
deck dump --workspace my-workspace
If you do not specify a
--workspace flag, decK uses the
To set a workspace directly in the state file, use the
- name: example_service
Note: decK cannot delete workspaces. If you use
deck reset, decK deletes the entire configuration
inside the workspace, but not the workspace itself.
Manage multiple workspaces
You can manage the configurations of all workspaces in Kong Gateway Enterprise
deck dump --all-workspaces
This creates one configuration file per workspace.
However, since a
workspace is an isolated unit of configuration, decK doesn’t
allow the deployment of multiple workspaces at a time. Therefore, each
workspace configuration file must be deployed individually:
deck sync -s workspace1.yaml --workspace workspace1
deck sync -s workspace2.yaml --workspace workspace2
Be careful when using the
--all-workspaces flag to avoid overwriting the wrong workspace. We
recommend using the singular
--workspace flag in most situations.