package
2.7.0-nightly
Repository: https://github.com/apache/camel-k.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package trait contains Trait API Schema definitions for the camel v1 API group +kubebuilder:object:generate=true +groupName=camel.apache.org.

# Functions

ConfigurationTasksByName returns the container configuration from the task list.
DecodeValueSource returns a ValueSource object from an input that respects the format configmap|secret:resource-name[/path].
FindBuilderTask returns the 1st builder task from the task list.
FromYamlDSL creates a slice of flows from a Camel YAML DSL stream.
FromYamlDSLString creates a slice of flows from a Camel YAML DSL string.
GetAnnotation safely get the annotation value.
GetIntegrationProfileAnnotation to safely get the integration profile annotation value.
GetIntegrationProfileNamespaceAnnotation to safely get the integration profile namespace annotation value.
GetOperatorIDAnnotation to safely get the operator id annotation value.
No description provided by the author
NewCamelCatalog --.
NewCamelCatalogList --.
NewCamelCatalogWithSpecs --.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewIntegrationPlatform --.
NewIntegrationPlatformList --.
NewIntegrationProfile --.
NewKamelet creates a new Kamelet.
NewKameletList creates a new list of Kamelets.
NewPipe --.
NewPipeList --.
No description provided by the author
RegisterDefaults adds defaulters functions to the given scheme.
Resource takes an unqualified resource and returns a Group qualified GroupResource.
SetAnnotation safely sets the annotation on the given runtime object.
SetBuilderConfigurationTasks set the configuration required for the builder in the list of tasks.
ToYamlDSL converts a flow into its Camel YAML DSL equivalent.
TraitProfileByName returns the trait profile corresponding to the given name (case insensitive).
No description provided by the author

# Constants

AnnotationIcon label used by icons.
BuildConditionReadyReason --.
BuildConditionScheduled --.
BuildConditionWaitingReason --.
BuildKind -- .
BuildOrderStrategyDependencies runs builds ordered by its required dependencies.
BuildOrderStrategyFIFO performs the builds with first in first out strategy based on the creation timestamp.
BuildOrderStrategySequential runs builds strictly sequential so that only one single build per operator namespace is running at a time.
BuildPhaseError -- .
BuildPhaseFailed -- .
BuildPhaseInitialization -- .
BuildPhaseInterrupted -- .
BuildPhaseNone -- .
BuildPhasePending -- .
BuildPhaseRunning -- .
BuildPhaseScheduling -- .
BuildPhaseSucceeded -- .
BuildStrategyPod performs the build in a `Pod` (will schedule a new builder `Pod` which will take care of the build action).
BuildStrategyRoutine performs the build in a routine (will be executed as a process inside the same Camel K operator `Pod`).
CamelCatalogConditionReady --.
CamelCatalogKind -- .
CamelCatalogPhaseError --.
CamelCatalogPhaseNone --.
CamelCatalogPhaseReady --.
CapabilityAwsSecretsManager defines the aws secrets manager capability.
CapabilityAzureKeyVault defines the azure key vault capability.
CapabilityCircuitBreaker defines the circuit breaker capability.
CapabilityCron defines the cron execution capability.
CapabilityGcpSecretManager defines the gcp secret manager capability.nolint:gosec.
CapabilityHashicorpVault defines the Hashicorp Vault capability.
CapabilityHealth defines the health monitoring capability.
CapabilityJolokia --.
CapabilityKnative --.
CapabilityMaster defines the master capability.
CapabilityPlatformHTTP defines the http service exposure capability.
CapabilityPrometheus --.
CapabilityRest defines the REST API service exposure capability.
CapabilityResumeKafka defines the resume capability.
CapabilityTelemetry defines the telemetry (opentelemetry) capability.
CapabilityTracing defines the tracing (opentracing) capability.
DefaultTraitProfile is the trait profile used as default when no other profile is set.
EndpointTypeAction action endpoint.
EndpointTypeErrorHandler error handler endpoint.
EndpointTypeSink sink endpoint.
EndpointTypeSource source endpoint.
ErrorHandlerTypeLog used to log the event producing the error.
ErrorHandlerTypeNone used to ignore any error event.
ErrorHandlerTypeSink used to send the event to a further sink (for future processing).
No description provided by the author
No description provided by the author
IntegrationConditionContainerNotAvailableReason --.
IntegrationConditionCronJobActiveReason --.
IntegrationConditionCronJobAvailable --.
IntegrationConditionCronJobAvailableReason --.
IntegrationConditionCronJobCreatedReason --.
IntegrationConditionCronJobNotAvailableReason --.
IntegrationConditionDeploymentAvailable --.
IntegrationConditionDeploymentAvailableReason --.
IntegrationConditionDeploymentNotAvailableReason --.
IntegrationConditionDeploymentProgressingReason --.
IntegrationConditionDeploymentReadyReason --.
IntegrationConditionErrorReason --.
IntegrationConditionExposureAvailable --.
IntegrationConditionImportingKindAvailableReason used (as false) if we're trying to import an unsupported kind.
IntegrationConditionIngressAvailableReason --.
IntegrationConditionIngressNotAvailableReason --.
IntegrationConditionInitializationFailedReason --.
IntegrationConditionJolokiaAvailable --.
IntegrationConditionJolokiaAvailableReason --.
IntegrationConditionKameletsAvailable --.
IntegrationConditionKameletsAvailableReason --.
IntegrationConditionKameletsNotAvailableReason --.
IntegrationConditionKitAvailable --.
IntegrationConditionKitAvailableReason --.
IntegrationConditionKnativeAvailable --.
IntegrationConditionKnativeNotInstalledReason --.
IntegrationConditionKnativeServiceAvailable --.
IntegrationConditionKnativeServiceAvailableReason --.
IntegrationConditionKnativeServiceNotAvailableReason --.
IntegrationConditionKnativeServiceReadyReason --.
IntegrationConditionLastJobFailedReason --.
IntegrationConditionLastJobSucceededReason --.
IntegrationConditionMonitoringPodsAvailableReason used to specify that the Pods generated are available for monitoring.
IntegrationConditionPlatformAvailable --.
IntegrationConditionPlatformAvailableReason --.
IntegrationConditionProbesAvailable --.
IntegrationConditionProbesAvailableReason --.
IntegrationConditionPrometheusAvailable --.
IntegrationConditionPrometheusAvailableReason --.
IntegrationConditionReady --.
IntegrationConditionRouteAvailableReason --.
IntegrationConditionRouteNotAvailableReason --.
IntegrationConditionRuntimeNotReadyReason --.
IntegrationConditionServiceAvailable --.
IntegrationConditionServiceAvailableReason --.
IntegrationConditionServiceNotAvailableReason --.
IntegrationConditionTraitInfo --.
IntegrationConditionUnsupportedLanguageReason --.
IntegrationFlowEmbeddedSourceName --.
IntegrationGenerationLabel is used to check on outdated integration resources that can be removed by garbage collection.
IntegrationImportedKindLabel specifies from what kind of resource an Integration was imported.
IntegrationImportedNameLabel specifies from what resource an Integration was imported.
IntegrationKind --.
IntegrationKitConditionCatalogAvailable --.
IntegrationKitConditionPlatformAvailable --.
IntegrationKitConditionPlatformAvailableReason --.
IntegrationKitConditionTraitInfo --.
IntegrationKitKind --.
No description provided by the author
IntegrationKitLayoutFastJar labels a kit using the Quarkus fast-jar packaging.
IntegrationKitLayoutLabel labels the kit layout.
IntegrationKitLayoutNative labels a kit using the Quarkus native packaging.
IntegrationKitLayoutNativeSources labels a kit using the Quarkus native-sources packaging.
IntegrationKitPhaseBuildRunning --.
IntegrationKitPhaseBuildSubmitted --.
IntegrationKitPhaseError --.
IntegrationKitPhaseInitialization --.
IntegrationKitPhaseNone --.
IntegrationKitPhaseReady --.
IntegrationKitPhaseWaitingForCatalog --.
IntegrationKitPhaseWaitingForPlatform --.
IntegrationKitPriorityLabel labels the kit priority.
IntegrationKitTypeExternal identifies a Kit created by any third party.
IntegrationKitTypeLabel labels the kit type.
IntegrationKitTypePlatform identifies a Kit created by the platform.
Deprecated: synthetic Integration Kits are replaced by non managed build Integrations.
IntegrationKitTypeUser identifies a Kit created by the user.
IntegrationLabel is used to tag k8s object created by a given Integration.
IntegrationPhaseBuildingKit --.
IntegrationPhaseDeploying --.
IntegrationPhaseError --.
IntegrationPhaseInitialization --.
IntegrationPhaseNone --.
IntegrationPhaseRunning --.
IntegrationPhaseUnknown --.
IntegrationPhaseWaitingForPlatform --.
IntegrationPlatformBuildPublishStrategyJib uses Jib maven plugin (https://github.com/GoogleContainerTools/jib) in order to push the incremental images to the image repository.
IntegrationPlatformBuildPublishStrategyJib uses the Source to Images (S2I) feature (https://docs.openshift.com/container-platform/4.9/openshift_images/create-images.html#images-create-s2i_create-images) provided by an OpenShift cluster in order to create and push the images to the registry.
IntegrationPlatformBuildPublishStrategySpectrum uses Spectrum project (https://github.com/container-tools/spectrum) in order to push the incremental images to the image repository.
IntegrationPlatformClusterKubernetes is used when targeting a Kubernetes cluster.
IntegrationPlatformClusterOpenShift is used when targeting an OpenShift cluster.
IntegrationPlatformConditionCamelCatalogAvailable is the condition for the availability of a the CamelCatalog.
IntegrationPlatformConditionCamelCatalogAvailableReason represents the reason that the IntegrationPlatform is created.
IntegrationPlatformConditionCreatedReason represents the reason that the IntegrationPlatform is created.
IntegrationPlatformConditionKameletCatalogAvailable is the condition for the availability of a Kamelet catalog.
IntegrationPlatformConditionMavenSettingsAvailable is the condition for the availability of a Maven settings configuration.
IntegrationPlatformConditionReady is the condition if the IntegrationPlatform is ready.
IntegrationPlatformConditionTypeCreated is the condition if the IntegrationPlatform has been created.
IntegrationPlatformConditionTypeRegistryAvailable is the condition for the availability of a container registry.
IntegrationPlatformConditionTypeRegistryAvailableReason represents the reason that the IntegrationPlatform Registry is available.
IntegrationPlatformKind is the Kind name of the IntegrationPlatform CR.
IntegrationPlatformPhaseCreateCatalog when the IntegrationPlatform creates a new CamelCatalog.
IntegrationPlatformPhaseCreating when the IntegrationPlatform is under creation process.
IntegrationPlatformPhaseError when the IntegrationPlatform had some error (see Conditions).
IntegrationPlatformPhaseNone when the IntegrationPlatform does not exist.
IntegrationPlatformPhaseReady when the IntegrationPlatform is ready.
IntegrationPlatformPhaseWarming when the IntegrationPlatform is warming (ie, creating Kaniko cache).
IntegrationProfileAnnotation integration profile id annotation label.
IntegrationProfileConditionCreatedReason represents the reason that the IntegrationProfile is created.
IntegrationProfileConditionTypeCreated is the condition if the IntegrationProfile has been created.
IntegrationProfileKind is the Kind name of the IntegrationProfile CR.
IntegrationProfileNamespaceAnnotation integration profile id annotation label.
IntegrationProfilePhaseError when the IntegrationProfile had some error (see Conditions).
IntegrationProfilePhaseNone when the IntegrationProfile does not exist.
IntegrationProfilePhaseReady when the IntegrationProfile is ready.
IntegrationSyntheticLabel is used to tag k8s synthetic Integrations.
KameletBundledLabel label used by bundling.
KameletConditionReady --.
KameletConditionReasonInvalidName --.
KameletConditionReasonInvalidProperty --.
KameletConditionReasonInvalidTemplate --.
KameletDataTypeLabel label used to override the default Kamelet action data type.
KameletGroupLabel label used to group Kamelets.
KameletKind --.
KameletPhaseError --.
KameletPhaseNone --.
KameletPhaseReady --.
KameletReadOnlyLabel label used to identify readonly Kamelets.
KameletTypeAction type Action.
KameletTypeLabel label used to identify Kamelet type.
KameletTypeSink type Sink.
KameletTypeSource type Source.
LanguageGroovy used for Groovy.
LanguageJavaScript used for Javascript.
LanguageJavaShell used for Java Shell.
LanguageJavaSource used for Java.
LanguageKamelet used for Kamelets.
LanguageKotlin used for Kotlin.
LanguageXML used for XML.
LanguageYaml used for YAML.
OperatorIDAnnotation operator id annotation label.
PipeConditionReady --.
PipeIntegrationConditionError -- .
PipeIntegrationDeprecationNotice -- .
PipeKind --.
PipePhaseCreating --.
PipePhaseError --.
PipePhaseNone --.
PipePhaseReady --.
PlatformSelectorAnnotation platform id annotation label.
RuntimeProviderPlainQuarkus Camel Quarkus plain runtime.
RuntimeProviderQuarkus Camel K runtime (Quarkus based).
ServiceTypeUser service user type label marker.
SourceTypeDefault is used to represent a source code.
SourceTypeErrorHandler is used to represent an error handler.
SourceTypeTemplate is used to represent a template.
TraitAnnotationPrefix represents the prefix used for traits annotations.
TraitProfileKnative is used by default on OpenShift/Kubernetes clusters powered by Knative.
TraitProfileKubernetes is used by default on Kubernetes clusters.
TraitProfileOpenShift is used by default on OpenShift clusters.
TypeSlotError is used for the error events.
TypeSlotIn is used for the input events.
TypeSlotOut is used for the output events.

# Variables

AddToScheme is a shortcut to SchemeBuilder.AddToScheme.
AllIntegrationPlatformClusters --.
AllTraitProfiles contains all allowed profiles.
BuildOrderStrategies is a list of order strategies allowed for the build.
BuildStrategies is a list of strategies allowed for the build.
IntegrationPlatformBuildPublishStrategies the list of all available publish strategies.
KameletIDProperty used to identify.
KameletVersionProperty used to specify the version to use.
Languages is the list of all supported languages.
No description provided by the author
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeGroupVersion is group version used to register these objects.

# Structs

AddonTrait represents the configuration of an addon trait.
Args -- .
Artifact represents a materialized artifact (a jar dependency or in general a file used by the build).
BaseTask is a base for the struct hierarchy.
BeanProperties represent an unstructured object properties to be set on a bean.
Build is the Schema for the builds API.
BuildahTask is used to configure Buildah.
BuildCondition describes the state of a resource at a certain point.
BuildConfiguration represent the configuration required to build the runtime.
BuilderTask is the generic task in charge of building the application image.
BuildList contains a list of Build.
BuildSpec defines the list of tasks to be execute for a Build.
BuildStatus defines the observed state of Build.
CamelArtifact represent the configuration for a feature offered by Camel.
CamelArtifactDependency represent a maven's dependency.
CamelArtifactExclusion represents an exclusion clause.
CamelCatalog represents the languages, components, data formats and capabilities enabled on a given runtime provider.
CamelCatalogCondition describes the state of a resource at a certain point.
CamelCatalogList contains a list of CamelCatalog.
CamelCatalogSpec specify what features a Camel runtime provides.
CamelCatalogStatus defines the observed state of CamelCatalog.
CamelLoader represents the configuration required to load a DSL.
CamelProperty represents a Camel property that may end up in an application.properties file.
CamelScheme represents the scheme used to identify a component in a URI (ie, timer in a timer:xyz endpoint URI).
CamelSchemeScope contains scoped information about a scheme.
Capability is a particular feature which requires a well known set of dependencies and other properties which are specified in the runtime catalog.
Catalog represents the Camel Catalog runtime specification.
ConfigurationSpec represents a generic configuration specification.
Container -- .
DataSpec represents the way the source is materialized in the running `Pod`.
DataTypeReference references to the specification of a data type by its scheme and format name.
DataTypeSpec represents the specification for a data type.
DataTypesSpec represents the specification for a set of data types.
Endpoint represents a source/sink external entity (could be any Kubernetes resource or Camel URI).
EndpointProperties is a key/value struct represented as JSON raw to allow numeric/boolean values.
ErrorHandlerLog represent a default (log) error handler type.
ErrorHandlerNone --.
ErrorHandlerParameters represent an unstructured object for error handler parameters.
ErrorHandlerSink represents a sink error handler type which behave like a dead letter channel.
ErrorHandlerSpec represents an unstructured object for an error handler.
EventTypeSpec represents a specification for an event type.
ExternalDocumentation allows referencing an external resource for extended documentation.
ExtraDirectories -- .
Failure represent a message specifying the reason and the time of an event failure.
FailureRecovery defines the attempts to recover a failure.
Filter -- .
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL.
HeaderSpec represents the specification for a header used in the Kamelet.
No description provided by the author
No description provided by the author
Integration is the Schema for the integrations API.
IntegrationCondition describes the state of a resource at a certain point.
IntegrationKit defines a container image and additional configuration needed to run an `Integration`.
IntegrationKitCondition describes the state of a resource at a certain point.
IntegrationKitList contains a list of IntegrationKit.
IntegrationKitSpec defines a container image and additional configurations required to kick off an `Integration` with certain features.
IntegrationKitStatus defines the observed state of IntegrationKit.
IntegrationKitTraits defines traits assigned to an `IntegrationKit`.
IntegrationList contains a list of Integration.
IntegrationPlatform is the resource used to drive the Camel K operator behavior.
IntegrationPlatformBuildSpec contains platform related build information.
IntegrationPlatformCondition describes the state of a resource at a certain point.
IntegrationPlatformKameletSpec define the behavior for all the Kamelets controller by the IntegrationPlatform.
IntegrationPlatformList contains a list of IntegrationPlatform.
IntegrationPlatformSpec defines the desired state of IntegrationPlatform.
IntegrationPlatformStatus defines the observed state of IntegrationPlatform.
IntegrationProfile is the resource used to apply user defined settings to the Camel K operator behavior.
IntegrationProfileBuildSpec contains profile related build information.
IntegrationProfileCondition describes the state of a resource at a certain point.
IntegrationProfileKameletSpec define the behavior for all the Kamelets controller by the IntegrationProfile.
IntegrationProfileList contains a list of IntegrationProfile.
IntegrationProfileSpec applies user defined settings to the IntegrationProfile.
IntegrationProfileStatus defines the observed state of IntegrationProfile.
IntegrationSpec specifies the configuration of an Integration.
IntegrationStatus defines the observed state of Integration.
JibTask is used to configure Jib.
+kubebuilder:validation:Type="" JSON represents any valid JSON value.
No description provided by the author
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
Kamelet is the Schema for the kamelets API.
KameletCondition describes the state of a resource at a certain point.
KameletList contains a list of Kamelet.
KameletProperty specify the behavior of a property in a Kamelet.
KameletRepositorySpec defines the location of the Kamelet catalog to use.
KameletSpec specifies the configuration required to execute a Kamelet.
KameletSpecBase specifies the base configuration of a Kamelet.
KameletStatus defines the observed state of Kamelet.
KanikoTask is used to configure Kaniko.
KanikoTaskCache is used to configure Kaniko cache.
MavenArtifact defines a GAV (Group:Artifact:Type:Version:Classifier) Maven artifact.
MavenBuildSpec defines the Maven configuration plus additional repositories to use.
MavenSpec --.
Path -- .
Permission -- .
Pipe is the Schema for the Pipe API.
PipeCondition describes the state of a resource at a certain point.
PipeList contains a list of Pipe.
PipeSpec defines the binding between a source and a sink.
PipeStatus specify the status of a Pipe.
PluginConfiguration see link:https://maven.apache.org/settings.html[Maven settings].
PluginExtension -- .
PluginExtensionConfiguration -- .
PluginExtensions -- .
No description provided by the author
PodSpec defines a group of Kubernetes resources.
PodSpecTemplate represent a template used to deploy an Integration `Pod`.
PublishTask image publish configuration.
RegistrySpec provides the configuration for the container registry.
Repository defines a Maven repository.
RepositoryPolicy defines the policy associated to a Maven repository.
RuntimeSpec represents the configuration for the Java runtime in charge to execute the Camel application.
S2iTask is used to configure S2I.
Server see link:https://maven.apache.org/settings.html[Maven settings].
SourceSpec defines the configuration for one or more routes to be executed in a certain Camel DSL language.
SpectrumTask is used to configure Spectrum.
StringOrProperties -- .
Task represents the abstract task.
Template is an unstructured object representing a Kamelet template in YAML/JSON DSL.
TraitConfiguration represents the expected configuration for a given trait parameter Deprecated: superceded by each Trait type, left for backward compatibility.
Traits represents the collection of trait configurations.
A TraitSpec contains the configuration of a trait Deprecated: superceded by each Trait type, left for backward compatibility.
UserTask is used to execute any generic custom operation.
ValueSource --.

# Interfaces

Configurable --.
ErrorHandler is a generic interface that represent any type of error handler specification.
ResourceCondition is a common type for all conditions.

# Type aliases

BuildConditionType -- .
BuildOrderStrategy specifies how builds are reconciled and queued.
BuildPhase -- .
BuildStrategy specifies how the Build should be executed.
CamelCatalogConditionType --.
CamelCatalogPhase -- .
EndpointType represents the type (ie, source or sink).
ErrorHandlerType a type of error handler (ie, sink).
No description provided by the author
IntegrationConditionType --.
IntegrationKitConditionType --.
IntegrationKitPhase --.
IntegrationPhase --.
IntegrationPlatformBuildPublishStrategy defines the strategy used to package and publish an Integration base image.
IntegrationPlatformCluster is the kind of orchestration cluster the platform is installed into.
IntegrationPlatformConditionType defines the type of condition.
IntegrationPlatformPhase is the phase of an IntegrationPlatform.
IntegrationProfileConditionType defines the type of condition.
IntegrationProfilePhase is the phase of an IntegrationProfile.
JSONSchemaURL represents a schema url.
KameletConditionType --.
KameletPhase --.
Language represents a supported language (Camel DSL).
PipeConditionType --.
PipePhase --.
PluginProperties -- .
Properties -- .
RawMessage is a raw encoded JSON value.
RuntimeProvider is the provider chosen for the runtime.
SourceType represents an available source type.
TraitProfile represents lists of traits that are enabled for the specific installation/integration.
TypeSlot represent a kind of data (ie, input, output, ...).