Workspaces

decK is Workspace-aware, meaning it can interact with multiple Workspaces.

To manage the configuration of a specific Workspace, use the --workspace flag with deck gateway sync, deck gateway diff, deck gateway dump, or deck gateway reset.

For example, to export the configuration of the Workspace my-workspace:

deck gateway dump --workspace my-workspace

deck gateway dump --workspace my-workspace --konnect-control-plane-name $YOUR_CP_NAME

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 with deck gateway reset, decK deletes the entire configuration inside the Workspace, but not the Workspace itself.

You can manage the configurations of all Workspaces with the --all-workspaces flag:

deck gateway dump --all-workspaces

deck gateway dump --all-workspaces --konnect-control-plane-name $YOUR_CP_NAME

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 workspace1.yaml --workspace workspace1 --konnect-control-plane-name $YOUR_CP_NAME