Camel K API

camel.apache.org/v1

Package v1 contains API Schema definitions for the camel v1 API group

Resource Types

Build

Build is the Schema for the builds API

Field Description

apiVersion
string

camel.apache.org/v1

kind
string

Build

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
BuildSpec

status
BuildStatus

CamelCatalog

CamelCatalog is the Schema for the camelcatalogs API

Field Description

apiVersion
string

camel.apache.org/v1

kind
string

CamelCatalog

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

status
CamelCatalogStatus

spec
CamelCatalogSpec

Integration

Integration is the Schema for the integrations API

Field Description

apiVersion
string

camel.apache.org/v1

kind
string

Integration

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IntegrationSpec

status
IntegrationStatus

IntegrationKit

IntegrationKit is the Schema for the integrationkits API

Field Description

apiVersion
string

camel.apache.org/v1

kind
string

IntegrationKit

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IntegrationKitSpec

status
IntegrationKitStatus

IntegrationPlatform

IntegrationPlatform is the Schema for the integrationplatforms API

Field Description

apiVersion
string

camel.apache.org/v1

kind
string

IntegrationPlatform

metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IntegrationPlatformSpec

status
IntegrationPlatformStatus

Internal Types

Artifact

Appears on:

Artifact — 

Field Description

id
string

location
string

target
string

checksum
string

BaseTask

Appears on:

BaseTask — 

Field Description

name
string

BuildCondition

Appears on:

BuildCondition describes the state of a resource at a certain point.

Field Description

type
BuildConditionType

Type of integration condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

reason
string

The reason for the condition’s last transition.

message
string

A human-readable message indicating details about the transition.

BuildConditionType(string alias)

Appears on:

BuildConditionType — 

BuildPhase(string alias)

Appears on:

BuildPhase — 

BuildSpec

Appears on:

BuildSpec defines the Build to be executed

Field Description

tasks
[]Task

The sequence of Build tasks to be performed as part of the Build execution.

strategy
BuildStrategy

The strategy that should be used to perform the Build.

timeout
Kubernetes meta/v1.Duration

Timeout defines the Build maximum execution duration. The Build deadline is set to the Build start time plus the Timeout duration. If the Build deadline is exceeded, the Build context is canceled, and its phase set to BuildPhaseFailed.

BuildStatus

Appears on:

BuildStatus defines the observed state of Build

Field Description

phase
BuildPhase

image
string

digest
string

baseImage
string

artifacts
[]Artifact

error
string

failure
Failure

startedAt
Kubernetes meta/v1.Time

conditions
[]BuildCondition

duration
string

Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845

BuildStrategy(string alias)

Appears on:

BuildStrategy specifies how the Build should be executed

BuildahTask

Appears on:

BuildahTask — 

Field Description

BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

verbose
bool

BuilderTask

Appears on:

BuilderTask — 

Field Description

BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

baseImage
string

runtime
RuntimeSpec

sources
[]SourceSpec

resources
[]ResourceSpec

dependencies
[]string

steps
[]string

maven
MavenBuildSpec

buildDir
string

CamelArtifact

Appears on:

CamelArtifact — 

Field Description

CamelArtifactDependency
CamelArtifactDependency

(Members of CamelArtifactDependency are embedded into this type.)

schemes
[]CamelScheme

languages
[]string

dataformats
[]string

dependencies
[]CamelArtifactDependency

javaTypes
[]string

CamelArtifactDependency

Appears on:

CamelArtifactDependency represent a maven’s dependency

Field Description

MavenArtifact
MavenArtifact

(Members of MavenArtifact are embedded into this type.)

exclusions
[]CamelArtifactExclusion

CamelArtifactExclusion

Appears on:

CamelArtifactExclusion — 

Field Description

groupId
string

artifactId
string

CamelCatalogSpec

Appears on:

CamelCatalogSpec defines the desired state of CamelCatalog

CamelCatalogStatus

Appears on:

CamelCatalogStatus defines the observed state of CamelCatalog

CamelLoader

Appears on:

CamelLoader — 

Field Description

MavenArtifact
MavenArtifact

(Members of MavenArtifact are embedded into this type.)

languages
[]string

dependencies
[]MavenArtifact

CamelScheme

Appears on:

CamelScheme — 

Field Description

id
string

passive
bool

http
bool

consumer
CamelSchemeScope

producer
CamelSchemeScope

CamelSchemeScope

Appears on:

CamelSchemeScope contains scoped information about a scheme

Field Description

dependencies
[]CamelArtifactDependency

Capability

Appears on:

Capability — 

Field Description

dependencies
[]MavenArtifact

metadata
map[string]string

Configurable

Configurable — 

ConfigurationSpec

Appears on:

ConfigurationSpec — 

Field Description

type
string

value
string

resourceType
string

resourceMountPoint
string

resourceKey
string

DataSpec

Appears on:

DataSpec — 

Field Description

name
string

path
string

content
string

rawContent
[]byte

contentRef
string

contentKey
string

contentType
string

compression
bool

Failure

Appears on:

Failure — 

Field Description

reason
string

time
Kubernetes meta/v1.Time

recovery
FailureRecovery

FailureRecovery

Appears on:

FailureRecovery — 

Field Description

attempt
int

attemptMax
int

attemptTime
Kubernetes meta/v1.Time

(Optional)

Flow

Appears on:

Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

IntegrationCondition

Appears on:

IntegrationCondition describes the state of a resource at a certain point.

Field Description

type
IntegrationConditionType

Type of integration condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

firstTruthyTime
Kubernetes meta/v1.Time

First time the condition status transitioned to True.

reason
string

The reason for the condition’s last transition.

message
string

A human-readable message indicating details about the transition.

IntegrationConditionType(string alias)

Appears on:

IntegrationConditionType — 

IntegrationKitCondition

Appears on:

IntegrationKitCondition describes the state of a resource at a certain point.

Field Description

type
IntegrationKitConditionType

Type of integration condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

reason
string

The reason for the condition’s last transition.

message
string

A human-readable message indicating details about the transition.

IntegrationKitConditionType(string alias)

Appears on:

IntegrationKitConditionType — 

IntegrationKitPhase(string alias)

Appears on:

IntegrationKitPhase — 

IntegrationKitSpec

Appears on:

IntegrationKitSpec defines the desired state of IntegrationKit

Field Description

image
string

dependencies
[]string

profile
TraitProfile

traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec

configuration
[]ConfigurationSpec

repositories
[]string

IntegrationKitStatus

Appears on:

IntegrationKitStatus defines the observed state of IntegrationKit

Field Description

phase
IntegrationKitPhase

baseImage
string

image
string

digest
string

artifacts
[]Artifact

failure
Failure

runtimeVersion
string

runtimeProvider
RuntimeProvider

platform
string

conditions
[]IntegrationKitCondition

version
string

IntegrationPhase(string alias)

Appears on:

IntegrationPhase — 

IntegrationPlatformBuildPublishStrategy(string alias)

Appears on:

IntegrationPlatformBuildPublishStrategy enumerates all implemented publish strategies

IntegrationPlatformBuildSpec

Appears on:

IntegrationPlatformBuildSpec contains platform related build information

Field Description

buildStrategy
BuildStrategy

publishStrategy
IntegrationPlatformBuildPublishStrategy

runtimeVersion
string

runtimeProvider
RuntimeProvider

baseImage
string

registry
RegistrySpec

timeout
Kubernetes meta/v1.Duration

persistentVolumeClaim
string

maven
MavenSpec

kanikoBuildCache
bool

IntegrationPlatformCluster(string alias)

Appears on:

IntegrationPlatformCluster is the kind of orchestration cluster the platform is installed into

IntegrationPlatformCondition

Appears on:

IntegrationPlatformCondition describes the state of a resource at a certain point.

Field Description

type
IntegrationPlatformConditionType

Type of integration condition.

status
Kubernetes core/v1.ConditionStatus

Status of the condition, one of True, False, Unknown.

lastUpdateTime
Kubernetes meta/v1.Time

The last time this condition was updated.

lastTransitionTime
Kubernetes meta/v1.Time

Last time the condition transitioned from one status to another.

reason
string

The reason for the condition’s last transition.

message
string

A human-readable message indicating details about the transition.

IntegrationPlatformConditionType(string alias)

Appears on:

IntegrationPlatformConditionType — 

IntegrationPlatformKameletRepositorySpec

Appears on:

IntegrationPlatformKameletRepositorySpec — 

Field Description

uri
string

IntegrationPlatformKameletSpec

Appears on:

IntegrationPlatformKameletSpec — 

Field Description

repositories
[]IntegrationPlatformKameletRepositorySpec

IntegrationPlatformPhase(string alias)

Appears on:

IntegrationPlatformPhase — 

IntegrationPlatformResourcesSpec

Appears on:

IntegrationPlatformResourcesSpec contains platform related resources

IntegrationPlatformSpec

Appears on:

IntegrationPlatformSpec defines the desired state of IntegrationPlatform

IntegrationPlatformStatus

Appears on:

IntegrationPlatformStatus defines the observed state of IntegrationPlatform

Field Description

IntegrationPlatformSpec
IntegrationPlatformSpec

(Members of IntegrationPlatformSpec are embedded into this type.)

phase
IntegrationPlatformPhase

conditions
[]IntegrationPlatformCondition

version
string

info
map[string]string

IntegrationSpec

Appears on:

IntegrationSpec defines the desired state of Integration

Field Description

replicas
int32

sources
[]SourceSpec

flows
[]Flow

resources
[]ResourceSpec

Deprecated: Use container trait (container.resources) to manage resources Use openapi trait (openapi.configmaps) to manage OpenAPIs specifications

kit
string

Deprecated: use the IntegrationKit field

integrationKit
Kubernetes core/v1.ObjectReference

dependencies
[]string

profile
TraitProfile

traits
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec

template
PodSpecTemplate

configuration
[]ConfigurationSpec

Deprecated: Use camel trait (camel.properties) to manage properties Use container trait (container.configs) to manage configs Use container trait (container.resources) to manage resources Use container trait (container.volumes) to manage volumes

repositories
[]string

serviceAccountName
string

IntegrationStatus

Appears on:

IntegrationStatus defines the observed state of Integration

Field Description

phase
IntegrationPhase

digest
string

image
string

dependencies
[]string

profile
TraitProfile

kit
string

Deprecated: use the IntegrationKit field

integrationKit
Kubernetes core/v1.ObjectReference

platform
string

generatedSources
[]SourceSpec

generatedResources
[]ResourceSpec

runtimeVersion
string

runtimeProvider
RuntimeProvider

configuration
[]ConfigurationSpec

conditions
[]IntegrationCondition

version
string

replicas
int32

selector
string

capabilities
[]string

lastInitTimestamp
Kubernetes meta/v1.Time

The timestamp representing the last time when this integration was initialized.

KanikoTask

Appears on:

KanikoTask — 

Field Description

BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

verbose
bool

cache
KanikoTaskCache

KanikoTaskCache

Appears on:

KanikoTaskCache — 

Field Description

enabled
bool

persistentVolumeClaim
string

Language(string alias)

Appears on:

Language — 

MavenArtifact

Appears on:

MavenArtifact defines a Maven artifact

Field Description

groupId
string

artifactId
string

version
string

MavenBuildSpec

Appears on:

MavenBuildSpec — 

Field Description

MavenSpec
MavenSpec

(Members of MavenSpec are embedded into this type.)

repositories
[]Repository

The Maven repositories.

MavenSpec

Appears on:

MavenSpec — 

Field Description

localRepository
string

The path of the local Maven repository.

properties
map[string]string

The Maven properties.

settings
ValueSource

A reference to the ConfigMap or Secret key that contains the Maven settings.

caSecret
Kubernetes core/v1.SecretKeySelector

The Secret name and key, containing the CA certificate(s) used to connect to remote Maven repositories. It can contain X.509 certificates, and PKCS#7 formatted certificate chains. A JKS formatted keystore is automatically created to store the CA certificate(s), and configured to be used as a trusted certificate(s) by the Maven commands. Note that the root CA certificates are also imported into the created keystore.

timeout
Kubernetes meta/v1.Duration

Deprecated: use IntegrationPlatform.Spec.Build.Timeout instead

extension
[]MavenArtifact

cliOptions
[]string

The CLI options that are appended to the list of arguments for Maven commands, e.g., -V,--no-transfer-progress,-Dstyle.color=never. See https://maven.apache.org/ref/3.8.4/maven-embedder/cli.html.

PodSpec

Appears on:

Field Description

volumes
[]Kubernetes core/v1.Volume

initContainers
[]Kubernetes core/v1.Container

containers
[]Kubernetes core/v1.Container

ephemeralContainers
[]Kubernetes core/v1.EphemeralContainer

restartPolicy
Kubernetes core/v1.RestartPolicy

terminationGracePeriodSeconds
int64

activeDeadlineSeconds
int64

dnsPolicy
Kubernetes core/v1.DNSPolicy

nodeSelector
map[string]string

topologySpreadConstraints
[]Kubernetes core/v1.TopologySpreadConstraint

PodSpecTemplate

Appears on:

Field Description

spec
PodSpec

PublishTask

Appears on:

PublishTask — 

Field Description

contextDir
string

baseImage
string

image
string

registry
RegistrySpec

RawMessage([]byte alias)

Appears on:

RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.

RegistrySpec

Appears on:

RegistrySpec provides the configuration for the container registry

Field Description

insecure
bool

address
string

secret
string

ca
string

organization
string

Repository

Appears on:

Repository defines a Maven repository

Field Description

id
string

name
string

url
string

snapshots
RepositoryPolicy

releases
RepositoryPolicy

RepositoryPolicy

Appears on:

RepositoryPolicy defines the policy associated to a Maven repository

Field Description

enabled
bool

updatePolicy
string

checksumPolicy
string

ResourceCondition

ResourceCondition is a common type for all conditions

ResourceSpec

Appears on:

ResourceSpec — 

Field Description

DataSpec
DataSpec

(Members of DataSpec are embedded into this type.)

type
ResourceType

mountPath
string

ResourceType(string alias)

Appears on:

ResourceType — 

RuntimeProvider(string alias)

Appears on:

RuntimeProvider — 

RuntimeSpec

Appears on:

RuntimeSpec — 

Field Description

version
string

provider
RuntimeProvider

applicationClass
string

dependencies
[]MavenArtifact

metadata
map[string]string

capabilities
map[string]github.com/apache/camel-k/pkg/apis/camel/v1.Capability

S2iTask

Appears on:

S2iTask — 

Field Description

BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

contextDir
string

tag
string

SourceSpec

Appears on:

SourceSpec — 

Field Description

DataSpec
DataSpec

(Members of DataSpec are embedded into this type.)

language
Language

loader
string

Loader is an optional id of the org.apache.camel.k.RoutesLoader that will interpret this source at runtime

interceptors
[]string

Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader uses to pre/post process sources

type
SourceType

Type defines the kind of source described by this object

property-names
[]string

List of property names defined in the source (e.g. if type is "template")

SourceType(string alias)

Appears on:

SpectrumTask

Appears on:

SpectrumTask — 

Field Description

BaseTask
BaseTask

(Members of BaseTask are embedded into this type.)

PublishTask
PublishTask

(Members of PublishTask are embedded into this type.)

Task

Appears on:

Task — 

Field Description

builder
BuilderTask

buildah
BuildahTask

kaniko
KanikoTask

spectrum
SpectrumTask

s2i
S2iTask

Template

Template is an unstructured object representing a Kamelet template in YAML/JSON DSL

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

TraitConfiguration

Appears on:

Field Description

RawMessage
RawMessage

(Members of RawMessage are embedded into this type.)

TraitProfile(string alias)

Appears on:

TraitProfile represents lists of traits that are enabled for the specific installation/integration

TraitSpec

Appears on:

A TraitSpec contains the configuration of a trait

Field Description

configuration
TraitConfiguration

TraitConfiguration — 

ValueSource

Appears on:

ValueSource — 

Field Description

configMapKeyRef
Kubernetes core/v1.ConfigMapKeySelector

Selects a key of a ConfigMap.

secretKeyRef
Kubernetes core/v1.SecretKeySelector

Selects a key of a secret.