ClusterBuildPlane

A ClusterBuildPlane is a cluster-scoped variant of BuildPlane that represents the infrastructure layer responsible for executing build workloads in OpenChoreo. Unlike the namespace-scoped BuildPlane, a ClusterBuildPlane is a cluster-scoped resource, making it suitable for shared build infrastructure scenarios.

OpenChoreo uses agent-based communication where the control plane communicates with the build cluster through a WebSocket agent running in the ClusterBuildPlane cluster. The cluster agent establishes a secure WebSocket connection to the control plane's cluster gateway.

API Version

openchoreo.dev/v1alpha1

Resource Definition

Metadata

ClusterBuildPlanes are cluster-scoped resources (no namespace).

apiVersion: openchoreo.dev/v1alpha1
kind: ClusterBuildPlane
metadata:
  name: <clusterbuildplane-name>

Spec Fields

Field	Type	Required	Default	Description
planeID	string	No	CR name	Identifies the logical plane this CR connects to. Must match clusterAgent.planeId Helm value.
clusterAgent	ClusterAgentConfig	Yes	-	Configuration for cluster agent-based communication
secretStoreRef	SecretStoreRef	No	-	Reference to External Secrets Operator ClusterSecretStore in the ClusterBuildPlane
observabilityPlaneRef	ObservabilityPlaneRef	No	-	Reference to a ClusterObservabilityPlane resource for monitoring and logging

PlaneID

The planeID identifies the logical plane this ClusterBuildPlane CR connects to. Multiple ClusterBuildPlane CRs can share the same planeID to connect to the same physical cluster while maintaining separate configurations.

Validation Rules:

• Maximum length: 63 characters
• Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ (lowercase alphanumeric, hyphens allowed)
• Examples: "shared-builder", "ci-cluster", "us-west-2"

PlaneID Consistency

The planeID in the ClusterBuildPlane CR must match the clusterAgent.planeId Helm value configured during build plane installation. If not specified, it defaults to the CR name for backwards compatibility.

ClusterAgentConfig

Configuration for cluster agent-based communication with the build cluster. The cluster agent establishes a WebSocket connection to the control plane's cluster gateway.

Field	Type	Required	Default	Description
clientCA	ValueFrom	Yes	-	CA certificate to verify the agent's client certificate (base64-encoded PEM)

SecretStoreRef

Reference to an External Secrets Operator ClusterSecretStore.

Field	Type	Required	Default	Description
name	string	Yes	-	Name of the ClusterSecretStore in the ClusterBuildPlane

ObservabilityPlaneRef

Reference to a ClusterObservabilityPlane for monitoring and logging.

Field	Type	Required	Default	Description
kind	string	No	ClusterObservabilityPlane	Must be ClusterObservabilityPlane. ClusterBuildPlane can only reference cluster-scoped observability planes.
name	string	Yes	-	Name of the ClusterObservabilityPlane resource

Resolution Behavior

• ClusterBuildPlane can only reference a ClusterObservabilityPlane (not a namespace-scoped ObservabilityPlane). This is enforced by API validation.
• If observabilityPlaneRef is omitted, the controller attempts to find a ClusterObservabilityPlane named "default". If no default exists, observability is not configured.
• If the referenced ClusterObservabilityPlane is not found, the controller returns an error and the ClusterBuildPlane will not become ready.

ValueFrom

Common pattern for referencing secrets or providing inline values. Either secretRef or value should be specified.

Field	Type	Required	Default	Description
secretRef	SecretKeyReference	No	-	Reference to a secret key
value	string	No	-	Inline value (not recommended for sensitive data)

SecretKeyReference

Reference to a specific key in a Kubernetes secret.

Field	Type	Required	Default	Description
name	string	Yes	-	Name of the secret
namespace	string	No*	-	Namespace of the secret (required for cluster-scoped resources)
key	string	Yes	-	Key within the secret

Status Fields

Field	Type	Default	Description
observedGeneration	integer	0	The generation observed by the controller
conditions	[]Condition	[]	Standard Kubernetes conditions tracking the ClusterBuildPlane state
agentConnection	AgentConnectionStatus	-	Tracks the status of cluster agent connections

AgentConnectionStatus

Field	Type	Default	Description
connected	boolean	false	Whether any cluster agent is currently connected
connectedAgents	integer	0	Number of cluster agents currently connected
lastConnectedTime	timestamp	-	When an agent last successfully connected
lastDisconnectedTime	timestamp	-	When the last agent disconnected
lastHeartbeatTime	timestamp	-	When the control plane last received any communication from an agent
message	string	-	Additional information about the agent connection status

Examples

Basic ClusterBuildPlane Configuration

This example shows a minimal ClusterBuildPlane configuration.

apiVersion: openchoreo.dev/v1alpha1
kind: ClusterBuildPlane
metadata:
  name: shared-buildplane
spec:
  planeID: "shared-builder"
  clusterAgent:
    clientCA:
      secretRef:
        name: buildplane-agent-ca
        namespace: openchoreo-system
        key: ca.crt

ClusterBuildPlane with Secret Store

This example demonstrates using External Secrets Operator for managing secrets.

apiVersion: openchoreo.dev/v1alpha1
kind: ClusterBuildPlane
metadata:
  name: secure-buildplane
spec:
  planeID: "secure-builder"
  clusterAgent:
    clientCA:
      secretRef:
        name: agent-ca-cert
        namespace: openchoreo-system
        key: ca.crt
  secretStoreRef:
    name: vault-backend

ClusterBuildPlane with Observability

This example shows a ClusterBuildPlane linked to a ClusterObservabilityPlane for monitoring build jobs.

apiVersion: openchoreo.dev/v1alpha1
kind: ClusterBuildPlane
metadata:
  name: monitored-buildplane
spec:
  planeID: "prod-ci"
  clusterAgent:
    clientCA:
      secretRef:
        name: buildplane-agent-ca
        namespace: openchoreo-system
        key: ca.crt
  secretStoreRef:
    name: default
  observabilityPlaneRef:
    kind: ClusterObservabilityPlane
    name: production-observability

Annotations

ClusterBuildPlanes support the following annotations:

Annotation	Description
openchoreo.dev/display-name	Human-readable name for UI display
openchoreo.dev/description	Detailed description of the ClusterBuildPlane

Related Resources

• BuildPlane - Namespace-scoped variant of ClusterBuildPlane
• DataPlane - Runtime infrastructure for deployed applications
• ClusterDataPlane - Cluster-scoped data plane configuration
• ClusterObservabilityPlane - Cluster-scoped observability plane
• Component - Application components that trigger builds
• WorkflowRun - Build job executions on BuildPlanes