Skip to content

codercontrolplane.md

Latest commit

 

History

History
47 lines (38 loc) · 2.92 KB

codercontrolplane.md

File metadata and controls

47 lines (38 loc) · 2.92 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 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
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.

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.

Source

  • Go type: api/v1alpha1/codercontrolplane_types.go
  • Generated CRD: config/crd/bases/coder.com_codercontrolplanes.yaml