Workspaces (V2): Creation & Optimization

Introduction

This guide will walk you through the steps to create, edit, and delete Workspaces. Depending on your needs, you can choose from several methods—each designed to fit different operational scenarios.

As a reminder, here are some of the common business cases that Workspaces can be used to resolve:

Key Use Cases

• Multi-Tenant Environments: Easily create workspaces that segregate resources by team, environment, or application, ensuring that users see only what is relevant to their role.
   
• Operational Efficiency: Quickly switch between different views of your Kubernetes environment—whether you need to focus on production clusters or specific namespaces —without compromising security.

Prerequisites

In order to begin setting up and/or editing workspaces, please ensure you have the necessary RBAC permissions; manage:workspaces. 

Getting Started

1. In order to set up Workspaces you'll need to go to the Organization Settings (⚙️) -> Configurations  ->  Workspaces
   
2. Once in the Workspace Management page you'll see the list of existing workspaces, in order to create a new workspace select Create Workspace.
3. Select a Name and Description for the Workspace in the wizard.
4. Now we need to create the Workspace definition - Choose which workspace Type you'd like to create;
   - Cluster-based
   - Namespace-based
   - Selector-based - based on label/annotation (for example - scope all labeled resources with specific team label)
   

Workspace Types

Workspace by Cluster

Definition: Filter resources by set Cluster Name(s) or Clusters selection.

Process: 

• When in the Workspace Management page, select Create Workspace. 
  
• Select the Cluster option as the type.
   
• Enter a pattern (e.g. *prod*) to include certain clusters and an exclude pattern (e.g. *-staging) to filter out unwanted clusters, or use the "is" operator to select single or multiple cluster selection.

Workspace by Namespace

Definition: Filter resources by Namespace selection/exclusion.

Process:

• When in the Workspace Management page, select Create Workspace. 
  
• Select the Namespace option as the type.

• Enter a Regex or Wildcard pattern (e.g. All Namespaces that begin with 'tenant-1' but excluding 'tenant1-system') or use the "is" operator to select a single or multiple namespace selection.
  • Optional: Limit the workspace to specific clusters by providing a cluster wildcard pattern.

You can always preview the definition for what clusters and or namespaces are included.

Workspace by Label/Annotation 

Definition: Dynamically filter resources based on labels or annotations. Any resource—including Deployments, Pods, Secrets, ConfigMaps, and more—that matches the defined label/annotation patterns or values is automatically included in the workspace.

Please note: Access is determined only by matching labels and annotations.If a Deployment has the required label but its Pods don’t, the Pods tab will show empty.

Prerequisites

Before beginning to create Workspaces by Label/ Annotation you need to ensure you have Tracked Keys (Documentation Link) Set up.

Process:

• When in the Workspace Management page, select Create Workspace. 
  
• Choose a Key from a predefined list (up to 10 allowed keys in Tracked Keys (Link to Tracked Keys in the Komodor Platform).
• Enter the wildcard pattern for values, including any excludes.

• View the real-time preview of matching resources (services, pods, etc.) with 📋 Preview definition.

  Please note: Workspaces based on labels/annotations will be limited to 5000 services

Editing & Deleting Workspaces

• To Edit a Workspace definition, go to the Workspace Management section.
  You'll need to go to the Organization Settings (⚙️) -> Configurations  ->  Workspaces
  
• Once in the Workspace Management page you'll see the list of existing workspaces, in order to edit an existing workspace select the pencil on the workspace row.

• Make the desired changes and save the definition, all changes will take effect immediately.

• To Delete a workspace definition , go to the Workspace Management section.
  You'll need to go to the Organization Settings (⚙️) -> Configurations  ->  Workspaces
  
• Once in the Workspace Management page you'll see the list of existing workspaces, in order to delete an existing workspace select the bin on the workspace row.
  

API & Terraform Management

• Advanced Options:
   
  • Creating, updating, and deleting Workspaces can also be done via API and Terraform.
  • This enables automation and integration into your CI/CD pipelines.
• Workspaces V2 API docs
• Workspaces V2 Terraform docs

Conclusion

Creating and updating Workspaces is streamlined in Komodor. These dynamic filtering tools ensure that your teams only see what matters most—optimizing both performance and clarity.