Skip to content

Commit ff7f500

Browse files
ThomasK33ThomasK33
committed
🤖 fix: make generated CRD API docs YAML-oriented
1 parent be6654a commit ff7f500

6 files changed

Lines changed: 149 additions & 86 deletions

File tree

‎docs/reference/api/codercontrolplane.md‎

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,35 @@
1313

1414
| Field | Type | Description |
1515
| --- | --- | --- |
16-
| `spec.image` | `string` | Image is the container image used for the Coder control plane pod. |
17-
| `spec.replicas` | `int32` | Replicas is the desired number of control plane pods. |
18-
| `spec.service` | `github.com/coder/coder-k8s/api/v1alpha1.ServiceSpec` | Service controls the service created in front of the control plane. |
19-
| `spec.extraArgs` | `[]string` | ExtraArgs are appended to the default Coder server arguments. |
20-
| `spec.extraEnv` | `[]k8s.io/api/core/v1.EnvVar` | ExtraEnv are injected into the Coder control plane container. |
21-
| `spec.imagePullSecrets` | `[]k8s.io/api/core/v1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
22-
| `spec.operatorAccess` | `github.com/coder/coder-k8s/api/v1alpha1.OperatorAccessSpec` | OperatorAccess configures bootstrap API access to the coderd instance. |
16+
| `image` | `string` | Image is the container image used for the Coder control plane pod. |
17+
| `replicas` | `int32` | Replicas is the desired number of control plane pods. |
18+
| `service` | `ServiceSpec` | Service controls the service created in front of the control plane. |
19+
|   `type` | `corev1.ServiceType` | Type controls the Kubernetes service type. |
20+
|   `port` | `int32` | Port controls the exposed service port. |
21+
|   `annotations` | `map[string]string` | Annotations are applied to the reconciled service object. |
22+
| `extraArgs` | `[]string` | ExtraArgs are appended to the default Coder server arguments. |
23+
| `extraEnv` | `[]corev1.EnvVar` | ExtraEnv are injected into the Coder control plane container. |
24+
| `imagePullSecrets` | `[]corev1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
25+
| &nbsp;&nbsp;`name` | `string` | Name of the referent.<br />This field is effectively required, but due to backwards compatibility is<br />allowed to be empty. Instances of this type with an empty value here are<br />almost certainly wrong.<br />More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
26+
| `operatorAccess` | `OperatorAccessSpec` | OperatorAccess configures bootstrap API access to the coderd instance. |
27+
| &nbsp;&nbsp;`disabled` | `bool` | Disabled turns off creation and management of the `coder-k8s-operator`<br />user and API token. |
28+
| &nbsp;&nbsp;`generatedTokenSecretName` | `string` | GeneratedTokenSecretName stores the generated operator API token. |
29+
2330

2431
## Status
2532

2633
| Field | Type | Description |
2734
| --- | --- | --- |
28-
| `status.observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
29-
| `status.readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
30-
| `status.url` | `string` | URL is the in-cluster URL for the control plane service. |
31-
| `status.operatorTokenSecretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token. |
32-
| `status.operatorAccessReady` | `bool` | OperatorAccessReady reports whether operator API access bootstrap succeeded. |
33-
| `status.phase` | `string` | Phase is a high-level readiness indicator. |
34-
| `status.conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
35+
| `observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
36+
| `readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
37+
| `url` | `string` | URL is the in-cluster URL for the control plane service. |
38+
| `operatorTokenSecretRef` | `SecretKeySelector` | OperatorTokenSecretRef points to the Secret key containing the `coder-k8s-operator` API token. |
39+
| &nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
40+
| &nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
41+
| `operatorAccessReady` | `bool` | OperatorAccessReady reports whether operator API access bootstrap succeeded. |
42+
| `phase` | `string` | Phase is a high-level readiness indicator. |
43+
| `conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
44+
3545

3646
## Source
3747

‎docs/reference/api/coderprovisioner.md‎

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,35 +13,47 @@
1313

1414
| Field | Type | Description |
1515
| --- | --- | --- |
16-
| `spec.controlPlaneRef` | `k8s.io/api/core/v1.LocalObjectReference` | ControlPlaneRef identifies which CoderControlPlane instance to join. |
17-
| `spec.organizationName` | `string` | OrganizationName is the Coder organization. Defaults to "default". |
18-
| `spec.bootstrap` | `github.com/coder/coder-k8s/api/v1alpha1.CoderProvisionerBootstrapSpec` | Bootstrap configures credentials for provisioner key management. |
19-
| `spec.key` | `github.com/coder/coder-k8s/api/v1alpha1.CoderProvisionerKeySpec` | Key configures provisioner key naming and secret storage. |
20-
| `spec.replicas` | `int32` | Replicas is the desired number of provisioner pods. |
21-
| `spec.tags` | `map[string]string` | Tags are attached to the provisioner key for job routing. |
22-
| `spec.image` | `string` | Image is the container image. Defaults to the control plane image. |
23-
| `spec.extraArgs` | `[]string` | ExtraArgs are appended after "provisionerd start". |
24-
| `spec.extraEnv` | `[]k8s.io/api/core/v1.EnvVar` | ExtraEnv are injected into the provisioner container. |
25-
| `spec.resources` | `k8s.io/api/core/v1.ResourceRequirements` | Resources for the provisioner container. |
26-
| `spec.imagePullSecrets` | `[]k8s.io/api/core/v1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
27-
| `spec.terminationGracePeriodSeconds` | `int64` | TerminationGracePeriodSeconds for the provisioner pods. |
16+
| `controlPlaneRef` | `corev1.LocalObjectReference` | ControlPlaneRef identifies which CoderControlPlane instance to join. |
17+
| &nbsp;&nbsp;`name` | `string` | Name of the referent.<br />This field is effectively required, but due to backwards compatibility is<br />allowed to be empty. Instances of this type with an empty value here are<br />almost certainly wrong.<br />More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
18+
| `organizationName` | `string` | OrganizationName is the Coder organization. Defaults to "default". |
19+
| `bootstrap` | `CoderProvisionerBootstrapSpec` | Bootstrap configures credentials for provisioner key management. |
20+
| &nbsp;&nbsp;`credentialsSecretRef` | `SecretKeySelector` | CredentialsSecretRef points to a Secret containing a Coder session token<br />with permission to manage provisioner keys. |
21+
| &nbsp;&nbsp;&nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
22+
| &nbsp;&nbsp;&nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
23+
| `key` | `CoderProvisionerKeySpec` | Key configures provisioner key naming and secret storage. |
24+
| &nbsp;&nbsp;`name` | `string` | Name is the provisioner key name in coderd. Defaults to the CR name. |
25+
| &nbsp;&nbsp;`secretName` | `string` | SecretName is the Kubernetes Secret to store the key. Defaults to "\{crName\}-provisioner-key". |
26+
| &nbsp;&nbsp;`secretKey` | `string` | SecretKey is the data key in the Secret. Defaults to "key". |
27+
| `replicas` | `int32` | Replicas is the desired number of provisioner pods. |
28+
| `tags` | `map[string]string` | Tags are attached to the provisioner key for job routing. |
29+
| `image` | `string` | Image is the container image. Defaults to the control plane image. |
30+
| `extraArgs` | `[]string` | ExtraArgs are appended after "provisionerd start". |
31+
| `extraEnv` | `[]corev1.EnvVar` | ExtraEnv are injected into the provisioner container. |
32+
| `resources` | `corev1.ResourceRequirements` | Resources for the provisioner container. |
33+
| `imagePullSecrets` | `[]corev1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
34+
| &nbsp;&nbsp;`name` | `string` | Name of the referent.<br />This field is effectively required, but due to backwards compatibility is<br />allowed to be empty. Instances of this type with an empty value here are<br />almost certainly wrong.<br />More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
35+
| `terminationGracePeriodSeconds` | `int64` | TerminationGracePeriodSeconds for the provisioner pods. |
36+
2837

2938
## Status
3039

3140
| Field | Type | Description |
3241
| --- | --- | --- |
33-
| `status.observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
34-
| `status.readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
35-
| `status.phase` | `string` | Phase is a high-level readiness indicator. |
36-
| `status.conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
37-
| `status.organizationID` | `string` | OrganizationID is the organization ID last applied to the provisioner key. |
38-
| `status.organizationName` | `string` | OrganizationName is the organization name last applied to the provisioner key. |
39-
| `status.provisionerKeyID` | `string` | ProvisionerKeyID is the provisioner key ID last applied in coderd. |
40-
| `status.provisionerKeyName` | `string` | ProvisionerKeyName is the provisioner key name last applied in coderd. |
41-
| `status.tagsHash` | `string` | TagsHash is a deterministic hash of spec.tags last applied to the provisioner key. |
42-
| `status.controlPlaneRefName` | `string` | ControlPlaneRefName is the control plane ref name last applied to the provisioner key. |
43-
| `status.controlPlaneURL` | `string` | ControlPlaneURL is the control plane URL last applied to the provisioner key. |
44-
| `status.secretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | SecretRef references the provisioner key secret data currently in use. |
42+
| `observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
43+
| `readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
44+
| `phase` | `string` | Phase is a high-level readiness indicator. |
45+
| `conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
46+
| `organizationID` | `string` | OrganizationID is the organization ID last applied to the provisioner key. |
47+
| `organizationName` | `string` | OrganizationName is the organization name last applied to the provisioner key. |
48+
| `provisionerKeyID` | `string` | ProvisionerKeyID is the provisioner key ID last applied in coderd. |
49+
| `provisionerKeyName` | `string` | ProvisionerKeyName is the provisioner key name last applied in coderd. |
50+
| `tagsHash` | `string` | TagsHash is a deterministic hash of spec.tags last applied to the provisioner key. |
51+
| `controlPlaneRefName` | `string` | ControlPlaneRefName is the control plane ref name last applied to the provisioner key. |
52+
| `controlPlaneURL` | `string` | ControlPlaneURL is the control plane URL last applied to the provisioner key. |
53+
| `secretRef` | `SecretKeySelector` | SecretRef references the provisioner key secret data currently in use. |
54+
| &nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
55+
| &nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
56+
4557

4658
## Source
4759

‎docs/reference/api/codertemplate.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,25 @@
1313

1414
| Field | Type | Description |
1515
| --- | --- | --- |
16-
| `spec.organization` | `string` | Organization is the Coder organization name (must match the organization prefix in metadata.name). |
17-
| `spec.versionID` | `string` | VersionID is the Coder template version UUID used on creation (required for CREATE). |
18-
| `spec.displayName` | `string` | |
19-
| `spec.description` | `string` | |
20-
| `spec.icon` | `string` | |
21-
| `spec.running` | `bool` | Running is a legacy flag retained temporarily for in-repo callers that still read template run-state directly. |
16+
| `organization` | `string` | Organization is the Coder organization name (must match the organization prefix in metadata.name). |
17+
| `versionID` | `string` | VersionID is the Coder template version UUID used on creation (required for CREATE). |
18+
| `displayName` | `string` | |
19+
| `description` | `string` | |
20+
| `icon` | `string` | |
21+
| `running` | `bool` | Running is a legacy flag retained temporarily for in-repo callers that still read template run-state directly. |
22+
2223

2324
## Status
2425

2526
| Field | Type | Description |
2627
| --- | --- | --- |
27-
| `status.id` | `string` | |
28-
| `status.organizationName` | `string` | |
29-
| `status.activeVersionID` | `string` | |
30-
| `status.deprecated` | `bool` | |
31-
| `status.updatedAt` | `metav1.Time` | |
32-
| `status.autoShutdown` | `metav1.Time` | AutoShutdown is a legacy timestamp retained temporarily for in-repo callers that still surface template shutdown timestamps. |
28+
| `id` | `string` | |
29+
| `organizationName` | `string` | |
30+
| `activeVersionID` | `string` | |
31+
| `deprecated` | `bool` | |
32+
| `updatedAt` | `metav1.Time` | |
33+
| `autoShutdown` | `metav1.Time` | AutoShutdown is a legacy timestamp retained temporarily for in-repo callers that still surface template shutdown timestamps. |
34+
3335

3436
## Source
3537

‎docs/reference/api/coderworkspace.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,27 @@
1313

1414
| Field | Type | Description |
1515
| --- | --- | --- |
16-
| `spec.organization` | `string` | Organization is the Coder organization name. |
17-
| `spec.templateName` | `string` | TemplateName resolves via TemplateByName(organization, templateName). |
18-
| `spec.templateVersionID` | `string` | TemplateVersionID optionally pins to a specific template version. |
19-
| `spec.running` | `bool` | Running drives start/stop via CreateWorkspaceBuild. |
20-
| `spec.ttlMillis` | `int64` | |
21-
| `spec.autostartSchedule` | `string` | |
16+
| `organization` | `string` | Organization is the Coder organization name. |
17+
| `templateName` | `string` | TemplateName resolves via TemplateByName(organization, templateName). |
18+
| `templateVersionID` | `string` | TemplateVersionID optionally pins to a specific template version. |
19+
| `running` | `bool` | Running drives start/stop via CreateWorkspaceBuild. |
20+
| `ttlMillis` | `int64` | |
21+
| `autostartSchedule` | `string` | |
22+
2223

2324
## Status
2425

2526
| Field | Type | Description |
2627
| --- | --- | --- |
27-
| `status.id` | `string` | |
28-
| `status.ownerName` | `string` | |
29-
| `status.organizationName` | `string` | |
30-
| `status.templateName` | `string` | |
31-
| `status.latestBuildID` | `string` | |
32-
| `status.latestBuildStatus` | `string` | |
33-
| `status.autoShutdown` | `metav1.Time` | |
34-
| `status.lastUsedAt` | `metav1.Time` | |
28+
| `id` | `string` | |
29+
| `ownerName` | `string` | |
30+
| `organizationName` | `string` | |
31+
| `templateName` | `string` | |
32+
| `latestBuildID` | `string` | |
33+
| `latestBuildStatus` | `string` | |
34+
| `autoShutdown` | `metav1.Time` | |
35+
| `lastUsedAt` | `metav1.Time` | |
36+
3537

3638
## Source
3739

‎docs/reference/api/workspaceproxy.md‎

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,45 @@
1313

1414
| Field | Type | Description |
1515
| --- | --- | --- |
16-
| `spec.image` | `string` | Image is the container image used for the workspace proxy pod. |
17-
| `spec.replicas` | `int32` | Replicas is the desired number of proxy pods. |
18-
| `spec.service` | `github.com/coder/coder-k8s/api/v1alpha1.ServiceSpec` | Service controls the service created in front of the workspace proxy. |
19-
| `spec.primaryAccessURL` | `string` | PrimaryAccessURL is the coderd URL the proxy should connect to. |
20-
| `spec.proxySessionTokenSecretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | ProxySessionTokenSecretRef points to a Secret key containing the proxy token. |
21-
| `spec.bootstrap` | `github.com/coder/coder-k8s/api/v1alpha1.ProxyBootstrapSpec` | Bootstrap optionally registers the proxy and mints a proxy token. |
22-
| `spec.derpOnly` | `bool` | DerpOnly configures the workspace proxy to only serve DERP traffic. |
23-
| `spec.extraArgs` | `[]string` | ExtraArgs are appended to the default workspace proxy arguments. |
24-
| `spec.extraEnv` | `[]k8s.io/api/core/v1.EnvVar` | ExtraEnv are injected into the workspace proxy container. |
25-
| `spec.imagePullSecrets` | `[]k8s.io/api/core/v1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
16+
| `image` | `string` | Image is the container image used for the workspace proxy pod. |
17+
| `replicas` | `int32` | Replicas is the desired number of proxy pods. |
18+
| `service` | `ServiceSpec` | Service controls the service created in front of the workspace proxy. |
19+
| &nbsp;&nbsp;`type` | `corev1.ServiceType` | Type controls the Kubernetes service type. |
20+
| &nbsp;&nbsp;`port` | `int32` | Port controls the exposed service port. |
21+
| &nbsp;&nbsp;`annotations` | `map[string]string` | Annotations are applied to the reconciled service object. |
22+
| `primaryAccessURL` | `string` | PrimaryAccessURL is the coderd URL the proxy should connect to. |
23+
| `proxySessionTokenSecretRef` | `SecretKeySelector` | ProxySessionTokenSecretRef points to a Secret key containing the proxy token. |
24+
| &nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
25+
| &nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
26+
| `bootstrap` | `ProxyBootstrapSpec` | Bootstrap optionally registers the proxy and mints a proxy token. |
27+
| &nbsp;&nbsp;`coderURL` | `string` | CoderURL is the URL for the primary Coder control plane API. |
28+
| &nbsp;&nbsp;`credentialsSecretRef` | `SecretKeySelector` | CredentialsSecretRef points to a Secret containing a Coder session token. |
29+
| &nbsp;&nbsp;&nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
30+
| &nbsp;&nbsp;&nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
31+
| &nbsp;&nbsp;`proxyName` | `string` | ProxyName is the name used when registering the proxy in Coder. |
32+
| &nbsp;&nbsp;`displayName` | `string` | DisplayName is the human-readable name for the proxy region. |
33+
| &nbsp;&nbsp;`icon` | `string` | Icon is the optional icon URL or emoji path for the proxy region. |
34+
| &nbsp;&nbsp;`generatedTokenSecretName` | `string` | GeneratedTokenSecretName stores the generated proxy token. |
35+
| `derpOnly` | `bool` | DerpOnly configures the workspace proxy to only serve DERP traffic. |
36+
| `extraArgs` | `[]string` | ExtraArgs are appended to the default workspace proxy arguments. |
37+
| `extraEnv` | `[]corev1.EnvVar` | ExtraEnv are injected into the workspace proxy container. |
38+
| `imagePullSecrets` | `[]corev1.LocalObjectReference` | ImagePullSecrets are used by the pod to pull private images. |
39+
| &nbsp;&nbsp;`name` | `string` | Name of the referent.<br />This field is effectively required, but due to backwards compatibility is<br />allowed to be empty. Instances of this type with an empty value here are<br />almost certainly wrong.<br />More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
40+
2641

2742
## Status
2843

2944
| Field | Type | Description |
3045
| --- | --- | --- |
31-
| `status.observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
32-
| `status.readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
33-
| `status.registered` | `bool` | Registered reports whether bootstrap registration completed successfully. |
34-
| `status.proxyTokenSecretRef` | `github.com/coder/coder-k8s/api/v1alpha1.SecretKeySelector` | ProxyTokenSecretRef is the Secret used for the proxy session token. |
35-
| `status.phase` | `string` | Phase is a high-level readiness indicator. |
36-
| `status.conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
46+
| `observedGeneration` | `int64` | ObservedGeneration tracks the spec generation this status reflects. |
47+
| `readyReplicas` | `int32` | ReadyReplicas is the number of ready pods observed in the deployment. |
48+
| `registered` | `bool` | Registered reports whether bootstrap registration completed successfully. |
49+
| `proxyTokenSecretRef` | `SecretKeySelector` | ProxyTokenSecretRef is the Secret used for the proxy session token. |
50+
| &nbsp;&nbsp;`name` | `string` | Name is the Kubernetes Secret name. |
51+
| &nbsp;&nbsp;`key` | `string` | Key is the key inside the Secret data map. |
52+
| `phase` | `string` | Phase is a high-level readiness indicator. |
53+
| `conditions` | `[]metav1.Condition` | Conditions are Kubernetes-standard conditions for this resource. |
54+
3755

3856
## Source
3957

0 commit comments

Comments
 (0)