CRD reference
Field-by-field reference for the four CRDs of the
waas.xorhub.io/v1alpha1 API group:
| Kind | Short name | Purpose |
|---|---|---|
| Workspace | ws | One user's desktop instance |
| WorkspaceTemplate | wst | The shape of a desktop |
| WorkspacePolicy | wsp | Self-service envelope per user/group |
| WorkspaceImage | wsi | Approved catalog entry |
How these pages are produced
They are generated at build time from the JSON Schemas the waas
repository publishes under
crd-schemas/waas.xorhub.io/
— the same schemas its own CI validates manifests against, with
per-field descriptions straight from the API types. The schemas are
vendored into this site's repo (crd-schemas/, ref recorded in
crd-schemas/WAAS_REF) so the build is offline and reproducible;
refreshing them for a new waas release is a one-command sync
documented in the site's
CONTRIBUTING.
Each page shows the CRD as one annotated YAML manifest:
- Every field is a real YAML key, with its API documentation as
#comments right above it — the same textkubectl explainshows, verbatim from the Go API types. - Values are type placeholders:
<string>,<int32>,<boolean>,<quantity>(a Kubernetes quantity such as2,500mor4Gi). Enums are spelled out in place (User | Group). - Constraints ride on the field line as a trailing comment:
# required · min: 0 · default: false. - Nested objects fold like folders — click a key (▸) to open or close
its subtree, or use the Expand all / Collapse all buttons. A
collapsed key shows
{…}/[…]. - In lists, the
-line marks one example element;<key>marks the free keys of a map.