Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 3.33 KB

File metadata and controls

70 lines (50 loc) · 3.33 KB

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. |

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. | | 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