WorkspaceClaim Resource¶
The WorkspaceClaim custom resource represents the desired state of a workspace managed by the CloudAPI Operator. It is typically created by the operator in response to an Onboarding, but cluster administrators can inspect or reconcile the resource directly.
Spec¶
| Field | Type | Description |
|---|---|---|
spec.id |
string (optional) | Immutable identifier for the workspace. Defaults to the Onboarding ID when omitted. |
| ## Status | ||
| Field | Type | Description |
| ----- | ---- | ----------- |
status.clusterUrl |
string | KCP URL that hosts the workspace once provisioned. |
status.kubeConfigSecret |
SecretReference | Secret containing kubeconfig credentials for the workspace. |
status.phase |
string | Lifecycle phase (Initializing, Ready, Deleting). |
status.conditions |
[]Condition | Standard Kubernetes conditions describing readiness, progress, or degradation. |
| ## Lifecycle Phases | ||
| - Initializing – resources are being created or reconciled. | ||
| - Ready – workspace is provisioned and usable. | ||
| - Deleting – workspace is being deprovisioned along with associated secrets. | ||
| ## Conditions | ||
| Common condition types emitted by the controller: | ||
| Condition | Meaning | |
| --------- | ------- | |
Available |
Workspace endpoint is reachable and secrets are present. | |
Progressing |
Reconciliation is running; the workspace may not yet be usable. | |
Degraded |
Reconciliation failed; inspect controller logs for details. | |
| ## Example | ||
| ```yaml | ||
| apiVersion: cloudapi.team-orca.dev/v1alpha1 | ||
| kind: WorkspaceClaim | ||
| metadata: | ||
| name: example-workspaceclaim | ||
| spec: | ||
| id: abc-def-123-456 | ||
| status: | ||
| phase: Ready | ||
| clusterUrl: https://api.kcp.team-orca.dev:8443/cluster/root:abc-def-123-456 | ||
| kubeConfigSecret: | ||
| name: ws-abc-def-123-456-kubeconfig | ||
| namespace: default | ||
| conditions: | ||
| - type: Available | ||
| status: "True" | ||
| reason: Reconciled | ||
| message: Workspace is ready for use. |