Component

A Component represents a deployable unit of an application in OpenChoreo. It serves as the core abstraction that references a platform-defined ComponentType (in {workloadType}/{componentTypeName} format) and optionally includes build configuration when using OpenChoreo's CI system to build from source. Components are the primary building blocks used to define applications within a Project.

API Version

openchoreo.dev/v1alpha1

Resource Definition

Metadata

Components are namespace-scoped resources that must be created within an Organization's namespace and belong to a Project through the owner field.

apiVersion: openchoreo.dev/v1alpha1
kind: Component
metadata:
  name: <component-name>
  namespace: <org-namespace>  # Organization namespace

Spec Fields

Field	Type	Required	Default	Description
owner	ComponentOwner	Yes	-	Ownership information linking the component to a project
componentType	string	Yes	-	componentType in the format {workloadType}/{componentTypeName} (e.g., deployment/web-app). See ComponentType.
build	BuildSpecInComponent	No	-	Optional build configuration when using OpenChoreo CI to build from source (omit for pre-built images)

ComponentOwner

Field	Type	Required	Default	Description
projectName	string	Yes	-	Name of the project that owns this component (min: 1)

ComponentType Reference

The componentType string points to a platform-defined ComponentType using the format {workloadType}/{componentTypeName}. Examples: deployment/service, cronjob/scheduled-task, deployment/web-application. See ComponentType for details.

BuildSpecInComponent

Field	Type	Required	Default	Description
repository	BuildRepository	Yes	-	Source repository configuration where the component code resides
templateRef	TemplateRef	Yes	-	Build template reference (ClusterWorkflowTemplate in the build plane)

BuildRepository

Field	Type	Required	Default	Description
url	string	Yes	-	Repository URL (e.g., https://github.com/org/repo)
revision	BuildRevision	Yes	-	Default revision configuration for builds
appPath	string	Yes	-	Path to the application within the repository (relative to root, e.g., ".")

BuildRevision

Field	Type	Required	Default	Description
branch	string	Yes	-	Default branch to build from when no specific commit provided

TemplateRef

Field	Type	Required	Default	Description
engine	string	No	-	Build engine to use
name	string	Yes	-	Name of the build template
parameters	[Parameter]	No	[]	Template parameters

Parameter

Field	Type	Required	Default	Description
name	string	Yes	-	Parameter name
value	string	Yes	-	Parameter value

Status Fields

Field	Type	Default	Description
observedGeneration	integer	0	The generation observed by the controller
conditions	[]Condition	[]	Standard Kubernetes conditions tracking component state

Condition Types

Common condition types for Component resources:

• Ready - Indicates if the component is ready
• Reconciled - Indicates if the controller has successfully reconciled the component

Examples

Service Component with Docker Build

apiVersion: openchoreo.dev/v1alpha1
kind: Component
metadata:
  name: customer-service
  namespace: default
spec:
  owner:
    projectName: my-project
  componentType: deployment/service
  build:
    repository:
      url: https://github.com/myorg/customer-service
      revision:
        branch: main
      appPath: .
    templateRef:
      name: docker
      parameters:
        - name: docker-context
          value: .
        - name: dockerfile-path
          value: ./Dockerfile

WebApplication Component with Buildpacks

apiVersion: openchoreo.dev/v1alpha1
kind: Component
metadata:
  name: frontend-app
  namespace: default
spec:
  owner:
    projectName: my-project
  componentType: deployment/web-app
  build:
    repository:
      url: https://github.com/myorg/frontend
      revision:
        branch: develop
      appPath: ./webapp
    templateRef:
      name: google-cloud-buildpacks

Annotations

Components support the following annotations:

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

Related Resources

• Project - Contains components
• Build - Build jobs triggered by components
• Workload - Workload definitions associated with components
• Service - Service-type component resources
• WebApplication - WebApplication-type component resources
• ScheduledTask - ScheduledTask-type component resources