Resources / Workspace
Workspace
A unit of ownership and trust. It holds projects and child workspaces, is linked to one billing account, and has its own owner: whoever creates it receives the owner role in it and in everything below it, and nothing above it or beside it.
Overview
| API | resourcemanager.etorm.com/v1alpha1 |
| Resource | workspaces (cluster-scoped inside its cluster) |
| Short names | ws |
| Available in | the platform only |
| Status | written by a controller through /status |
Minimal example
apiVersion: resourcemanager.etorm.com/v1alpha1
kind: Workspace
metadata:
name: example
spec: {}
Spec
| Field | Type | Required | Default | Allowed | Description |
displayName | string | | | up to 128 characters | Human-readable name. |
parentRef | reference to Workspace | | | | The workspace this one is inside. Empty for a top-level workspace. Cannot be changed. |
billingAccountRef | reference to BillingAccount | | | | The billing account that pays for the workspace's projects. Required for a top-level workspace; a child inherits its parent's unless its creator may charge another. Cannot be changed. |
cascadeDelete | boolean | | | | Set this, then delete the workspace, to erase it together with every project and child workspace under it. Irreversible: each project's objects and data are deleted. Without it a workspace is deleted only when empty. |
quotas | object | | | | Ceilings for everything under this workspace (itself included). Set by someone above the workspace, never by its own owners; a child cannot exceed its parent's. |
quotas.projects | integer | | | at least 0 | Most projects in this workspace and its descendants. |
quotas.workspaces | integer | | | at least 0 | Most descendant workspaces. |
Status
| Field | Type | Required | Default | Allowed | Description |
phase | string | | | | Lifecycle phase. |
id | string | | | | Immutable identifier (the object's uid); storage and audit use it, never the path. |
path | string | | | | Names from the top-level workspace, separated by a colon. |
depth | integer | | | | 1 for a top-level workspace. |
account | string | | | | The billing account this workspace is linked to (its own or inherited). |
projectCount | integer | | | | Projects directly in this workspace. |
conditions | list of object | | | | Detailed state, one entry per aspect; Ready says whether the object is usable. |
conditions[].type | string | | | | |
conditions[].status | string | | | | |
conditions[].reason | string | | | | |
conditions[].message | string | | | | |
Columns in listings
| Column | From |
|---|
| Path | .status.path |
| Billing-Account | .status.account |
| Projects | .status.projectCount |
| Phase | .status.phase |
All resources