Skip to content

CoderWorkspaceClaim

API identity

  • Group/version: coder.com/v1alpha1
  • Kind: CoderWorkspaceClaim
  • Resource: coderworkspaceclaims
  • Scope: namespaced

Spec

Field Type Description
poolName string PoolName is the CoderWorkspacePool in the claim's namespace.
share CoderWorkspaceClaimShare Share names the Coder user that gets the workspace. Required when the pool's claims.mode is Share, refused otherwise: such a claim never binds and is Stalled with ClaimModeMismatch.

Status

Field Type Description
phase string Phase is Pending, Bound, or Lost. Lost is final.
memberName string MemberName is the CoderWorkspacePoolMember that holds the claim. While the claim is Pending, memberName and workspaceName name the member that the pool reserved for it.
workspaceID string WorkspaceID is the Coder workspace ID.
workspaceName string WorkspaceName is the Coder workspace name.
ownerName string OwnerName is the Coder username of the workspace owner, so that coder ssh <ownerName>/<workspaceName> reaches the workspace.
boundTime Time BoundTime is when a member took the claim.
sharedUserID string SharedUserID is the Coder user that has a role on the workspace through this claim, as the member last read it from Coder. The controller grants use.
reason string Reason is the current wait reason or the reason for Lost.
message string Message explains Reason. It never holds Coder error details, build logs, parameter values, or tokens.
conditions Condition array Conditions are Ready, Reconciling, and Stalled.

Referenced types

CoderWorkspaceClaimShare

CoderWorkspaceClaimShare names the Coder user of a Share claim.

Field Type Description
user string User is a Coder username or user UUID (lower case with hyphens).

Source

  • Go type: api/v1alpha1/coderworkspaceclaim_types.go
  • Generated CRD: config/crd/bases/coder.com_coderworkspaceclaims.yaml