Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 44 additions & 22 deletions docs/reference/api/codercontrolplane.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,55 @@

| Field | Type | Description |
| --- | --- | --- |
| `image` | `string` | Image is the container image used for the Coder control plane pod. |
| `replicas` | `int32` | Replicas is the desired number of control plane pods. |
| `service` | `ServiceSpec` | Service controls the service created in front of the control plane. |
| ├─ `type` | `corev1.ServiceType` | Type controls the Kubernetes service type. |
| ├─ `port` | `int32` | Port controls the exposed service port. |
| └─ `annotations` | `map[string]string` | Annotations are applied to the reconciled service object. |
| `extraArgs` | `[]string` | ExtraArgs are appended to the default Coder server arguments. |
| `extraEnv` | `[]corev1.EnvVar` | ExtraEnv are injected into the Coder control plane container. |
| `imagePullSecrets` | `[]corev1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
| └─ `name` | `string` | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) |
| `operatorAccess` | `OperatorAccessSpec` | OperatorAccess configures bootstrap API access to the coderd instance. |
| ├─ `disabled` | `bool` | Disabled turns off creation and management of the `coder-k8s-operator` user and API token. |
| └─ `generatedTokenSecretName` | `string` | GeneratedTokenSecretName stores the generated operator API token. |
| `image` | string | Image is the container image used for the Coder control plane pod. |
| `replicas` | integer | Replicas is the desired number of control plane pods. |
| `service` | [ServiceSpec](#servicespec) | Service controls the service created in front of the control plane. |
| `extraArgs` | string array | ExtraArgs are appended to the default Coder server arguments. |
| `extraEnv` | [EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array | ExtraEnv are injected into the Coder control plane container. |
| `imagePullSecrets` | [LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array | ImagePullSecrets are used by the pod to pull private images. |
| `operatorAccess` | [OperatorAccessSpec](#operatoraccessspec) | OperatorAccess configures bootstrap API access to the coderd instance. |

## Status

| Field | Type | Description |
| --- | --- | --- |
| `observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
| `readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
| `url` | `string` | URL is the in-cluster URL for the control plane service. |
| `operatorTokenSecretRef` | `SecretKeySelector` | OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token. |
| ├─ `name` | `string` | Name is the Kubernetes Secret name. |
| └─ `key` | `string` | Key is the key inside the Secret data map. |
| `operatorAccessReady` | `bool` | OperatorAccessReady reports whether operator API access bootstrap succeeded. |
| `phase` | `string` | Phase is a high-level readiness indicator. |
| `conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
| `observedGeneration` | integer | ObservedGeneration tracks the spec generation this status reflects. |
| `readyReplicas` | integer | ReadyReplicas is the number of ready pods observed in the deployment. |
| `url` | string | URL is the in-cluster URL for the control plane service. |
| `operatorTokenSecretRef` | [SecretKeySelector](#secretkeyselector) | OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token. |
| `operatorAccessReady` | boolean | OperatorAccessReady reports whether operator API access bootstrap succeeded. |
| `phase` | string | Phase is a high-level readiness indicator. |
| `conditions` | [Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#condition-v1-meta) array | Conditions are Kubernetes-standard conditions for this resource. |

## Referenced types

### OperatorAccessSpec

OperatorAccessSpec configures the controller-managed coderd operator user.

| Field | Type | Description |
| --- | --- | --- |
| `disabled` | boolean | Disabled turns off creation and management of the `coder-k8s-operator` user and API token. |
| `generatedTokenSecretName` | string | GeneratedTokenSecretName stores the generated operator API token. |

### SecretKeySelector

SecretKeySelector identifies a key in a Secret.

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | Name is the Kubernetes Secret name. |
| `key` | string | Key is the key inside the Secret data map. |

### ServiceSpec

ServiceSpec defines the Service configuration reconciled by the operator.

| Field | Type | Description |
| --- | --- | --- |
| `type` | [ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#servicetype-v1-core) | Type controls the Kubernetes service type. |
| `port` | integer | Port controls the exposed service port. |
| `annotations` | object (keys:string, values:string) | Annotations are applied to the reconciled service object. |

## Source

Expand Down
87 changes: 53 additions & 34 deletions docs/reference/api/coderprovisioner.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,45 +13,64 @@

| Field | Type | Description |
| --- | --- | --- |
| `controlPlaneRef` | `corev1.LocalObjectReference` | ControlPlaneRef identifies which CoderControlPlane instance to join. |
| └─ `name` | `string` | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) |
| `organizationName` | `string` | OrganizationName is the Coder organization. Defaults to "default". |
| `bootstrap` | `CoderProvisionerBootstrapSpec` | Bootstrap configures credentials for provisioner key management. |
| └─ `credentialsSecretRef` | `SecretKeySelector` | CredentialsSecretRef points to a Secret containing a Coder session token with permission to manage provisioner keys. |
|    â”œâ”€ `name` | `string` | Name is the Kubernetes Secret name. |
|    â””─ `key` | `string` | Key is the key inside the Secret data map. |
| `key` | `CoderProvisionerKeySpec` | Key configures provisioner key naming and secret storage. |
| ├─ `name` | `string` | Name is the provisioner key name in coderd. Defaults to the CR name. |
| ├─ `secretName` | `string` | SecretName is the Kubernetes Secret to store the key. Defaults to "\{crName\}-provisioner-key". |
| └─ `secretKey` | `string` | SecretKey is the data key in the Secret. Defaults to "key". |
| `replicas` | `int32` | Replicas is the desired number of provisioner pods. |
| `tags` | `map[string]string` | Tags are attached to the provisioner key for job routing. |
| `image` | `string` | Image is the container image. Defaults to the control plane image. |
| `extraArgs` | `[]string` | ExtraArgs are appended after "provisionerd start". |
| `extraEnv` | `[]corev1.EnvVar` | ExtraEnv are injected into the provisioner container. |
| `resources` | `corev1.ResourceRequirements` | Resources for the provisioner container. |
| `imagePullSecrets` | `[]corev1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
| └─ `name` | `string` | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: [https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) |
| `terminationGracePeriodSeconds` | `int64` | TerminationGracePeriodSeconds for the provisioner pods. |
| `controlPlaneRef` | [LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) | ControlPlaneRef identifies which CoderControlPlane instance to join. |
| `organizationName` | string | OrganizationName is the Coder organization. Defaults to "default". |
| `bootstrap` | [CoderProvisionerBootstrapSpec](#coderprovisionerbootstrapspec) | Bootstrap configures credentials for provisioner key management. |
| `key` | [CoderProvisionerKeySpec](#coderprovisionerkeyspec) | Key configures provisioner key naming and secret storage. |
| `replicas` | integer | Replicas is the desired number of provisioner pods. |
| `tags` | object (keys:string, values:string) | Tags are attached to the provisioner key for job routing. |
| `image` | string | Image is the container image. Defaults to the control plane image. |
| `extraArgs` | string array | ExtraArgs are appended after "provisionerd start". |
| `extraEnv` | [EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#envvar-v1-core) array | ExtraEnv are injected into the provisioner container. |
| `resources` | [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#resourcerequirements-v1-core) | Resources for the provisioner container. |
| `imagePullSecrets` | [LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#localobjectreference-v1-core) array | ImagePullSecrets are used by the pod to pull private images. |
| `terminationGracePeriodSeconds` | integer | TerminationGracePeriodSeconds for the provisioner pods. |

## Status

| Field | Type | Description |
| --- | --- | --- |
| `observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
| `readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
| `phase` | `string` | Phase is a high-level readiness indicator. |
| `conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
| `organizationID` | `string` | OrganizationID is the organization ID last applied to the provisioner key. |
| `organizationName` | `string` | OrganizationName is the organization name last applied to the provisioner key. |
| `provisionerKeyID` | `string` | ProvisionerKeyID is the provisioner key ID last applied in coderd. |
| `provisionerKeyName` | `string` | ProvisionerKeyName is the provisioner key name last applied in coderd. |
| `tagsHash` | `string` | TagsHash is a deterministic hash of spec.tags last applied to the provisioner key. |
| `controlPlaneRefName` | `string` | ControlPlaneRefName is the control plane ref name last applied to the provisioner key. |
| `controlPlaneURL` | `string` | ControlPlaneURL is the control plane URL last applied to the provisioner key. |
| `secretRef` | `SecretKeySelector` | SecretRef references the provisioner key secret data currently in use. |
| ├─ `name` | `string` | Name is the Kubernetes Secret name. |
| └─ `key` | `string` | Key is the key inside the Secret data map. |
| `observedGeneration` | integer | ObservedGeneration tracks the spec generation this status reflects. |
| `readyReplicas` | integer | ReadyReplicas is the number of ready pods observed in the deployment. |
| `phase` | string | Phase is a high-level readiness indicator. |
| `conditions` | [Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#condition-v1-meta) array | Conditions are Kubernetes-standard conditions for this resource. |
| `organizationID` | string | OrganizationID is the organization ID last applied to the provisioner key. |
| `organizationName` | string | OrganizationName is the organization name last applied to the provisioner key. |
| `provisionerKeyID` | string | ProvisionerKeyID is the provisioner key ID last applied in coderd. |
| `provisionerKeyName` | string | ProvisionerKeyName is the provisioner key name last applied in coderd. |
| `tagsHash` | string | TagsHash is a deterministic hash of spec.tags last applied to the provisioner key. |
| `controlPlaneRefName` | string | ControlPlaneRefName is the control plane ref name last applied to the provisioner key. |
| `controlPlaneURL` | string | ControlPlaneURL is the control plane URL last applied to the provisioner key. |
| `secretRef` | [SecretKeySelector](#secretkeyselector) | SecretRef references the provisioner key secret data currently in use. |

## Referenced types

### CoderProvisionerBootstrapSpec

CoderProvisionerBootstrapSpec configures credentials for provisioner key management.

| Field | Type | Description |
| --- | --- | --- |
| `credentialsSecretRef` | [SecretKeySelector](#secretkeyselector) | CredentialsSecretRef points to a Secret containing a Coder session token with permission to manage provisioner keys. |

### CoderProvisionerKeySpec

CoderProvisionerKeySpec configures provisioner key naming and storage.

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | Name is the provisioner key name in coderd. Defaults to the CR name. |
| `secretName` | string | SecretName is the Kubernetes Secret to store the key. Defaults to "\{crName\}-provisioner-key". |
| `secretKey` | string | SecretKey is the data key in the Secret. Defaults to "key". |

### SecretKeySelector

SecretKeySelector identifies a key in a Secret.

| Field | Type | Description |
| --- | --- | --- |
| `name` | string | Name is the Kubernetes Secret name. |
| `key` | string | Key is the key inside the Secret data map. |

## Source

Expand Down
24 changes: 12 additions & 12 deletions docs/reference/api/codertemplate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@

| Field | Type | Description |
| --- | --- | --- |
| `organization` | `string` | Organization is the Coder organization name (must match the organization prefix in metadata.name). |
| `versionID` | `string` | VersionID is the Coder template version UUID used on creation (required for CREATE). |
| `displayName` | `string` | |
| `description` | `string` | |
| `icon` | `string` | |
| `running` | `bool` | Running is a legacy flag retained temporarily for in-repo callers that still read template run-state directly. |
| `organization` | string | Organization is the Coder organization name (must match the organization prefix in metadata.name). |
| `versionID` | string | VersionID is the Coder template version UUID used on creation (required for CREATE). |
| `displayName` | string | |
| `description` | string | |
| `icon` | string | |
| `running` | boolean | Running is a legacy flag retained temporarily for in-repo callers that still read template run-state directly. |

## Status

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | |
| `organizationName` | `string` | |
| `activeVersionID` | `string` | |
| `deprecated` | `bool` | |
| `updatedAt` | `metav1.Time` | |
| `autoShutdown` | `metav1.Time` | AutoShutdown is a legacy timestamp retained temporarily for in-repo callers that still surface template shutdown timestamps. |
| `id` | string | |
| `organizationName` | string | |
| `activeVersionID` | string | |
| `deprecated` | boolean | |
| `updatedAt` | [Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta) | |
| `autoShutdown` | [Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta) | AutoShutdown is a legacy timestamp retained temporarily for in-repo callers that still surface template shutdown timestamps. |

## Source

Expand Down
28 changes: 14 additions & 14 deletions docs/reference/api/coderworkspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@

| Field | Type | Description |
| --- | --- | --- |
| `organization` | `string` | Organization is the Coder organization name. |
| `templateName` | `string` | TemplateName resolves via TemplateByName(organization, templateName). |
| `templateVersionID` | `string` | TemplateVersionID optionally pins to a specific template version. |
| `running` | `bool` | Running drives start/stop via CreateWorkspaceBuild. |
| `ttlMillis` | `int64` | |
| `autostartSchedule` | `string` | |
| `organization` | string | Organization is the Coder organization name. |
| `templateName` | string | TemplateName resolves via TemplateByName(organization, templateName). |
| `templateVersionID` | string | TemplateVersionID optionally pins to a specific template version. |
| `running` | boolean | Running drives start/stop via CreateWorkspaceBuild. |
| `ttlMillis` | integer | |
| `autostartSchedule` | string | |

## Status

| Field | Type | Description |
| --- | --- | --- |
| `id` | `string` | |
| `ownerName` | `string` | |
| `organizationName` | `string` | |
| `templateName` | `string` | |
| `latestBuildID` | `string` | |
| `latestBuildStatus` | `string` | |
| `autoShutdown` | `metav1.Time` | |
| `lastUsedAt` | `metav1.Time` | |
| `id` | string | |
| `ownerName` | string | |
| `organizationName` | string | |
| `templateName` | string | |
| `latestBuildID` | string | |
| `latestBuildStatus` | string | |
| `autoShutdown` | [Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta) | |
| `lastUsedAt` | [Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta) | |

## Source

Expand Down
Loading