|
| 1 | +<!-- Code generated by hack/update-reference-docs.sh using github.com/elastic/crd-ref-docs. DO NOT EDIT. --> |
| 2 | + |
| 3 | +# `WorkspaceProxy` |
| 4 | + |
| 5 | +## API identity |
| 6 | + |
| 7 | +- Group/version: `coder.com/v1alpha1` |
| 8 | +- Kind: `WorkspaceProxy` |
| 9 | +- Resource: `workspaceproxies` |
| 10 | +- Scope: namespaced |
| 11 | + |
| 12 | +## Spec |
| 13 | + |
| 14 | +| Field | Type | Description | |
| 15 | +| --- | --- | --- | |
| 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. | |
| 26 | + |
| 27 | +## Status |
| 28 | + |
| 29 | +| Field | Type | Description | |
| 30 | +| --- | --- | --- | |
| 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. | |
| 37 | + |
| 38 | +## Source |
| 39 | + |
| 40 | +- Go type: `api/v1alpha1/workspaceproxy_types.go` |
| 41 | +- Generated CRD: `config/crd/bases/coder.com_workspaceproxies.yaml` |
0 commit comments