Camel K API

camel.apache.org/v1

Build

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

camel.apache.org/v1

CamelCatalog

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

the actual state of the catalog

the desired state of the catalog

camel.apache.org/v1

Integration

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

the desired Integration specification

the status of the Integration

camel.apache.org/v1

IntegrationKit

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

the desired configuration

the actual status

camel.apache.org/v1

IntegrationPlatform

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

the identification (GAV for maven dependencies or file name for other file types)

where it is located in the builder Pod

the expected location in the runtime

a checksum (SHA1) of the content

name of the task

Type of integration condition.

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

The last time this condition was updated.

Last time the condition transitioned from one status to another.

The reason for the condition’s last transition.

A human-readable message indicating details about the transition.

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

The strategy that should be used to perform the Build.

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.

describes the phase

the image name built

the digest from image

the base image used for this build

a list of artifacts contained in the build

the error description (if any)

the reason of the failure (if any)

the time when it started

a list of conditions occurred during the build

how long it took for the build Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845

(Members of BaseTask are embedded into this type.)

(Members of PublishTask are embedded into this type.)

log more information

(Members of BaseTask are embedded into this type.)

the base image layer

the configuration required for the runtime application

Deprecated: no longer in use the source code for the Route(s)

Deprecated: no longer in use

the list of dependencies to use for this build

the list of steps to execute (see pkg/builder/)

the configuration required by Maven for the application build phase

workspace directory to use

(Members of CamelArtifactDependency are embedded into this type.)

Base Camel Artifact dependency

accepted URI schemes

accepted languages

accepted data formats

required dependencies

the Java types used by the artifact feature (ie, component, data format, …​)

(Members of MavenArtifact are embedded into this type.)

the maven dependency

provide a list of artifacts to exclude for this dependency

Maven Group

Maven Artifact

the runtime targeted for the catalog

artifacts required by this catalog

loaders required by this catalog

(Members of MavenArtifact are embedded into this type.)

the base Maven artifact required

a list of DSLs supported

a list of additional dependencies required beside the base one

Deprecated: never used a set of general metadata for various purposes

the ID (ie, timer in a timer:xyz URI)

is a passive scheme

is a HTTP based scheme

required scope for consumer

required scope for producers

list of dependencies needed for this scope

Deprecated: not in use

represents the type of configuration, ie: property, configmap, secret, …​

the value to assign to the configuration (syntax may vary depending on the Type)

Deprecated: no longer used

Deprecated: no longer used

Deprecated: no longer used

the name of the specification

the path where the file is stored

the source code (plain text)

the source code (binary)

the confimap reference holding the source content

the confimap key holding the source content

the content type (tipically text or binary)

if the content is compressed (base64 encrypted)

a short text specifying the reason

the time when the failure has happened

the recovery attempted for this failure

attempt number

maximum number of attempts

(Optional)

time of the attempt execution

(Members of RawMessage are embedded into this type.)

Type of integration condition.

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

The last time this condition was updated.

Last time the condition transitioned from one status to another.

First time the condition status transitioned to True.

The reason for the condition’s last transition.

A human-readable message indicating details about the transition.

Type of integration condition.

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

The last time this condition was updated.

Last time the condition transitioned from one status to another.

The reason for the condition’s last transition.

A human-readable message indicating details about the transition.

the container image as identify in the container registry

a list of Camel dependecies used by this kit

the profile which is expected by this kit

traits that the kit will execute

configuration used by the kit TODO: we should deprecate in future releases in favour of mount, openapi or camel traits

Maven repositories that can be used by the kit

phase of the kit

base image used by the kit

actual image name of the kit

actual image digest of the kit

list of artifacts used by the kit

failure reason (if any)

the runtime version for which this kit was configured

the runtime provider for which this kit was configured

the platform for which this kit was configured

the Camel K operator version for which this kit was configured

a list of conditions which happened for the events related the kit

the strategy to adopt for building an Integration base image

the strategy to adopt for publishing an Integration base image

the Camel K Runtime dependency version

the runtime used. Likely Camel Quarkus (we used to have main runtime which has been discontinued since version 1.5)

a base image that can be used as base layer for all images. It can be useful if you want to provide some custom base image with further utility softwares

the image registry used to push/pull Integration images

how much time to wait before time out the build process

Maven configuration used to build the Camel/Camel-Quarkus applications

Deprecated: Use PublishStrategyOptions instead enables Kaniko publish strategy cache

Deprecated: Use PublishStrategyOptions instead the Persistent Volume Claim used by Kaniko publish strategy, if cache is enabled

Type of integration condition.

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

The last time this condition was updated.

Last time the condition transitioned from one status to another.

The reason for the condition’s last transition.

A human-readable message indicating details about the transition.

the remote repository in the format github:ORG/REPO/PATH_TO_KAMELETS_FOLDER

remote repository used to retrieve Kamelet catalog

what kind of cluster you’re running (ie, plain Kubernetes or OpenShift)

the profile you wish to use. It will apply certain traits which are required by the specific profile chosen. It usually relates the Cluster with the optional definition of special profiles (ie, Knative)

specify how to build the Integration/IntegrationKits

Deprecated: not used

list of traits to be executed for all the Integration/IntegrationKits built from this IntegrationPlatform

list of configuration properties to be attached to all the Integration/IntegrationKits built from this IntegrationPlatform

configuration to be executed to all Kamelets controlled by this IntegrationPlatform

(Members of IntegrationPlatformSpec are embedded into this type.)

defines in what phase the IntegrationPlatform is found

which are the conditions met (particularly useful when in ERROR phase)

the Camel K operator version controlling this IntegrationPlatform

generic information related to the build of Camel K operator software

the number of Pods needed for the running Integration

the sources which contain the Camel routes to run

a source in YAML DSL language which contain the routes to run

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

the reference of the IntegrationKit which is used for this Integration

the list of Camel or Maven dependencies required by the Integration

the profile needed to run this Integration

the traits needed to run this Integration

Pod template customization

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

additional Maven repositories to be used

custom SA to use for the Integration

the actual phase

the digest calculated for this Integration

the container image used

a list of dependencies needed by the application

the profile needed to run this Integration

the reference of the IntegrationKit which is used for this Integration

The IntegrationPlatform watching this Integration

a list of sources generated for this Integration

Deprecated: a list of resources generated for this Integration

the runtime version targeted for this Integration

the runtime provider targeted for this Integration

Deprecated: a list of configuration specification

a list of events happened for the Integration

the operator version

the number of replicas

label selector

features offered by the Integration

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

(Members of BaseTask are embedded into this type.)

(Members of PublishTask are embedded into this type.)

log more information

use a cache

true if a cache is enabled

the PVC used to store the cache

Maven Group

Maven Artifact

Maven Version

(Members of MavenSpec are embedded into this type.)

base Maven specification

additional repositories

Servers (auth)

The path of the local Maven repository.

The Maven properties.

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

Deprecated: use CASecrets 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.

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

The Maven build extensions. See https://maven.apache.org/guides/mini/guide-using-extensions.html.

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.

Volumes

InitContainers

Containers

EphemeralContainers

RestartPolicy

TerminationGracePeriodSeconds

ActiveDeadlineSeconds

DNSPolicy

NodeSelector

TopologySpreadConstraints

PodSecurityContext

the specification

can be useful to share info with other tasks

base image layer

final image name

where to publish the final image

if the container registry is insecure (ie, http only)

the URI to access

the secret where credentials are stored

the configmap which stores the Certificate Authority

the registry organization

identifies the repository

name of the repository

location of the repository

can use snapshot

can use stable releases

is the policy activated or not

This element specifies how often updates should attempt to occur. Maven will compare the local POM’s timestamp (stored in a repository’s maven-metadata file) to the remote. The choices are: always, daily (default), interval:X (where X is an integer in minutes) or never

When Maven deploys files to the repository, it also deploys corresponding checksum files. Your options are to ignore, fail, or warn on missing or incorrect checksums.

(Members of DataSpec are embedded into this type.)

the content of the resource

the kind of data to expect

the mount path on destination Pod

Camel K Runtime version

Camel main application provider, ie, Camel Quarkus

application entry point (main) to be executed

list of dependencies needed to run the application

set of metadata

features offered by this runtime

(Members of BaseTask are embedded into this type.)

can be useful to share info with other tasks

used by the ImageStream

(Members of DataSpec are embedded into this type.)

contains configuration related to the source code

specify which is the language (Camel DSL) used to interpret this source code

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

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

Type defines the kind of source described by this object

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

(Members of BaseTask are embedded into this type.)

(Members of PublishTask are embedded into this type.)

a BuilderTask (base task)

a BuildahTask, for Buildah strategy

a KanikoTask, for Kaniko strategy

a SpectrumTask, for Spectrum strategy

a S2iTask, for S2I strategy

(Members of RawMessage are embedded into this type.)

generic raw message, tipically a map containing the keys (trait parameters) and the values (either single text or array)

TraitConfiguration parameters configuration

Selects a key of a ConfigMap.

Selects a key of a secret.