Skip to content

docs: clarify that workspace name derives the Kubernetes namespace #1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
redhat-chai-bot wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −2
Open

docs: clarify that workspace name derives the Kubernetes namespace #1606

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions docs/src/content/docs/concepts/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,31 @@ Open the platform UI and click **New Workspace**. You will be prompted for:

| Field | Purpose |
|-------|---------|
| **Display name** | A human-readable label shown across the UI. |
| **Workspace Name** | A human-readable label shown across the UI. The platform also derives the internal **project name** from this value (see [Workspace name and project name](#workspace-name-and-project-name) below). |
| **Description** | Optional notes describing what the workspace is for. |

After creation you land on the workspace dashboard, where you can start sessions, configure integrations, and invite collaborators.

## Workspace name and project name

When you create a workspace the platform derives a **project name** from the workspace name you enter. This project name becomes the Kubernetes namespace for the workspace and is the identifier used in API paths, RBAC bindings, and CLI commands.

The derivation rules (implemented in `generateWorkspaceName` in the frontend) are:

1. Convert to lowercase.
2. Replace whitespace with hyphens.
3. Strip characters that are not lowercase alphanumeric or hyphens.
4. Collapse consecutive hyphens and trim leading/trailing hyphens.
5. Truncate to 63 characters (the Kubernetes namespace name limit).

For example, a workspace name of **"My Research Workspace"** produces the project name `my-research-workspace`.

:::caution
The project name must be **globally unique** on the cluster — no two workspaces can share the same derived name. If you try to create a workspace whose name collides with an existing namespace, the platform returns a **409 Conflict** error. Choose a distinctive workspace name to avoid collisions.
:::

The project name **cannot be changed** after creation because it is the Kubernetes namespace and is referenced by RBAC bindings, secrets, and session resources.

## Workspace settings

Each workspace carries its own configuration. Open **Settings** from the workspace sidebar to adjust the following.
Expand All @@ -30,7 +50,8 @@ Each workspace carries its own configuration. Open **Settings** from the workspa

### General

- **Display name and description** -- Update at any time.
- **Workspace name (display name) and description** -- Update at any time.
- **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](#workspace-name-and-project-name)).
Comment on lines +53 to +54
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

General settings editability is overstated for vanilla Kubernetes.

Line 53 says “Workspace name (display name) and description — Update at any time,” but current behavior is OpenShift-only; on vanilla Kubernetes these fields are not editable. This creates a user-facing docs mismatch.

Proposed doc fix 
-- **Workspace name (display name) and description** -- Update at any time.
+- **Workspace display name and description** -- Editable on OpenShift clusters.
+  On vanilla Kubernetes, these metadata fields are not editable in the UI.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Workspace name (display name) and description** -- Update at any time.
- **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](#workspace-name-and-project-name)).
- **Workspace display name and description** -- Editable on OpenShift clusters.
On vanilla Kubernetes, these metadata fields are not editable in the UI.
- **Project name** -- The Kubernetes namespace for this workspace. Read-only after creation (see [Workspace name and project name](`#workspace-name-and-project-name`)).
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/src/content/docs/concepts/workspaces.md` around lines 53 - 54, The docs
claim "Workspace name (display name) and description — Update at any time" but
this is only true on OpenShift; on vanilla Kubernetes these fields are not
editable. Update the text for the "Workspace name (display name) and
description" entry in docs/src/content/docs/concepts/workspaces.md to clearly
state the difference (e.g., "OpenShift: editable at any time; vanilla
Kubernetes: read-only after creation") and/or link to the "Workspace name and
project name" section for platform-specific behavior so readers know the
editability depends on the underlying platform.


### Storage

Expand Down