Skip to content

CoderWorkspacePoolMember

API identity

  • Group/version: coder.com/v1alpha1
  • Kind: CoderWorkspacePoolMember
  • Resource: coderworkspacepoolmembers
  • Scope: namespaced

Spec

Field Type Description
controlPlaneRef CoderControlPlaneReference ControlPlaneRef names the pool's CoderControlPlane.
poolName string PoolName is the name of the member's CoderWorkspacePool.
ownerID string OwnerID is the Coder user who owns the workspace. Coder's prebuilds system user is refused.
organizationID string OrganizationID is the template's organization.
templateID string TemplateID is the template.
templateVersionID string TemplateVersionID is the version of the start build.
presetID string PresetID is the preset of the start build.
parameters CoderWorkspacePoolMemberParameter array Parameters are the rich parameter values of the start build, in plain text. Leave the field out when there are none: typed clients drop an empty list, and the immutability rule would then refuse their updates.
parametersHash string ParametersHash is the pool's hash of Parameters when it created the member.
readyTimeoutSeconds integer ReadyTimeoutSeconds bounds the time from the member's creation until its workspace is ready.
claimRef CoderWorkspaceClaimReference ClaimRef is the claim that holds this member. The pool sets it once, when it binds a ready member.

Status

Field Type Description
phase string Phase is Pending, Creating, Ready, Failed, or Deleting.
workspaceName string WorkspaceName is the Coder workspace name: kwp- and the first 28 hex characters of the member's UID.
createAttemptTime Time CreateAttemptTime is set before every workspace create request. While it is set and WorkspaceID is empty, a create request can be in flight or already committed in Coder.
workspaceID string WorkspaceID is the Coder workspace ID.
startBuildID string StartBuildID is the ID of the start build that the controller requested.
readyTime Time ReadyTime is when the workspace became ready.
readyLastUsedAt MicroTime ReadyLastUsedAt is the workspace's last_used_at when it became ready, in microseconds like Coder. A later value counts as use. It comes from use, or from a template schedule update with update_workspace_last_used_at, which looks the same.
lastExtendTime Time LastExtendTime is when the controller last extended the autostop deadline of the unclaimed workspace.
bindExtended boolean BindExtended is true after the one deadline extension at bind.
bindExtendDeadline Time BindExtendDeadline is the deadline that the extension at bind asks Coder for. The controller stores it before the first extend request. While BindExtended is false, a Coder deadline at or after it proves that the extension happened.
sharedUserID string SharedUserID is the Coder user that the controller shares the workspace with for a Share claim. The controller stores it before its first ACL write and never changes it, so a renamed or reused username never moves the share to another user. The Shared condition reports whether Coder's ACL gives this user a role.
deleteBuildID string DeleteBuildID is the ID of the current delete build.
deleteAttempts integer DeleteAttempts counts failed delete builds. It drives the retry backoff.
reason string Reason is the current wait reason or the failure reason.
message string Message explains Reason. It never holds Coder error details, build logs, parameter values, or tokens.
conditions Condition array Conditions are Ready, Used, WorkspaceDeleted, and, for a Share claim, Shared.

Referenced types

CoderControlPlaneReference

CoderControlPlaneReference names a CoderControlPlane in the same namespace.

Field Type Description
name string Name is the CoderControlPlane name.

CoderWorkspaceClaimReference

CoderWorkspaceClaimReference names the CoderWorkspaceClaim that holds a member.

Field Type Description
name string Name is the claim name, in the member's namespace.
uid string UID is the claim's metadata.uid.

CoderWorkspacePoolMemberParameter

CoderWorkspacePoolMemberParameter is one pinned rich parameter value. Value is required and always serialized, so an empty value looks the same in a stored object and in a typed update, and the immutability rule holds.

Field Type Description
name string Name is the parameter name.
value string Value is the parameter value. It can be empty.

Source

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