Skip to content

codercontrolplane.md

Latest commit

 

History

History
72 lines (53 loc) · 3.95 KB

codercontrolplane.md

File metadata and controls

72 lines (53 loc) · 3.95 KB
Raw

CoderControlPlane

API identity

  • Group/version: coder.com/v1alpha1
  • Kind: CoderControlPlane
  • Resource: codercontrolplanes
  • Scope: namespaced

Spec

Field Type Description
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 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 array ExtraEnv are injected into the Coder control plane container.
imagePullSecrets LocalObjectReference array ImagePullSecrets are used by the pod to pull private images.
operatorAccess OperatorAccessSpec OperatorAccess configures bootstrap API access to the coderd instance.
licenseSecretRef SecretKeySelector LicenseSecretRef references a Secret key containing a Coder Enterprise license JWT. When set, the controller uploads the license after the control plane is ready and re-uploads when the Secret value changes.

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.
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.
operatorAccessReady boolean OperatorAccessReady reports whether operator API access bootstrap succeeded.
licenseLastApplied Time LicenseLastApplied is the timestamp of the most recent successful operator-managed license upload.
licenseLastAppliedHash string LicenseLastAppliedHash is the SHA-256 hex hash of the trimmed license JWT that LicenseLastApplied refers to.
phase string Phase is a high-level readiness indicator.
conditions Condition 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 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/codercontrolplane_types.go
  • Generated CRD: config/crd/bases/coder.com_codercontrolplanes.yaml