Working with Workspaces
decK is workspace-aware, meaning it can interact with multiple workspaces.
Workspaces are a Kong Gateway Enterprise concept, and are not applicable to Konnect.
Manage one workspace at a time
To manage the configuration of a specific workspace, use the --workspace
flag with sync
, diff
, dump
, or reset
.
For example, to export the configuration of the workspace my-workspace
:
deck gateway dump --workspace my-workspace
If you don’t specify a --workspace
flag, decK uses the default
workspace.
To set a workspace directly in the state file, use the _workspace
parameter. For example:
_format_version: "3.0"
_workspace: default
services:
- name: example_service
Note: decK can’t delete workspaces. If you use
--workspace
or--all-workspaces
withdeck gateway 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 with the --all-workspaces
flag:
deck gateway dump --all-workspaces
This creates one configuration file per workspace.
Be careful when using the
--all-workspaces
flag to avoid overwriting the wrong workspace. We recommend using the singular--workspace
flag in most situations.
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 gateway sync workspace1.yaml --workspace workspace1
deck gateway sync workspace2.yaml --workspace workspace2