CoderWorkspaceProxy
API identity
- Group/version:
coder.com/v1alpha1
- Kind:
CoderWorkspaceProxy
- Resource:
coderworkspaceproxies
- Scope: namespaced
Spec
| Field |
Type |
Description |
image |
string |
Image is the container image used for the workspace proxy pod. |
replicas |
integer |
Replicas is the desired number of proxy pods. |
service |
ServiceSpec |
Service controls the service created in front of the workspace proxy. |
primaryAccessURL |
string |
PrimaryAccessURL is the coderd URL the proxy should connect to. |
proxySessionTokenSecretRef |
SecretKeySelector |
ProxySessionTokenSecretRef points to a Secret key containing the proxy token. |
bootstrap |
ProxyBootstrapSpec |
Bootstrap optionally registers the proxy and mints a proxy token. |
derpOnly |
boolean |
DerpOnly configures the workspace proxy to only serve DERP traffic. |
extraArgs |
string array |
ExtraArgs are appended to the default workspace proxy arguments. |
extraEnv |
EnvVar array |
ExtraEnv are injected into the workspace proxy container. |
imagePullSecrets |
LocalObjectReference array |
ImagePullSecrets are used by the pod to pull private images. |
Status
| Field |
Type |
Description |
observedGeneration |
integer |
ObservedGeneration tracks the spec generation this status reflects. |
readyReplicas |
integer |
ReadyReplicas is the number of ready pods observed in the deployment. |
registered |
boolean |
Registered reports whether bootstrap registration completed successfully. |
proxyTokenSecretRef |
SecretKeySelector |
ProxyTokenSecretRef is the Secret used for the proxy session token. |
phase |
string |
Phase is a high-level readiness indicator. |
conditions |
Condition array |
Conditions are Kubernetes-standard conditions for this resource. |
Referenced types
ProxyBootstrapSpec
ProxyBootstrapSpec configures optional registration with the Coder API.
| Field |
Type |
Description |
coderURL |
string |
CoderURL is the URL for the primary Coder control plane API. |
credentialsSecretRef |
SecretKeySelector |
CredentialsSecretRef points to a Secret containing a Coder session token. |
proxyName |
string |
ProxyName is the name used when registering the proxy in Coder. |
displayName |
string |
DisplayName is the human-readable name for the proxy region. |
icon |
string |
Icon is the optional icon URL or emoji path for the proxy region. |
generatedTokenSecretName |
string |
GeneratedTokenSecretName stores the generated proxy 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 |
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
- Go type:
api/v1alpha1/coderworkspaceproxy_types.go
- Generated CRD:
config/crd/bases/coder.com_coderworkspaceproxies.yaml