Camel K API
Resource Types
Build
Build is the Schema for the builds API.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| |
|
CamelCatalog
CamelCatalog represents the languages, components, data formats and capabilities enabled on a given runtime provider. The catalog may be statically generated.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| the actual state of the catalog |
| the desired state of the catalog |
Integration
Integration is the Schema for the integrations API.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| the desired Integration specification |
| the status of the Integration |
IntegrationKit
IntegrationKit defines a container image and additional configuration needed to run an Integration. An IntegrationKit is a generic image generally built from the requirements of an Integration, but agnostic to it, in order to be reused by any other Integration which has the same required set of capabilities. An IntegrationKit may be used for other kits as a base container layer, when the incremental build option is enabled.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| the desired configuration |
| the actual status |
IntegrationPlatform
IntegrationPlatform is the resource used to drive the Camel K operator behavior. It defines the behavior of all Custom Resources (IntegrationKit, Integration, Kamelet) in the given namespace. When the Camel K operator is installed in global mode, you will need to specify an IntegrationPlatform in each namespace where you want the Camel K operator to be executed.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
|
IntegrationProfile
IntegrationProfile is the resource used to apply user defined settings to the Camel K operator behavior. It defines the behavior of all Custom Resources (IntegrationKit, Integration, Kamelet) in the given namespace. Deprecated: may be removed in future releases. Make use of IntegrationPlatform instead.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
|
Kamelet
Kamelet is the Schema for the kamelets API.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| the desired specification |
| the actual status of the resource Deprecated no longer in use |
Pipe
Pipe is the Schema for the Pipe API.
| Field | Description |
|---|---|
|
|
|
|
| Refer to the Kubernetes API documentation for the fields of the |
| the specification of a Pipe |
| the status of a Pipe |
Internal Types
AddonTrait
Appears on:
AddonTrait represents the configuration of an addon trait.
| Field | Description |
|---|---|
| (Members of Generic raw message, typically a map containing the keys (trait parameters) and the values (either single text or array) |
Artifact
Appears on:
Artifact represents a materialized artifact (a jar dependency or in general a file used by the build).
| Field | Description |
|---|---|
| the identification (GAV for maven dependencies or file name for other file types) |
| where it is located in the builder |
| the expected location in the runtime |
| a checksum (SHA1) of the content |
BaseTask
Appears on:
BaseTask is a base for the struct hierarchy.
| Field | Description |
|---|---|
| name of the task |
| The configuration that should be used to perform the Build. |
BeanProperties
BeanProperties represent an unstructured object properties to be set on a bean.
| Field | Description |
|---|---|
| (Members of |
BuildCondition
Appears on:
BuildCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
| 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. |
BuildConfiguration
Appears on:
BuildConfiguration represent the configuration required to build the runtime.
| Field | Description |
|---|---|
| The container image to be used to run the build. |
| The namespace where to run the builder Pod (must be the same of the operator in charge of this Build reconciliation). |
| the strategy to adopt |
| the build order strategy to adopt |
| The minimum amount of CPU required. Only used for |
| The minimum amount of memory required. Only used for |
| The maximum amount of CPU required. Only used for |
| The maximum amount of memory required. Only used for |
| The node selector for the builder pod. Only used for |
| Annotation to use for the builder pod. Only used for |
| The list of platforms used in order to build a container image. |
BuildOrderStrategy(string alias)
Appears on:
BuildOrderStrategy specifies how builds are reconciled and queued.
BuildSpec
Appears on:
BuildSpec defines the list of tasks to be execute for a Build. From Camel K version 2, it would be more appropriate to think it as pipeline.
| Field | Description |
|---|---|
| The sequence of tasks (pipeline) to be performed. |
| The configuration that should be used to perform the Build. Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility |
| The container image to be used to run the build. Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility |
| The namespace where to run the builder Pod (must be the same of the operator in charge of this Build reconciliation). Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility |
| 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. |
| the maximum amount of parallel running builds started by this operator instance Deprecated: no longer in use in Camel K 2 - maintained for backward compatibility |
BuildStatus
Appears on:
BuildStatus defines the observed state of Build.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this Build. |
| describes the phase |
| the image name built |
| the digest from image |
| root image (the first image from which the incremental image has started) |
| 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 |
BuildStrategy(string alias)
Appears on:
BuildStrategy specifies how the Build should be executed. It will trigger a Maven process (either as an Operator routine or Kubernetes Pod execution) that will take care of producing the expected Camel/Camel-Quarkus runtime.
BuildahTask
Appears on:
BuildahTask is used to configure Buildah. Deprecated: no longer in use.
| Field | Description |
|---|---|
| (Members of |
| (Members of |
| The platform of build image |
| log more information |
| docker image to use |
BuilderTask
Appears on:
BuilderTask is the generic task in charge of building the application image.
| Field | Description |
|---|---|
| (Members of |
| the base image layer |
| the configuration required for the runtime application |
| 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 |
| the sources to add at build time |
CamelArtifact
Appears on:
CamelArtifact represent the configuration for a feature offered by Camel.
| Field | Description |
|---|---|
| (Members of 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, …) |
CamelArtifactDependency
Appears on:
CamelArtifactDependency represent a maven’s dependency.
| Field | Description |
|---|---|
| (Members of the maven dependency |
| provide a list of artifacts to exclude for this dependency |
CamelArtifactExclusion
Appears on:
CamelArtifactExclusion represents an exclusion clause.
| Field | Description |
|---|---|
| Maven Group |
| Maven Artifact |
CamelCatalogCondition
Appears on:
CamelCatalogCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
Type of CamelCatalog 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. |
CamelCatalogSpec
Appears on:
CamelCatalogSpec specify what features a Camel runtime provides.
| Field | Description |
|---|---|
| the runtime targeted for the catalog |
| artifacts required by this catalog |
| loaders required by this catalog |
CamelCatalogStatus
Appears on:
CamelCatalogStatus defines the observed state of CamelCatalog.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this Catalog. |
| the actual phase |
| a list of events happened for the CamelCatalog |
| the container image available for building an application with this catalog |
CamelLoader
Appears on:
CamelLoader represents the configuration required to load a DSL.
| Field | Description |
|---|---|
| (Members of the base Maven artifact required |
| a list of DSLs supported |
| a list of additional dependencies required beside the base one |
| the metadata of the loader |
CamelProperty
Appears on:
CamelProperty represents a Camel property that may end up in an application.properties file.
| Field | Description |
|---|---|
| |
|
CamelScheme
Appears on:
CamelScheme represents the scheme used to identify a component in a URI (ie, timer in a timer:xyz endpoint URI).
| Field | Description |
|---|---|
| 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 |
CamelSchemeScope
Appears on:
CamelSchemeScope contains scoped information about a scheme.
| Field | Description |
|---|---|
| list of dependencies needed for this scope |
Capability
Appears on:
Capability is a particular feature which requires a well known set of dependencies and other properties which are specified in the runtime catalog.
| Field | Description |
|---|---|
| List of required Maven dependencies |
| Set of required Camel runtime properties |
| Set of required Camel build time properties |
| Set of generic metadata |
Catalog
Appears on:
Catalog represents the Camel Catalog runtime specification.
| Field | Description |
|---|---|
| |
|
ConfigurationSpec
Appears on:
ConfigurationSpec represents a generic configuration specification.
| Field | Description |
|---|---|
| represents the type of configuration, ie: property, configmap, secret, … |
| the value to assign to the configuration (syntax may vary depending on the |
DataSpec
Appears on:
DataSpec represents the way the source is materialized in the running Pod.
| Field | Description |
|---|---|
| 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) |
DataTypeReference
Appears on:
DataTypeReference references to the specification of a data type by its scheme and format name.
| Field | Description |
|---|---|
| the data type component scheme |
| the data type format name |
DataTypeSpec
Appears on:
DataTypeSpec represents the specification for a data type.
| Field | Description |
|---|---|
| the data type component scheme |
| the data type format name |
| optional description |
| media type as expected for HTTP media types (ie, application/json) |
| the list of Camel or Maven dependencies required by the data type |
| one to many header specifications |
| the expected schema for the data type |
DataTypesSpec
Appears on:
DataTypesSpec represents the specification for a set of data types.
| Field | Description |
|---|---|
| the default data type for this Kamelet |
| one to many data type specifications |
| one to many header specifications |
Endpoint
Appears on:
Endpoint represents a source/sink external entity (could be any Kubernetes resource or Camel URI).
| Field | Description |
|---|---|
Ref can be used to declare a Kubernetes resource as source/sink endpoint | |
| URI can be used to specify the (Camel) endpoint explicitly |
| Properties are a key value representation of endpoint properties |
DataTypes defines the data type of the data produced/consumed by the endpoint and references a given data type specification. |
EndpointProperties
Appears on:
EndpointProperties is a key/value struct represented as JSON raw to allow numeric/boolean values.
| Field | Description |
|---|---|
| (Members of |
ErrorHandler
ErrorHandler is a generic interface that represent any type of error handler specification.
ErrorHandlerLog
Appears on:
ErrorHandlerLog represent a default (log) error handler type.
| Field | Description |
|---|---|
| |
|
ErrorHandlerParameters
Appears on:
ErrorHandlerParameters represent an unstructured object for error handler parameters.
| Field | Description |
|---|---|
| (Members of |
ErrorHandlerSink
ErrorHandlerSink represents a sink error handler type which behave like a dead letter channel.
| Field | Description |
|---|---|
| |
|
ErrorHandlerSpec
Appears on:
ErrorHandlerSpec represents an unstructured object for an error handler.
| Field | Description |
|---|---|
| (Members of |
EventTypeSpec
Appears on:
EventTypeSpec represents a specification for an event type. Deprecated: In favor of using DataTypeSpec.
| Field | Description |
|---|---|
| media type as expected for HTTP media types (ie, application/json) |
| the expected schema for the event |
ExternalDocumentation
Appears on:
ExternalDocumentation allows referencing an external resource for extended documentation.
| Field | Description |
|---|---|
| |
|
ExtraDirectories
Appears on:
ExtraDirectories — .
| Field | Description |
|---|---|
| |
|
Failure
Appears on:
Failure represent a message specifying the reason and the time of an event failure.
| Field | Description |
|---|---|
| a short text specifying the reason |
the time when the failure has happened | |
| the recovery attempted for this failure |
FailureRecovery
Appears on:
FailureRecovery defines the attempts to recover a failure.
| Field | Description |
|---|---|
| attempt number |
| maximum number of attempts |
| (Optional) time of the attempt execution |
Flow
Appears on:
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL.
| Field | Description |
|---|---|
| (Members of |
HeaderSpec
Appears on:
HeaderSpec represents the specification for a header used in the Kamelet.
| Field | Description |
|---|---|
| |
| |
| |
| |
|
HealthCheck
| Field | Description |
|---|---|
| |
|
HealthCheckResponse
Appears on:
| Field | Description |
|---|---|
| |
| |
|
IntegrationCondition
Appears on:
IntegrationCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
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. |
| Pods collect health and conditions information from the owned PODs |
IntegrationKitCondition
Appears on:
IntegrationKitCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
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. |
IntegrationKitSpec
Appears on:
IntegrationKitSpec defines a container image and additional configurations required to kick off an Integration with certain features.
| Field | Description |
|---|---|
| the container image as identified 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 |
| Deprecated: Use camel trait (camel.properties) to manage properties Use mount trait (mount.configs) to manage configs Use mount trait (mount.resources) to manage resources Use mount trait (mount.volumes) to manage volumes configuration used by the kit |
| Maven repositories that can be used by the kit |
| the sources to add at build time |
| features offered by the IntegrationKit |
IntegrationKitStatus
Appears on:
IntegrationKitStatus defines the observed state of IntegrationKit.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this IntegrationKit. |
| phase of the kit |
| root image used by the kit (the first image from which the incremental image has started, typically a JDK/JRE base image) |
| base image used by the kit (could be another IntegrationKit) |
| 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 catalog used to build/operate the IntegrationKit. |
| 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 |
IntegrationKitTraits
Appears on:
IntegrationKitTraits defines traits assigned to an IntegrationKit.
| Field | Description |
|---|---|
| The builder trait is internally used to determine the best strategy to build and configure IntegrationKits. |
| The Camel trait sets up Camel configuration. |
| The Quarkus trait configures the Quarkus runtime. It’s enabled by default. NOTE: Compiling to a native executable, requires at least 4GiB of memory, so the Pod running the native build must have enough memory available. |
| The Registry trait sets up Maven to use the Image registry as a Maven repository (support removed since version 2.5.0). Deprecated: use jvm trait or read documentation. |
| The collection of addon trait configurations |
IntegrationPlatformBuildPublishStrategy(string alias)
Appears on:
IntegrationPlatformBuildPublishStrategy defines the strategy used to package and publish an Integration base image.
IntegrationPlatformBuildSpec
Appears on:
IntegrationPlatformBuildSpec contains platform related build information. This configuration can be used to tune the behavior of the Integration/IntegrationKit image builds. You can define the build strategy, the image registry to use and the Maven configuration to adopt.
| Field | Description |
|---|---|
| the configuration required to build an Integration container image |
| the strategy to adopt for publishing an Integration container 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) |
| the Camel core version used by this IntegrationPlatform |
| 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 software |
| the image registry used to push/pull Integration images |
| the timeout (in seconds) to use when creating the build tools container image Deprecated: no longer in use |
| how much time to wait before time out the pipeline process |
| Maven configuration used to build the Camel/Camel-Quarkus applications |
| Deprecated: no longer in use |
| the maximum amount of parallel running pipelines started by this operator instance |
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 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. |
IntegrationPlatformConditionType(string alias)
Appears on:
IntegrationPlatformConditionType defines the type of condition.
IntegrationPlatformKameletSpec
Appears on:
IntegrationPlatformKameletSpec define the behavior for all the Kamelets controller by the IntegrationPlatform.
| Field | Description |
|---|---|
| remote repository used to retrieve Kamelet catalog |
IntegrationPlatformPhase(string alias)
Appears on:
IntegrationPlatformPhase is the phase of an IntegrationPlatform.
IntegrationPlatformSpec
Appears on:
IntegrationPlatformSpec defines the desired state of IntegrationPlatform.
| Field | Description |
|---|---|
| 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 | |
| list of traits to be executed for all the Integration/IntegrationKits built from this IntegrationPlatform |
| Deprecated: Use camel trait (camel.properties) to manage properties Use mount trait (mount.configs) to manage configs Use mount trait (mount.resources) to manage resources Use mount trait (mount.volumes) to manage volumes 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 |
IntegrationPlatformStatus
Appears on:
IntegrationPlatformStatus defines the observed state of IntegrationPlatform.
| Field | Description |
|---|---|
| (Members of |
| ObservedGeneration is the most recent generation observed for this IntegrationPlatform. |
| 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 |
IntegrationProfileBuildSpec
Appears on:
IntegrationProfileBuildSpec contains profile related build information. This configuration can be used to tune the behavior of the Integration/IntegrationKit image builds.
| Field | Description |
|---|---|
| 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 software |
| the image registry used to push/pull Integration images |
| how much time to wait before time out the pipeline process |
| Maven configuration used to build the Camel/Camel-Quarkus applications |
IntegrationProfileCondition
Appears on:
IntegrationProfileCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
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. |
IntegrationProfileConditionType(string alias)
Appears on:
IntegrationProfileConditionType defines the type of condition.
IntegrationProfileKameletSpec
Appears on:
IntegrationProfileKameletSpec define the behavior for all the Kamelets controller by the IntegrationProfile.
| Field | Description |
|---|---|
| remote repository used to retrieve Kamelet catalog |
IntegrationProfilePhase(string alias)
Appears on:
IntegrationProfilePhase is the phase of an IntegrationProfile.
IntegrationProfileSpec
Appears on:
IntegrationProfileSpec applies user defined settings to the IntegrationProfile.
| Field | Description |
|---|---|
specify how to build the Integration/IntegrationKits | |
| list of traits to be executed for all the Integration/IntegrationKits built from this IntegrationProfile |
| configuration to be executed to all Kamelets controlled by this IntegrationProfile |
IntegrationProfileStatus
Appears on:
IntegrationProfileStatus defines the observed state of IntegrationProfile.
| Field | Description |
|---|---|
| (Members of |
| ObservedGeneration is the most recent generation observed for this IntegrationProfile. |
| defines in what phase the IntegrationProfile is found |
| which are the conditions met (particularly useful when in ERROR phase) |
IntegrationSpec
Appears on:
IntegrationSpec specifies the configuration of an Integration. The Integration will be watched by the operator which will be in charge to run the related application, according to the configuration specified.
| Field | Description |
|---|---|
| the number of |
| the sources which contain the Camel routes to run |
| a source in YAML DSL language which contain the routes to run |
| the reference of the |
| 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 mount trait (mount.configs) to manage configs Use mount trait (mount.resources) to manage resources Use mount trait (mount.volumes) to manage volumes |
| additional Maven repositories to be used |
| custom SA to use for the Integration |
IntegrationStatus
Appears on:
IntegrationStatus defines the observed state of Integration.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this 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 traits executed for the Integration |
| the reference of the |
| The IntegrationPlatform watching this Integration |
| a list of sources generated for this Integration |
| the runtime version targeted for this Integration |
| the runtime provider targeted for this Integration |
| the catalog used to build/operate the 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. |
JSON
Appears on:
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
| Field | Description |
|---|---|
| (Members of |
JSONSchemaProp
Appears on:
| Field | Description |
|---|---|
| |
| |
| |
| |
| format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
|
| |
| default is a default value for undefined object fields. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| XDescriptors is a list of extended properties that trigger a custom behavior in external systems |
JSONSchemaProps
Appears on:
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
| Field | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
JibTask
Appears on:
JibTask is used to configure Jib.
| Field | Description |
|---|---|
| (Members of |
| (Members of |
KameletCondition
Appears on:
KameletCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
| Type of kamelet 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. |
KameletProperty
Appears on:
KameletProperty specify the behavior of a property in a Kamelet.
| Field | Description |
|---|---|
| the name of the property |
| the default value of the property (if any) |
KameletRepositorySpec
Appears on:
KameletRepositorySpec defines the location of the Kamelet catalog to use.
| Field | Description |
|---|---|
| the remote repository in the format github:ORG/REPO/PATH_TO_KAMELETS_FOLDER |
KameletSpec
Appears on:
KameletSpec specifies the configuration required to execute a Kamelet.
| Field | Description |
|---|---|
| (Members of |
| the optional versions available for this Kamelet. This field may not be taken in account by Camel core and is meant to support any user defined versioning model on cluster only. If the user wants to use any given version, she must materialize a file with the given version spec as the |
KameletSpecBase
Appears on:
KameletSpecBase specifies the base configuration of a Kamelet.
| Field | Description |
|---|---|
| defines the formal configuration of the Kamelet |
| sources in any Camel DSL supported |
| the main source in YAML DSL |
data specification types for the events consumed/produced by the Kamelet Deprecated: In favor of using DataTypes | |
data specification types for the events consumed/produced by the Kamelet | |
| Camel dependencies needed by the Kamelet |
KameletStatus
Appears on:
KameletStatus defines the observed state of Kamelet.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this Kamelet. |
| Phase — |
| Conditions — |
| Properties — |
KanikoTask
Appears on:
KanikoTask is used to configure Kaniko. Deprecated: no longer in use.
| Field | Description |
|---|---|
| (Members of |
| (Members of |
| log more information |
| use a cache |
| docker image to use |
KanikoTaskCache
Appears on:
KanikoTaskCache is used to configure Kaniko cache. Deprecated: no longer in use.
| Field | Description |
|---|---|
| true if a cache is enabled |
| the PVC used to store the cache |
MavenArtifact
Appears on:
MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier) Maven artifact.
| Field | Description |
|---|---|
| Maven Group |
| Maven Artifact |
| Maven Type |
| Maven Version |
| Maven Classifier |
MavenBuildSpec
Appears on:
MavenBuildSpec defines the Maven configuration plus additional repositories to use.
| Field | Description |
|---|---|
| (Members of base Maven specification |
| additional repositories |
| Servers (auth) |
MavenSpec
Appears on:
MavenSpec --.
| Field | Description |
|---|---|
| The path of the local Maven repository. |
| The Maven properties. |
| A reference to the ConfigMap or Secret key that contains the Maven profile. |
| A reference to the ConfigMap or Secret key that contains the Maven settings. |
| A reference to the ConfigMap or Secret key that contains the security of the Maven settings. |
| 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., |
PipeCondition
Appears on:
PipeCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
| Type of pipe 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. |
| Pods collect health and conditions information from the owned PODs |
PipeSpec
Appears on:
PipeSpec defines the binding between a source and a sink. It can include custom parameters and additional intermediate steps and error handling.
| Field | Description |
|---|---|
| Integration is an optional integration used to specify custom parameters Deprecated don’t use this. Use trait annotations if you need to change any cluster configuration. |
| Source is the starting point of the integration defined by this Pipe |
| Sink is the destination of the integration defined by this Pipe |
| ErrorHandler is an optional handler called upon an error occurring in the integration |
| Steps contains an optional list of intermediate steps that are executed between the Source and the Sink |
| Replicas is the number of desired replicas for the Pipe |
| Custom SA to use for the Pipe |
PipeStatus
Appears on:
PipeStatus specify the status of a Pipe.
| Field | Description |
|---|---|
| ObservedGeneration is the most recent generation observed for this Pipe. |
| Phase — |
| Conditions — |
| Replicas is the number of actual replicas of the pipe |
| Selector allows to identify pods belonging to the pipe |
PluginConfiguration
PluginConfiguration see Maven settings.
| Field | Description |
|---|---|
| |
| |
| |
|
PluginExtension
Appears on:
PluginExtension — .
| Field | Description |
|---|---|
| |
|
PluginExtensionConfiguration
Appears on:
PluginExtensionConfiguration — .
| Field | Description |
|---|---|
| |
|
PluginProperties(map[string]github.com/apache/camel-k/v2/pkg/apis/camel/v1.StringOrProperties alias)
PluginProperties — .
PodCondition
Appears on:
| Field | Description |
|---|---|
| |
| |
|
PodSpec
Appears on:
PodSpec defines a group of Kubernetes resources.
| Field | Description |
|---|---|
| AutomountServiceAccountToken |
| Volumes |
| InitContainers |
| Containers |
| EphemeralContainers |
| RestartPolicy |
| TerminationGracePeriodSeconds |
| ActiveDeadlineSeconds |
| DNSPolicy |
| NodeSelector |
| TopologySpreadConstraints |
| PodSecurityContext |
PodSpecTemplate
Appears on:
PodSpecTemplate represent a template used to deploy an Integration Pod.
| Field | Description |
|---|---|
| the specification |
PublishTask
Appears on:
PublishTask image publish configuration.
| Field | Description |
|---|---|
| can be useful to share info with other tasks |
| base image layer |
| final image name |
| where to publish the final image |
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 |
|---|---|
| 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 |
Repository
Appears on:
Repository defines a Maven repository.
| Field | Description |
|---|---|
| identifies the repository |
| name of the repository |
| location of the repository |
| can use snapshot |
| can use stable releases |
RepositoryPolicy
Appears on:
RepositoryPolicy defines the policy associated to a Maven repository.
| Field | Description |
|---|---|
| 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: |
| When Maven deploys files to the repository, it also deploys corresponding checksum files. Your options are to |
RuntimeSpec
Appears on:
RuntimeSpec represents the configuration for the Java runtime in charge to execute the Camel application.
| Field | Description |
|---|---|
| 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 |
S2iTask
Appears on:
S2iTask is used to configure S2I.
| Field | Description |
|---|---|
| (Members of |
| (Members of |
| used by the ImageStream |
Server
Appears on:
Server see Maven settings.
| Field | Description |
|---|---|
| |
| |
| |
| |
|
SourceSpec
Appears on:
SourceSpec defines the configuration for one or more routes to be executed in a certain Camel DSL language.
| Field | Description |
|---|---|
| (Members of 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 Deprecated: no longer in use. |
| Type defines the kind of source described by this object |
| List of property names defined in the source (e.g. if type is "template") |
| True if the spec is generated from a Kamelet |
SpectrumTask
Appears on:
SpectrumTask is used to configure Spectrum.
| Field | Description |
|---|---|
| (Members of |
| (Members of |
Task
Appears on:
Task represents the abstract task. Only one of the task should be configured to represent the specific task chosen.
| Field | Description |
|---|---|
| a BuilderTask, used to generate and build the project |
| User customizable task execution. These are executed after the build and before the package task. |
| Application pre publishing a PackageTask, used to package the project |
| a BuildahTask, for Buildah strategy Deprecated: use jib, s2i or a custom publishing strategy instead |
| a KanikoTask, for Kaniko strategy Deprecated: use jib, s2i or a custom publishing strategy instead |
| a SpectrumTask, for Spectrum strategy Deprecated: use jib, s2i or a custom publishing strategy instead |
| a S2iTask, for S2I strategy |
| a JibTask, for Jib strategy |
Template
Appears on:
Template is an unstructured object representing a Kamelet template in YAML/JSON DSL.
| Field | Description |
|---|---|
| (Members of an unstructured raw message |
TraitConfiguration
Appears on:
TraitConfiguration represents the expected configuration for a given trait parameter Deprecated: superceded by each Trait type, left for backward compatibility.
| Field | Description |
|---|---|
| (Members of generic raw message, typically a map containing the keys (trait parameters) and the values (either single text or array) |
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 Deprecated: superceded by each Trait type, left for backward compatibility.
| Field | Description |
|---|---|
| TraitConfiguration parameters configuration |
Traits
Appears on:
Traits represents the collection of trait configurations.
| Field | Description |
|---|---|
| The configuration of Affinity trait |
| The configuration of Builder trait |
| The configuration of Camel trait |
| The configuration of Container trait |
| The configuration of Cron trait |
| The configuration of Dependencies trait |
| The configuration of Deployer trait |
| The configuration of Deployment trait |
| The configuration of Environment trait |
| The configuration of Error Handler trait |
| The configuration of GC trait |
| The configuration of Health trait |
| The configuration of Ingress trait |
| The configuration of Istio trait |
| The configuration of Jolokia trait |
| The configuration of JVM trait |
| The configuration of Kamelets trait |
| The configuration of Knative trait |
| The configuration of Knative Service trait |
| The configuration of Logging trait |
| The configuration of Mount trait |
| The configuration of OpenAPI trait |
| The configuration of Owner trait |
| The configuration of PDB trait |
| The configuration of Platform trait |
| The configuration of Pod trait |
| The configuration of Prometheus trait |
| The configuration of Pull Secret trait |
| The configuration of Quarkus trait |
| The configuration of Registry trait (support removed since version 2.5.0). Deprecated: use jvm trait or read documentation. |
| The configuration of Route trait |
| The configuration of Security Context trait |
| The configuration of Service trait |
| The configuration of Service Binding trait |
| The configuration of Telemetry trait |
| The configuration of Toleration trait |
| The extension point with addon traits |
| Deprecated: for backward compatibility. |
| Deprecated: for backward compatibility. |
| Deprecated: for backward compatibility. |
| Deprecated: for backward compatibility. |
| Deprecated: for backward compatibility. |
UserTask
Appears on:
UserTask is used to execute any generic custom operation.
| Field | Description |
|---|---|
| (Members of |
| the container image to use |
| the user id used to run the container |
| the command to execute Deprecated: use ContainerCommands |
| the command to execute |
| the desired image build name |
ValueSource
Appears on:
ValueSource --.
| Field | Description |
|---|---|
| Selects a key of a ConfigMap. |
| Selects a key of a secret. |
AffinityTrait
Appears on:
Allows constraining which nodes the integration pod(s) are eligible to be scheduled on, based on labels on the node, or with inter-pod affinity and anti-affinity, based on labels on pods that are already running on the nodes.
It’s disabled by default.
| Field | Description |
|---|---|
| (Members of |
| Always co-locates multiple replicas of the integration in the same node (default |
| Never co-locates multiple replicas of the integration in the same node (default |
| Defines a set of nodes the integration pod(s) are eligible to be scheduled on, based on labels on the node. |
| Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the integration pod(s) should be co-located with. |
| Defines a set of pods (namely those matching the label selector, relative to the given namespace) that the integration pod(s) should not be co-located with. |
BuilderTrait
Appears on:
The builder trait is internally used to determine the best strategy to build and configure IntegrationKits.
| Field | Description |
|---|---|
| (Members of |
| Enable verbose logging on build components that support it (e.g. Kaniko build pod). Deprecated no longer in use |
| A list of properties to be provided to the build task |
| The strategy to use, either |
| Specify a base image. In order to have the application working properly it must be a container image which has a Java JDK installed and ready to use on path (ie |
| Use the incremental image build option, to reuse existing containers (default |
| The build order strategy to use, either |
| When using |
| When using |
| When using |
| When using |
| A list of references pointing to configmaps/secrets that contains a maven profile. This configmap/secret is a resource of the IntegrationKit created, therefore it needs to be present in the namespace where the operator is going to create the IntegrationKit. The content of the maven profile is expected to be a text containing a valid maven profile starting with |
| A list of tasks to be executed (available only when using |
| A list of tasks sorted by the order of execution in a csv format, ie, |
| A list of request cpu configuration for the specific task with format |
| A list of request memory configuration for the specific task with format |
| A list of limit cpu configuration for the specific task with format |
| A list of limit memory configuration for the specific task with format |
| Defines a set of nodes the builder pod is eligible to be scheduled on, based on labels on the node. |
| When using |
| The list of manifest platforms to use to build a container image (default |
CamelTrait
Appears on:
The Camel trait can be used to configure versions of Apache Camel K runtime and related libraries, it cannot be disabled.
| Field | Description |
|---|---|
| (Members of |
| The camel-k-runtime version to use for the integration. It overrides the default version set in the Integration Platform. You can use a fixed version (for example "3.2.3") or a semantic version (for example "3.x") which will try to resolve to the best matching Catalog existing on the cluster. |
| A list of properties to be provided to the Integration runtime |
Configuration
Appears on:
Configuration defines the trait structure Deprecated: for backward compatibility.
| Field | Description |
|---|---|
| (Members of |
ContainerTrait
Appears on:
The Container trait can be used to configure properties of the container where the integration will run.
It also provides configuration for Services associated to the container.
| Field | Description |
|---|---|
| (Members of |
| To automatically enable the trait |
| The minimum amount of CPU required (default 125 millicores). |
| The minimum amount of memory required (default 128 Mi). |
| The maximum amount of CPU to be provided (default 500 millicores). |
| The maximum amount of memory to be provided (default 512 Mi). |
| Can be used to enable/disable exposure via kubernetes Service. |
| To configure a different port exposed by the container (default |
| To configure a different port name for the port exposed by the container. It defaults to |
| To configure under which service port the container port is to be exposed (default |
| To configure under which service port name the container port is to be exposed (default |
| The main container name. It’s named |
| The main container image to use for the Integration. When using this parameter the operator will create a synthetic IntegrationKit which won’t be able to execute traits requiring CamelCatalog. If the container image you’re using is coming from an IntegrationKit, use instead Integration |
| The pull policy: Always|Never|IfNotPresent |
| Security Context RunAsUser configuration (default none): this value is automatically retrieved in Openshift clusters when not explicitly set. |
| Security Context RunAsNonRoot configuration (default false). |
| Security Context SeccompProfileType configuration (default RuntimeDefault). |
| Security Context AllowPrivilegeEscalation configuration (default false). |
| Security Context Capabilities Drop configuration (default ALL). |
| Security Context Capabilities Add configuration (default none). |
CronTrait
Appears on:
The Cron trait can be used to customize the behaviour of periodic timer/cron based integrations.
While normally an integration requires a pod to be always up and running, some periodic tasks, such as batch jobs, require to be activated at specific hours of the day or with a periodic delay of minutes. For such tasks, the cron trait can materialize the integration as a Kubernetes CronJob instead of a standard deployment, in order to save resources when the integration does not need to be executed.
Integrations that start from the following components are evaluated by the cron trait: timer, cron, quartz. The trait does support multiple evaluated components only if they have the same schedule, else it will fallback to Camel implementation instead of instanciating a Kubernetes CronJob.
| In case of native build-mode defined in quarkus trait, the component can’t be customized. |
The rules for using a Kubernetes CronJob are the following:
-
timer: when period is set in milliseconds with no remaining seconds, for example 120000. If there is any second left as in 121000 (120s and 1s) or the presence of any of these parameters (delay, repeatCount, time) then a CronJob won’t be created, but a standard deployment. -
cron,quartz: when the cron expression does not contain seconds (or the "seconds" part is set to 0). E.g.`cron:tab?schedule=0/2 * * * ?` or `quartz:trigger?cron=0 0/2 * * * ?`.
| Field | Description |
|---|---|
| (Members of |
| The CronJob schedule for the whole integration. If multiple routes are declared, they must have the same schedule for this mechanism to work correctly. |
| The timezone that the CronJob will run on |
| A comma separated list of the Camel components that need to be customized in order for them to work when the schedule is triggered externally by Kubernetes. Supported components are currently: |
| Use the default Camel implementation of the |
| Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow": allows CronJobs to run concurrently; - "Forbid" (default): forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - "Replace": cancels currently running job and replaces it with a new one |
| Automatically deploy the integration as CronJob when all routes are either starting from a periodic consumer (only It’s required that all periodic consumers have the same period, and it can be expressed as cron schedule (e.g. |
| Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
| Specifies the duration in seconds, relative to the start time, that the job may be continuously active before it is considered to be failed. It defaults to 60s. |
| Specifies the number of retries before marking the job failed. It defaults to 2. |
DependenciesTrait
Appears on:
The Dependencies trait is internally used to automatically add runtime dependencies based on the integration that the user wants to run.
| Field | Description |
|---|---|
| (Members of |
DeployerTrait
Appears on:
The deployer trait is responsible for deploying the resources owned by the integration, and can be used to explicitly select the underlying controller that will manage the integration pods.
| Field | Description |
|---|---|
| (Members of |
| Allows to explicitly select the desired deployment kind between |
| Deprecated: won’t be able to enforce client side update in the future. Use server-side apply to update the owned resources (default |
DeploymentTrait
Appears on:
The Deployment trait is responsible for generating the Kubernetes deployment that will make sure the integration will run in the cluster.
| Field | Description |
|---|---|
| (Members of |
| The maximum time in seconds for the deployment to make progress before it is considered to be failed. It defaults to |
The deployment strategy to use to replace existing pods with new ones. | |
| The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to |
| The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to |
EnvironmentTrait
Appears on:
The environment trait is used internally to inject standard environment variables in the integration container, such as NAMESPACE, POD_NAME and others.
| Field | Description |
|---|---|
| (Members of |
| Enables injection of |
| Propagates the |
| A list of environment variables to be added to the integration container. The syntax is either VAR=VALUE or VAR=[configmap|secret]:name/key, where name represents the resource name, and key represents the resource key to be mapped as and environment variable. These take precedence over any previously defined environment variables. |
ErrorHandlerTrait
Appears on:
The error-handler is a platform trait used to inject Error Handler source into the integration runtime.
| Field | Description |
|---|---|
| (Members of |
| The error handler ref name provided or found in application properties |
GCTrait
Appears on:
The GC Trait garbage-collects all resources that are no longer necessary upon integration updates.
| Field | Description |
|---|---|
| (Members of |
| Discovery client cache to be used, either |
HealthTrait
Appears on:
The health trait is responsible for configuring the health probes on the integration container.
| this trait is disabled by default. |
| Field | Description |
|---|---|
| (Members of |
| Configures the liveness probe for the integration container (default |
| Scheme to use when connecting to the liveness probe (default |
| Number of seconds after the container has started before the liveness probe is initiated. |
| Number of seconds after which the liveness probe times out. |
| How often to perform the liveness probe. |
| Minimum consecutive successes for the liveness probe to be considered successful after having failed. |
| Minimum consecutive failures for the liveness probe to be considered failed after having succeeded. |
| The liveness probe path to use (default provided by the Catalog runtime used). |
| Configures the readiness probe for the integration container (default |
| Scheme to use when connecting to the readiness probe (default |
| Number of seconds after the container has started before the readiness probe is initiated. |
| Number of seconds after which the readiness probe times out. |
| How often to perform the readiness probe. |
| Minimum consecutive successes for the readiness probe to be considered successful after having failed. |
| Minimum consecutive failures for the readiness probe to be considered failed after having succeeded. |
| The readiness probe path to use (default provided by the Catalog runtime used). |
| Configures the startup probe for the integration container (default |
| Scheme to use when connecting to the startup probe (default |
| Number of seconds after the container has started before the startup probe is initiated. |
| Number of seconds after which the startup probe times out. |
| How often to perform the startup probe. |
| Minimum consecutive successes for the startup probe to be considered successful after having failed. |
| Minimum consecutive failures for the startup probe to be considered failed after having succeeded. |
| The startup probe path to use (default provided by the Catalog runtime used). |
IngressTrait
Appears on:
The Ingress trait can be used to expose the service associated with the integration to the outside world with a Kubernetes Ingress.
It’s enabled by default whenever a Service is added to the integration (through the service trait).
| Field | Description |
|---|---|
| (Members of |
| The Ingress class name as defined by the Ingress spec See https://kubernetes.io/docs/concepts/services-networking/ingress/ |
| The annotations added to the ingress. This can be used to set controller specific annotations, e.g., when using the NGINX Ingress controller: See https://github.com/kubernetes/ingress-nginx/blob/main/docs/user-guide/nginx-configuration/annotations.md |
| To configure the host exposed by the ingress. |
| To configure the path exposed by the ingress (default |
| To configure the path type exposed by the ingress. One of |
| To automatically add an ingress whenever the integration uses an HTTP endpoint consumer. |
| To configure tls hosts |
| To configure tls secret name |
IstioTrait
Appears on:
The Istio trait allows configuring properties related to the Istio service mesh, such as sidecar injection and outbound IP ranges.
| Field | Description |
|---|---|
| (Members of |
| Configures a (comma-separated) list of CIDR subnets that should not be intercepted by the Istio proxy ( |
| Forces the value for labels |
JVMTrait
Appears on:
The JVM trait is used to configure the JVM that runs the Integration. This trait is configured only for Integration and related IntegrationKits (bound to a container image) built by Camel K operator. If the system detects the usage of a different container image (ie, built externally), then, the trait is disabled by the platform.
| Field | Description |
|---|---|
| (Members of |
| Activates remote debugging, so that a debugger can be attached to the JVM, e.g., using port-forwarding |
| Suspends the target JVM immediately before the main class is loaded |
| Prints the command used the start the JVM in the container logs (default |
| Transport address at which to listen for the newly launched JVM (default |
| A list of JVM options |
| Additional JVM classpath (use |
| The Jar dependency which will run the application. Leave it empty for managed Integrations. |
JolokiaTrait
Appears on:
The Jolokia trait activates and configures the Jolokia Java agent. This trait is useful to enable JMX access to Camel application. Make sure you have the right privileges to perform such an action on the cluster.
| Field | Description |
|---|---|
| (Members of |
| The PEM encoded CA certification file path, used to verify client certificates, applicable when |
| The principal(s) which must be given in a client certificate to allow access to the Jolokia endpoint, applicable when |
| Listen for multicast requests (default |
| Mandate the client certificate contains a client flag in the extended key usage section, applicable when |
| The Host address to which the Jolokia agent should bind to. If |
| The password used for authentication, applicable when the |
| The Jolokia endpoint port (default |
| The protocol to use, either |
| The user to be used for authentication |
| Whether client certificates should be used for authentication (default |
| A list of additional Jolokia options as defined in JVM agent configuration options |
KameletsTrait
Appears on:
The kamelets trait is a platform trait used to inject Kamelets into the integration runtime.
| Field | Description |
|---|---|
| (Members of |
| Automatically inject all referenced Kamelets and their default configuration (enabled by default) |
| Comma separated list of Kamelet names to load into the current integration |
| The directory where the application mounts and reads Kamelet spec (default |
KnativeServiceTrait
Appears on:
The Knative Service trait allows configuring options when running the Integration as a Knative service, instead of a standard Kubernetes Deployment.
Running an Integration as a Knative Service enables auto-scaling (and scaling-to-zero), but those features are only relevant when the Camel route(s) use(s) an HTTP endpoint consumer.
| Field | Description |
|---|---|
| (Members of |
| The annotations added to route. This can be used to set knative service specific annotations CLI usage example: -t "knative-service.annotations.'haproxy.router.openshift.io/balance'=true" |
| Configures the Knative autoscaling class property (e.g. to set Refer to the Knative documentation for more information. |
| Configures the Knative autoscaling metric property (e.g. to set Refer to the Knative documentation for more information. |
| Sets the allowed concurrency level or CPU percentage (depending on the autoscaling metric) for each Pod. Refer to the Knative documentation for more information. |
| The minimum number of Pods that should be running at any time for the integration. It’s zero by default, meaning that the integration is scaled down to zero when not used for a configured amount of time. Refer to the Knative documentation for more information. |
| An upper bound for the number of Pods that can be running in parallel for the integration. Knative has its own cap value that depends on the installation. Refer to the Knative documentation for more information. |
| Enables to gradually shift traffic to the latest Revision and sets the rollout duration. It’s disabled by default and must be expressed as a Golang |
| Setting Refer to the Knative documentation for more information. |
| Automatically deploy the integration as Knative service when all conditions hold:
|
| The maximum duration in seconds that the request instance is allowed to respond to a request. This field propagates to the integration pod’s terminationGracePeriodSeconds Refer to the Knative documentation for more information. |
KnativeTrait
Appears on:
The Knative trait automatically discovers addresses of Knative resources and inject them into the running integration.
The Camel Knative component will then use the full configuration to configure the routes.
The trait is enabled by default when the Knative profile is active.
| Field | Description |
|---|---|
| (Members of |
| Can be used to inject a Knative complete configuration in JSON format. |
| List of channels used as source of integration routes. Can contain simple channel names or full Camel URIs. |
| List of channels used as destination of integration routes. Can contain simple channel names or full Camel URIs. |
| List of channels used as source of integration routes. |
| List of endpoints used as destination of integration routes. Can contain simple endpoint names or full Camel URIs. |
| List of event types that the integration will be subscribed to. Can contain simple event types or full Camel URIs (to use a specific broker different from "default"). |
| List of event types that the integration will produce. Can contain simple event types or full Camel URIs (to use a specific broker). |
| Enables filtering on events based on the header "ce-knativehistory". Since this header has been removed in newer versions of Knative, filtering is disabled by default. |
| Allows binding the integration to a sink via a Knative SinkBinding resource. This can be used when the integration targets a single sink. It’s enabled by default when the integration targets a single sink (except when the integration is owned by a Knative source). |
| Enable automatic discovery of all trait properties. |
| Enables the camel-k-operator to set the "bindings.knative.dev/include=true" label to the namespace As Knative requires this label to perform injection of K_SINK URL into the service. If this is false, the integration pod may start and fail, read the SinkBinding Knative documentation. (default: true) |
| Sets filter attributes on the event stream (such as event type, source, subject and so on). A list of key-value pairs that represent filter attributes and its values. The syntax is KEY=VALUE, e.g., |
| Enables the default filtering for the Knative trigger using the event type If this is true, the created Knative trigger uses the event type as a filter on the event stream when no other filter criteria is given. (default: true) |
LoggingTrait
Appears on:
The Logging trait is used to configure Integration runtime logging options (such as color and format). The logging backend is provided by Quarkus, whose configuration is documented at https://quarkus.io/guides/logging.
| Field | Description |
|---|---|
| (Members of |
| Colorize the log output |
| Logs message format |
| Adjust the logging level (defaults to |
| Output the logs in JSON |
| Enable "pretty printing" of the JSON logs |
MountTrait
Appears on:
The Mount trait can be used to configure volumes mounted on the Integration Pods.
| Field | Description |
|---|---|
| (Members of |
| A list of configuration pointing to configmap/secret. The configuration are expected to be UTF-8 resources as they are processed by runtime Camel Context and tried to be parsed as property files. They are also made available on the classpath in order to ease their usage directly from the Route. Syntax: [configmap|secret]:name[/key], where name represents the resource name and key optionally represents the resource key to be filtered |
| A list of resources (text or binary content) pointing to configmap/secret. The resources are expected to be any resource type (text or binary content). The destination path can be either a default location or any path specified by the user. Syntax: [configmap|secret]:name[/key][@path], where name represents the resource name, key optionally represents the resource key to be filtered and path represents the destination path |
| A list of Persistent Volume Claims to be mounted. Syntax: [pvcname:/container/path]. If the PVC is not found, the Integration fails. You can use the syntax [pvcname:/container/path:size:accessMode<:storageClass>] to create a dynamic PVC based on the Storage Class provided or the default cluster Storage Class. However, if the PVC exists, the operator would mount it. |
| A list of EmptyDir volumes to be mounted. An optional size limit may be configured (default 500Mi). Syntax: name:/container/path[:sizeLimit] |
| Enable "hot reload" when a secret/configmap mounted is edited (default |
| Deprecated: no longer available since version 2.5. |
OpenAPITrait
Appears on:
The OpenAPI DSL trait is internally used to allow creating integrations from a OpenAPI specs.
| The Openapi trait is deprecated and will removed in future release versions: use Camel REST contract first instead (see Camel core documentation). |
| Field | Description |
|---|---|
| (Members of |
| The configmaps holding the spec of the OpenAPI (compatible with > 3.0 spec only). |
OwnerTrait
Appears on:
The Owner trait ensures that all created resources belong to the integration being created and transfers annotations and labels on the integration onto these owned resources.
| Field | Description |
|---|---|
| (Members of |
| The set of annotations to be transferred |
| The set of labels to be transferred |
PDBTrait
Appears on:
The PDB trait allows to configure the PodDisruptionBudget resource for the Integration pods.
| Field | Description |
|---|---|
| (Members of |
| The number of pods for the Integration that must still be available after an eviction. It can be either an absolute number or a percentage. Only one of |
| The number of pods for the Integration that can be unavailable after an eviction. It can be either an absolute number or a percentage (default |
PlatformBaseTrait
Appears on:
PlatformBaseTrait is the base type for platform traits. It cannot be disabled by the user.
| Field | Description |
|---|---|
| Deprecated: no longer in use. |
| Legacy trait configuration parameters. Deprecated: for backward compatibility. |
PlatformTrait
Appears on:
The platform trait is a base trait that is used to assign an integration platform to an integration.
In case the platform is missing, the trait is allowed to create a default platform. This feature is especially useful in contexts where there’s no need to provide a custom configuration for the platform (e.g. on OpenShift the default settings work, since there’s an embedded container image registry).
| Field | Description |
|---|---|
| (Members of |
| To create a default (empty) platform when the platform is missing. Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility |
| Indicates if the platform should be created globally in the case of global operator (default true). Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility |
| To automatically detect from the environment if a default platform can be created (it will be created on OpenShift or when a registry address is set). Deprecated: Platform is auto generated by the operator install procedure - maintained for backward compatibility |
PodTrait
Appears on:
The pod trait allows the customization of the Integration pods. It applies the PodSpecTemplate struct contained in the Integration .spec.podTemplate field, into the Integration deployment Pods template, using strategic merge patch.
This can be used to customize the container where Camel routes execute, by using the integration container name.
| Field | Description |
|---|---|
| (Members of |
PrometheusTrait
Appears on:
The Prometheus trait configures a Prometheus-compatible endpoint. It also creates a PodMonitor resource, so that the endpoint can be scraped automatically, when using the Prometheus operator.
The metrics are exposed using Micrometer Metrics.
The creation of the PodMonitor resource requires the Prometheus Operator custom resource definition to be installed. You can set pod-monitor to false for the Prometheus trait to work without the Prometheus Operator. |
| By default the metrics API is not available in JSON |
The Prometheus trait is disabled by default.
| Field | Description |
|---|---|
| (Members of |
| Whether a |
| The |
PullSecretTrait
Appears on:
The Pull Secret trait sets a pull secret on the pod, to allow Kubernetes to retrieve the container image from an external registry.
The pull secret can be specified manually or, in case you’ve configured authentication for an external container registry on the IntegrationPlatform, the same secret is used to pull images.
It’s enabled by default whenever you configure authentication for an external container registry, so it assumes that external registries are private.
If your registry does not need authentication for pulling images, you can disable this trait.
| Field | Description |
|---|---|
| (Members of |
| The pull secret name to set on the Pod. If left empty this is automatically taken from the |
| When using a global operator with a shared platform, this enables delegation of the |
| Automatically configures the platform registry secret on the pod if it is of type |
QuarkusPackageType(string alias)
Appears on:
QuarkusPackageType is the type of Quarkus build packaging. Deprecated: use QuarkusMode instead.
QuarkusTrait
Appears on:
The Quarkus trait configures the Quarkus runtime.
It’s enabled by default.
A native based compilation will be forced to use a pod build strategy. Compiling to a native executable, i.e. when using build-mode=native, requires at least 4GiB of memory, so the Pod running the native build, must have enough memory available. |
| Field | Description |
|---|---|
| (Members of |
| The Quarkus package types, |
| The Quarkus mode to run: either |
| The base image to use when running a native build (default |
| The image containing the tooling required for a native build (by default it will use the one provided in the runtime catalog) |
RawMessage([]byte alias)
Appears on:
RawMessage defines a binary type for configuration Deprecated: for backward compatibility.
RegistryTrait
Appears on:
| The Registry trait was deprecated in version 2.2.0 and is no longer active since version 2.5.0. |
The Registry trait sets up Maven to use the Image registry as a Maven repository.
| Field | Description |
|---|---|
| (Members of |
RouteTrait
Appears on:
The Route trait can be used to configure the creation of OpenShift routes for the integration.
The certificate and key contents may be sourced either from the local filesystem or in a OpenShift secret object. The user may use the parameters ending in -secret (example: tls-certificate-secret) to reference a certificate stored in a secret. Parameters ending in -secret have higher priorities and in case the same route parameter is set, for example: tls-key-secret and tls-key, then tls-key-secret is used. The recommended approach to set the key and certificates is to use secrets to store their contents and use the following parameters to reference them: tls-certificate-secret, tls-key-secret, tls-ca-certificate-secret, tls-destination-ca-certificate-secret See the examples section at the end of this page to see the setup options.
| Field | Description |
|---|---|
| (Members of |
| The annotations added to route. This can be used to set route specific annotations For annotations options see https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#route-specific-annotations CLI usage example: -t "route.annotations.'haproxy.router.openshift.io/balance'=true" |
| To configure the host exposed by the route. |
| The TLS termination type, like Refer to the OpenShift route documentation for additional information. |
| The TLS certificate contents. Refer to the OpenShift route documentation for additional information. |
| The secret name and key reference to the TLS certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/". Refer to the OpenShift route documentation for additional information. |
| The TLS certificate key contents. Refer to the OpenShift route documentation for additional information. |
| The secret name and key reference to the TLS certificate key. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/". Refer to the OpenShift route documentation for additional information. |
| The TLS CA certificate contents. Refer to the OpenShift route documentation for additional information. |
| The secret name and key reference to the TLS CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/". Refer to the OpenShift route documentation for additional information. |
| The destination CA certificate provides the contents of the ca certificate of the final destination. When using reencrypt termination this file should be provided in order to have routers use it for health checks on the secure connection. If this field is not specified, the router may provide its own destination CA and perform hostname validation using the short service name (service.namespace.svc), which allows infrastructure generated certificates to automatically verify. Refer to the OpenShift route documentation for additional information. |
| The secret name and key reference to the destination CA certificate. The format is "secret-name[/key-name]", the value represents the secret name, if there is only one key in the secret it will be read, otherwise you can set a key name separated with a "/". Refer to the OpenShift route documentation for additional information. |
| To configure how to deal with insecure traffic, e.g. Refer to the OpenShift route documentation for additional information. |
SecurityContextTrait
Appears on:
The Security Context trait can be used to configure the security setting of the Pod running the application.
| Field | Description |
|---|---|
| (Members of |
| Security Context RunAsUser configuration (default none): this value is automatically retrieved in Openshift clusters when not explicitly set. |
| Security Context RunAsNonRoot configuration (default false). |
| Security Context SeccompProfileType configuration (default RuntimeDefault). |
ServiceBindingTrait
Appears on:
The Service Binding trait allows users to connect to Services in Kubernetes: https://github.com/k8s-service-bindings/spec#service-binding As the specification is still evolving this is subject to change.
| Field | Description |
|---|---|
| (Members of |
| List of Services in the form [[apigroup/]version:]kind:[namespace/]name |
ServiceTrait
Appears on:
The Service trait exposes the integration with a Service resource so that it can be accessed by other applications (or integrations) in the same namespace.
| this trait is automatically disabled if the Knative Service trait is enabled. |
It’s enabled by default if the integration depends on a Camel component that can expose a HTTP endpoint.
| Field | Description |
|---|---|
| (Members of |
| To automatically detect from the code if a Service needs to be created. |
| Enable Service to be exposed as NodePort (default |
| The type of service to be used, either 'ClusterIP', 'NodePort' or 'LoadBalancer'. |
| The annotations added to the Service object. |
| The labels added to the Service object. |
TelemetryTrait
Appears on:
The Telemetry trait can be used to automatically publish tracing information to an OTLP compatible collector.
The trait is able to automatically discover the telemetry OTLP endpoint available in the namespace (supports Jaerger in version 1.35+).
The Telemetry trait is disabled by default.
| The Telemetry trait can’t be enabled at the same time as the Tracing trait. |
| Field | Description |
|---|---|
| (Members of |
| Enables automatic configuration of the trait, including automatic discovery of the telemetry endpoint. |
| The name of the service that publishes telemetry data (defaults to the integration name) |
| The target endpoint of the Telemetry service (automatically discovered by default) |
| The sampler of the telemetry used for tracing (default "on") |
| The sampler ratio of the telemetry used for tracing |
| The sampler of the telemetry used for tracing is parent based (default "true") |
TolerationTrait
Appears on:
This trait sets Tolerations over Integration pods. Tolerations allow (but do not require) the pods to schedule onto nodes with matching taints. See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ for more details.
The toleration should be expressed in a similar manner that of taints, i.e., Key[=Value]:Effect[:Seconds], where values in square brackets are optional.
For examples:
-
node-role.kubernetes.io/master:NoSchedule -
node.kubernetes.io/network-unavailable:NoExecute:3000 -
disktype=ssd:PreferNoSchedule
It’s disabled by default.
| Field | Description |
|---|---|
| (Members of |
| The list of taints to tolerate, in the form |
Trait
Appears on:
Trait is the base type for all traits. It could be disabled by the user.
| Field | Description |
|---|---|
| Can be used to enable or disable a trait. All traits share this common property. |
| Legacy trait configuration parameters. Deprecated: for backward compatibility. |