API Reference¶
Auto-generated
This page is generated from Go source at api/v1alpha1/. Do not edit manually — run make docs-generate to refresh.
API Groups¶
concourse-ci.org/v1alpha1¶
Package v1alpha1 contains API Schema definitions for the concourse v1alpha1 API group.
Resource Types¶
BasicAuth¶
BasicAuth holds credentials for HTTP basic authentication.
Appears in: - InstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
username string | Username for basic authentication. | ||
passwordRef SecretKeySelector | PasswordRef references the Secret key containing the password. |
Build¶
Build tracks and optionally triggers a build in Concourse.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Build | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec BuildSpec | Required: {} | ||
status BuildStatus | Optional: {} |
BuildPhase¶
Underlying type: string
BuildPhase mirrors Concourse build status values.
Validation: - Enum: [pending started succeeded failed errored aborted]
Appears in: - BuildStatus - JobStatus
| Value | Description |
|---|---|
pending | |
started | |
succeeded | |
failed | |
errored | |
aborted |
BuildSpec¶
BuildSpec defines the desired state of Build.
Appears in: - Build
| Field | Description | Default | Validation |
|---|---|---|---|
jobRef LocalObjectReference | JobRef references the Job that triggered this build. Required unless OneOff is true. | Optional: {} | |
oneOff boolean | OneOff indicates this is a one-off build not tied to a pipeline job. When true, JobRef must be unset. | Optional: {} | |
abort boolean | Abort signals the controller to abort this build if it is running. | Optional: {} |
BuildStatus¶
BuildStatus defines the observed state of Build.
Appears in: - Build
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
buildID integer | BuildID is the numeric Concourse build ID. | Optional: {} | |
buildName string | BuildName is the display name of the build (e.g. "42"). | Optional: {} | |
concourseStatus BuildPhase | ConcourseStatus reflects the current Concourse build status. | Enum: [pending started succeeded failed errored aborted] Optional: {} | |
startTime Time | StartTime is when the build started. | Optional: {} | |
endTime Time | EndTime is when the build completed. | Optional: {} | |
duration Duration | Duration is the elapsed time between StartTime and EndTime. | Optional: {} | |
apiURL string | APIURL is the URL to the build on the Concourse web UI. | Optional: {} | |
createdBy string | CreatedBy is the user or system that triggered the build. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
ConfigMapKeyRef¶
ConfigMapKeyRef references a key within a ConfigMap.
Appears in: - PipelineConfig
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the ConfigMap. | ||
key string | Key within the ConfigMap. |
Instance¶
Instance represents a connection to a Concourse CI server.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Instance | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec InstanceSpec | Required: {} | ||
status InstanceStatus | Optional: {} |
InstanceSpec¶
InstanceSpec defines the desired state of Instance.
Appears in: - Instance
| Field | Description | Default | Validation |
|---|---|---|---|
url string | URL is the base URL of the Concourse ATC, e.g. https://ci.example.com. | Pattern: ^https?:// Required: {} | |
basicAuth BasicAuth | BasicAuth configures username/password authentication. Mutually exclusive with TokenAuth. | Optional: {} | |
tokenAuth TokenAuth | TokenAuth configures bearer token authentication. Mutually exclusive with BasicAuth. | Optional: {} | |
tls TLSConfig | TLS configures TLS settings for the connection. | Optional: {} | |
interval Duration | Interval is how often the controller reconciles this instance. | 5m | Optional: {} |
InstanceStatus¶
InstanceStatus defines the observed state of Instance.
Appears in: - Instance
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
version string | Version is the Concourse server version string. | Optional: {} | |
workerVersion string | WorkerVersion is the minimum worker binary version required by this instance. | Optional: {} | |
clusterName string | ClusterName is the human-readable cluster name reported by Concourse. | Optional: {} | |
externalURL string | ExternalURL is the externally-visible URL reported by the Concourse server. | Optional: {} | |
workerCount integer | WorkerCount is the number of running workers in this instance. | Optional: {} | |
stalledWorkers integer | StalledWorkers is the number of workers in the "stalled" state. | Optional: {} | |
runningWorkers integer | RunningWorkers is the number of workers in the "running" state. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
Job¶
Job manages a job within a Concourse pipeline (pause/unpause, trigger builds).
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Job | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec JobSpec | Required: {} | ||
status JobStatus | Optional: {} |
JobSpec¶
JobSpec defines the desired state of Job.
Appears in: - Job
| Field | Description | Default | Validation |
|---|---|---|---|
pipelineRef LocalObjectReference | PipelineRef references the Pipeline that owns this job. | Required: {} | |
jobName string | JobName is the job name within the pipeline. Defaults to metadata.name. | Optional: {} | |
paused boolean | Paused sets whether the job should be paused in Concourse. | Optional: {} | |
triggerBuild boolean | TriggerBuild causes the controller to create a Build CR on each spec change, triggering a new build. | Optional: {} |
JobStatus¶
JobStatus defines the observed state of Job.
Appears in: - Job
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
paused boolean | Paused reflects the actual pause state in Concourse. | Optional: {} | |
nextBuildName string | NextBuildName is the name of the next Build CR if one was created. | Optional: {} | |
lastBuildID integer | LastBuildID is the Concourse ID of the last finished build. | Optional: {} | |
lastBuildStatus BuildPhase | LastBuildStatus is the status of the last finished build. | Enum: [pending started succeeded failed errored aborted] Optional: {} | |
lastBuildTime Time | LastBuildTime is when the last finished build ended. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
LocalObjectReference¶
LocalObjectReference names a resource in the same namespace.
Appears in: - BuildSpec - JobSpec - PipelineSpec - ResourceSpec - TeamSpec - WorkerSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Pipeline¶
Pipeline manages a Concourse pipeline configuration.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Pipeline | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec PipelineSpec | Required: {} | ||
status PipelineStatus | Optional: {} |
PipelineConfig¶
PipelineConfig sources the pipeline YAML configuration. Exactly one of Inline or ConfigMapRef must be set.
Appears in: - PipelineSpec
| Field | Description | Default | Validation |
|---|---|---|---|
inline string | Inline is the pipeline YAML embedded directly in the spec. | Optional: {} | |
configMapRef ConfigMapKeyRef | ConfigMapRef references a ConfigMap key containing the pipeline YAML. | Optional: {} |
PipelineSpec¶
PipelineSpec defines the desired state of Pipeline.
Appears in: - Pipeline
| Field | Description | Default | Validation |
|---|---|---|---|
teamRef LocalObjectReference | TeamRef references the Team this pipeline belongs to. | Required: {} | |
pipelineName string | PipelineName is the name in Concourse. Defaults to metadata.name. | Optional: {} | |
config PipelineConfig | Config defines the pipeline configuration source. | Required: {} | |
vars PipelineVar array | Vars are pipeline variables passed at set-pipeline time. | Optional: {} | |
paused boolean | Paused sets the pipeline pause state in Concourse. | Optional: {} | |
exposed boolean | Exposed makes the pipeline publicly visible without authentication. | Optional: {} |
PipelineStatus¶
PipelineStatus defines the observed state of Pipeline.
Appears in: - Pipeline
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
pipelineID integer | PipelineID is the Concourse-assigned pipeline ID. | Optional: {} | |
configHash string | ConfigHash is the SHA-256 hash of the last successfully applied pipeline YAML. | Optional: {} | |
paused boolean | Paused reflects the actual pause state in Concourse. | Optional: {} | |
exposed boolean | Exposed reflects the actual exposed state in Concourse. | Optional: {} | |
lastUpdated Time | LastUpdated is the timestamp when Concourse last recorded a change to this pipeline. | Optional: {} | |
groupCount integer | GroupCount is the number of job groups defined in the pipeline. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
PipelineVar¶
PipelineVar defines a variable passed to fly set-pipeline -v/-l.
Appears in: - PipelineSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the variable. | ||
value string | Value is the plain-text value. Mutually exclusive with ValueFrom. | Optional: {} | |
valueFrom SecretKeySelector | ValueFrom sources the value from a Secret. Mutually exclusive with Value. | Optional: {} |
Resource¶
Resource manages a resource within a Concourse pipeline (pin, check).
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Resource | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec ResourceSpec | Required: {} | ||
status ResourceStatus | Optional: {} |
ResourceSpec¶
ResourceSpec defines the desired state of Resource.
Appears in: - Resource
| Field | Description | Default | Validation |
|---|---|---|---|
pipelineRef LocalObjectReference | PipelineRef references the Pipeline that owns this resource. | Required: {} | |
resourceName string | ResourceName is the resource name within the pipeline. Defaults to metadata.name. | Optional: {} | |
pinnedVersion object (keys:string, values:string) | PinnedVersion pins the resource to a specific version. When set, the controller calls PinResourceVersion in Concourse. When cleared, the controller calls UnpinResource. | Optional: {} | |
checkInterval Duration | CheckInterval triggers a Concourse resource check at this interval. When unset, no automatic checks are triggered by the operator. | Optional: {} |
ResourceStatus¶
ResourceStatus defines the observed state of Resource.
Appears in: - Resource
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
lastChecked Time | LastChecked is the timestamp of the last resource check. | Optional: {} | |
latestVersion object (keys:string, values:string) | LatestVersion is the most recent version of the resource. | Optional: {} | |
pinnedVersionID integer | PinnedVersionID is the Concourse resource version ID that is pinned. | Optional: {} | |
pinned boolean | Pinned indicates whether the resource is currently pinned. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
SecretKeySelector¶
SecretKeySelector references a key in a Kubernetes Secret.
Appears in: - BasicAuth - PipelineVar - TLSConfig - TokenAuth
| Field | Description | Default | Validation |
|---|---|---|---|
name string | Name of the Secret. | ||
key string | Key within the Secret. |
TLSConfig¶
TLSConfig configures TLS for the Concourse connection.
Appears in: - InstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
caRef SecretKeySelector | CARef references a Secret key containing a PEM-encoded CA certificate. | Optional: {} | |
insecureSkipVerify boolean | InsecureSkipVerify disables TLS certificate verification. | Optional: {} |
Team¶
Team manages a Concourse team and its auth configuration.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Team | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec TeamSpec | Required: {} | ||
status TeamStatus | Optional: {} |
TeamRole¶
TeamRole defines a role binding within a Concourse team.
Appears in: - TeamSpec
| Field | Description | Default | Validation |
|---|---|---|---|
role string | Role is the Concourse role name (owner, member, pipeline-operator, viewer). | Enum: [owner member pipeline-operator viewer] | |
users string array | Users is a list of user identifiers (provider:username). | Optional: {} | |
groups string array | Groups is a list of group identifiers (provider:group). | Optional: {} |
TeamSpec¶
TeamSpec defines the desired state of Team.
Appears in: - Team
| Field | Description | Default | Validation |
|---|---|---|---|
instanceRef LocalObjectReference | InstanceRef references the Instance this team belongs to. | Required: {} | |
teamName string | TeamName is the team name in Concourse. Defaults to metadata.name. | Optional: {} | |
roles TeamRole array | Roles defines auth role bindings for the team. | Optional: {} |
TeamStatus¶
TeamStatus defines the observed state of Team.
Appears in: - Team
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
teamID integer | TeamID is the Concourse-assigned numeric team ID. | Optional: {} | |
lastApplied Time | LastApplied is the timestamp of the last successful CreateOrUpdate. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |
TokenAuth¶
TokenAuth holds a bearer token reference.
Appears in: - InstanceSpec
| Field | Description | Default | Validation |
|---|---|---|---|
tokenRef SecretKeySelector | TokenRef references the Secret key containing the bearer token. |
Worker¶
Worker manages a worker in a Concourse instance (land, retire, prune).
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | concourse-ci.org/v1alpha1 | ||
kind string | Worker | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | Optional: {} | |
spec WorkerSpec | Required: {} | ||
status WorkerStatus | Optional: {} |
WorkerDesiredState¶
Underlying type: string
WorkerDesiredState is the desired lifecycle state for a worker.
Validation: - Enum: [active land retire prune]
Appears in: - WorkerSpec
| Value | Description |
|---|---|
active | |
land | |
retire | |
prune |
WorkerSpec¶
WorkerSpec defines the desired state of Worker.
Appears in: - Worker
| Field | Description | Default | Validation |
|---|---|---|---|
instanceRef LocalObjectReference | InstanceRef references the Instance this worker belongs to. | Required: {} | |
workerName string | WorkerName is the unique name of the worker in Concourse. | Required: {} | |
desiredState WorkerDesiredState | DesiredState sets the lifecycle action to perform on the worker. - active: no-op (workers self-register) - land: gracefully drain and land the worker - retire: retire the worker from the pool - prune: forcibly remove the worker | active | Enum: [active land retire prune] Optional: {} |
WorkerStatus¶
WorkerStatus defines the observed state of Worker.
Appears in: - Worker
| Field | Description | Default | Validation |
|---|---|---|---|
conditions Condition array | Optional: {} | ||
actualState string | ActualState is the current state of the worker as reported by Concourse. | Optional: {} | |
platform string | Platform is the worker platform (e.g. linux, darwin). | Optional: {} | |
tags string array | Tags are the worker tags. | Optional: {} | |
activeContainers integer | ActiveContainers is the number of containers running on the worker. | Optional: {} | |
activeVolumes integer | ActiveVolumes is the number of volumes on the worker. | Optional: {} | |
version string | Version is the worker binary version. | Optional: {} | |
startTime Time | StartTime is when the worker registered with Concourse. | Optional: {} | |
ephemeral boolean | Ephemeral indicates whether the worker is ephemeral (auto-removed on disconnect). | Optional: {} | |
team string | Team is the team this worker is scoped to; empty means global worker. | Optional: {} | |
observedGeneration integer | ObservedGeneration is the last generation that was reconciled. | Optional: {} |