Camel K API
Packages:
camel.apache.org/v1
Package v1 contains API Schema definitions for the camel v1 API group
Build
Build is the Schema for the builds API
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1
|
||||
kind
string
|
Build |
||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specBuildSpec |
|
||||
statusBuildStatus |
CamelCatalog
CamelCatalog is the Schema for the camelcatalogs API
| Field | Description |
|---|---|
apiVersion
string |
camel.apache.org/v1
|
kind
string
|
CamelCatalog |
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
statusCamelCatalogStatus |
|
specCamelCatalogSpec |
|
Integration
Integration is the Schema for the integrations API
| Field | Description | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1
|
||||||||||||||||||||||||||
kind
string
|
Integration |
||||||||||||||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
specIntegrationSpec |
|
||||||||||||||||||||||||||
statusIntegrationStatus |
IntegrationKit
IntegrationKit is the Schema for the integrationkits API
| Field | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1
|
||||||||||||
kind
string
|
IntegrationKit |
||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
specIntegrationKitSpec |
|
||||||||||||
statusIntegrationKitStatus |
IntegrationPlatform
IntegrationPlatform is the Schema for the integrationplatforms API
| Field | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1
|
||||||||||||||
kind
string
|
IntegrationPlatform |
||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
specIntegrationPlatformSpec |
|
||||||||||||||
statusIntegrationPlatformStatus |
Artifact
(Appears on: BuildStatus, IntegrationKitStatus)
Artifact –
| Field | Description |
|---|---|
idstring |
|
locationstring |
|
targetstring |
|
checksumstring |
BaseTask
(Appears on: BuildahTask, BuilderTask, KanikoTask, S2iTask, SpectrumTask)
BaseTask –
| Field | Description |
|---|---|
namestring |
BuildCondition
(Appears on: BuildStatus)
BuildCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeBuildConditionType |
Type of integration condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
BuildConditionType
(string alias)
(Appears on: BuildCondition)
BuildConditionType –
BuildPhase
(string alias)
(Appears on: BuildStatus)
BuildPhase –
BuildSpec
(Appears on: Build)
BuildSpec defines the Build to be executed
| Field | Description |
|---|---|
tasks[]Task |
|
timeoutKubernetes meta/v1.Duration |
Timeout defines the Build maximum execution duration. The Build deadline is set to the Build start time plus the Timeout duration. If the Build deadline is exceeded, the Build context is canceled, and its phase set to BuildPhaseFailed. |
BuildStatus
(Appears on: Build)
BuildStatus defines the observed state of Build
| Field | Description |
|---|---|
phaseBuildPhase |
|
imagestring |
|
digeststring |
|
baseImagestring |
|
artifacts[]Artifact |
|
errorstring |
|
failureFailure |
|
startedAtKubernetes meta/v1.Time |
|
platformstring |
|
conditions[]BuildCondition |
|
durationstring |
Change to Duration / ISO 8601 when CRD uses OpenAPI spec v3 https://github.com/OAI/OpenAPI-Specification/issues/845 |
BuildahTask
(Appears on: Task)
BuildahTask –
| Field | Description |
|---|---|
BaseTaskBaseTask |
(Members of |
PublishTaskPublishTask |
(Members of |
verbosebool |
|
httpProxySecretstring |
BuilderTask
(Appears on: Task)
BuilderTask –
| Field | Description |
|---|---|
BaseTaskBaseTask |
(Members of |
baseImagestring |
|
runtimeRuntimeSpec |
|
sources[]SourceSpec |
|
resources[]ResourceSpec |
|
dependencies[]string |
|
steps[]string |
|
mavenMavenSpec |
|
buildDirstring |
CamelArtifact
(Appears on: CamelCatalogSpec)
CamelArtifact –
| Field | Description |
|---|---|
CamelArtifactDependencyCamelArtifactDependency |
(Members of |
schemes[]CamelScheme |
|
languages[]string |
|
dataformats[]string |
|
dependencies[]CamelArtifactDependency |
|
javaTypes[]string |
CamelArtifactDependency
(Appears on: CamelArtifact, CamelSchemeScope)
CamelArtifactDependency represent a maven’s dependency
| Field | Description |
|---|---|
MavenArtifactMavenArtifact |
(Members of |
exclusions[]CamelArtifactExclusion |
CamelArtifactExclusion
(Appears on: CamelArtifactDependency)
CamelArtifactExclusion –
| Field | Description |
|---|---|
groupIdstring |
|
artifactIdstring |
CamelCatalogSpec
(Appears on: CamelCatalog)
CamelCatalogSpec defines the desired state of CamelCatalog
| Field | Description |
|---|---|
runtimeRuntimeSpec |
|
artifactsmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelArtifact |
|
loadersmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.CamelLoader |
CamelCatalogStatus
(Appears on: CamelCatalog)
CamelCatalogStatus defines the observed state of CamelCatalog
CamelLoader
(Appears on: CamelCatalogSpec)
CamelLoader –
| Field | Description |
|---|---|
MavenArtifactMavenArtifact |
(Members of |
languages[]string |
|
dependencies[]MavenArtifact |
CamelScheme
(Appears on: CamelArtifact)
CamelScheme –
| Field | Description |
|---|---|
idstring |
|
passivebool |
|
httpbool |
|
consumerCamelSchemeScope |
|
producerCamelSchemeScope |
CamelSchemeScope
(Appears on: CamelScheme)
CamelSchemeScope contains scoped information about a scheme
| Field | Description |
|---|---|
dependencies[]CamelArtifactDependency |
Capability
(Appears on: RuntimeSpec)
Capability –
| Field | Description |
|---|---|
dependencies[]MavenArtifact |
|
metadatamap[string]string |
Configurable
Configurable –
ConfigurationSpec
(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec, IntegrationStatus)
ConfigurationSpec –
| Field | Description |
|---|---|
typestring |
|
valuestring |
|
resourceTypestring |
|
resourceMountPointstring |
|
resourceKeystring |
DataSpec
(Appears on: ResourceSpec, SourceSpec)
DataSpec –
| Field | Description |
|---|---|
namestring |
|
pathstring |
|
contentstring |
|
rawContent[]byte |
|
contentRefstring |
|
contentKeystring |
|
contentTypestring |
|
compressionbool |
Failure
(Appears on: BuildStatus, IntegrationKitStatus)
Failure –
| Field | Description |
|---|---|
reasonstring |
|
timeKubernetes meta/v1.Time |
|
recoveryFailureRecovery |
FailureRecovery
(Appears on: Failure)
FailureRecovery –
| Field | Description |
|---|---|
attemptint |
|
attemptMaxint |
|
attemptTimeKubernetes meta/v1.Time |
(Optional) |
Flow
(Appears on: IntegrationSpec, KameletSpec)
Flow is an unstructured object representing a Camel Flow in YAML/JSON DSL
| Field | Description |
|---|---|
RawMessageRawMessage |
(Members of |
IntegrationCondition
(Appears on: IntegrationStatus)
IntegrationCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeIntegrationConditionType |
Type of integration condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
firstTruthyTimeKubernetes meta/v1.Time |
First time the condition status transitioned to True. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
IntegrationConditionType
(string alias)
(Appears on: IntegrationCondition)
IntegrationConditionType –
IntegrationKitCondition
(Appears on: IntegrationKitStatus)
IntegrationKitCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeIntegrationKitConditionType |
Type of integration condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
IntegrationKitConditionType
(string alias)
(Appears on: IntegrationKitCondition)
IntegrationKitConditionType –
IntegrationKitPhase
(string alias)
(Appears on: IntegrationKitStatus)
IntegrationKitPhase –
IntegrationKitSpec
(Appears on: IntegrationKit)
IntegrationKitSpec defines the desired state of IntegrationKit
| Field | Description |
|---|---|
imagestring |
|
dependencies[]string |
|
profileTraitProfile |
|
traitsmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec |
|
configuration[]ConfigurationSpec |
|
repositories[]string |
IntegrationKitStatus
(Appears on: IntegrationKit)
IntegrationKitStatus defines the observed state of IntegrationKit
| Field | Description |
|---|---|
phaseIntegrationKitPhase |
|
baseImagestring |
|
imagestring |
|
digeststring |
|
artifacts[]Artifact |
|
failureFailure |
|
runtimeVersionstring |
|
runtimeProviderRuntimeProvider |
|
platformstring |
|
conditions[]IntegrationKitCondition |
|
versionstring |
IntegrationPhase
(string alias)
(Appears on: IntegrationStatus)
IntegrationPhase –
IntegrationPlatformBuildPublishStrategy
(string alias)
(Appears on: IntegrationPlatformBuildSpec)
IntegrationPlatformBuildPublishStrategy enumerates all implemented publish strategies
IntegrationPlatformBuildSpec
(Appears on: IntegrationPlatformSpec)
IntegrationPlatformBuildSpec contains platform related build information
| Field | Description |
|---|---|
buildStrategyIntegrationPlatformBuildStrategy |
|
publishStrategyIntegrationPlatformBuildPublishStrategy |
|
runtimeVersionstring |
|
runtimeProviderRuntimeProvider |
|
baseImagestring |
|
registryIntegrationPlatformRegistrySpec |
|
timeoutKubernetes meta/v1.Duration |
|
persistentVolumeClaimstring |
|
mavenMavenSpec |
|
httpProxySecretstring |
|
kanikoBuildCachebool |
IntegrationPlatformBuildStrategy
(string alias)
(Appears on: IntegrationPlatformBuildSpec)
IntegrationPlatformBuildStrategy enumerates all implemented build strategies
IntegrationPlatformCluster
(string alias)
(Appears on: IntegrationPlatformSpec)
IntegrationPlatformCluster is the kind of orchestration cluster the platform is installed into
IntegrationPlatformCondition
(Appears on: IntegrationPlatformStatus)
IntegrationPlatformCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeIntegrationPlatformConditionType |
Type of integration condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
IntegrationPlatformConditionType
(string alias)
(Appears on: IntegrationPlatformCondition)
IntegrationPlatformConditionType –
IntegrationPlatformKameletRepositorySpec
(Appears on: IntegrationPlatformKameletSpec)
IntegrationPlatformKameletRepositorySpec –
| Field | Description |
|---|---|
uristring |
IntegrationPlatformKameletSpec
(Appears on: IntegrationPlatformSpec)
IntegrationPlatformKameletSpec –
| Field | Description |
|---|---|
repositories[]IntegrationPlatformKameletRepositorySpec |
IntegrationPlatformPhase
(string alias)
(Appears on: IntegrationPlatformStatus)
IntegrationPlatformPhase –
IntegrationPlatformRegistrySpec
(Appears on: IntegrationPlatformBuildSpec, PublishTask)
IntegrationPlatformRegistrySpec –
| Field | Description |
|---|---|
insecurebool |
|
addressstring |
|
secretstring |
|
castring |
|
organizationstring |
IntegrationPlatformResourcesSpec
(Appears on: IntegrationPlatformSpec)
IntegrationPlatformResourcesSpec contains platform related resources
IntegrationPlatformSpec
(Appears on: IntegrationPlatform, IntegrationPlatformStatus)
IntegrationPlatformSpec defines the desired state of IntegrationPlatform
| Field | Description |
|---|---|
clusterIntegrationPlatformCluster |
|
profileTraitProfile |
|
buildIntegrationPlatformBuildSpec |
|
resourcesIntegrationPlatformResourcesSpec |
|
traitsmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec |
|
configuration[]ConfigurationSpec |
|
kameletIntegrationPlatformKameletSpec |
IntegrationPlatformStatus
(Appears on: IntegrationPlatform)
IntegrationPlatformStatus defines the observed state of IntegrationPlatform
| Field | Description |
|---|---|
IntegrationPlatformSpecIntegrationPlatformSpec |
(Members of |
phaseIntegrationPlatformPhase |
|
conditions[]IntegrationPlatformCondition |
|
versionstring |
IntegrationSpec
(Appears on: Integration, KameletBindingSpec)
IntegrationSpec defines the desired state of Integration
| Field | Description |
|---|---|
replicasint32 |
|
sources[]SourceSpec |
|
flows[]Flow |
|
resources[]ResourceSpec |
|
kitstring |
Deprecated: use the IntegrationKit field |
integrationKitKubernetes core/v1.ObjectReference |
|
dependencies[]string |
|
profileTraitProfile |
|
traitsmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.TraitSpec |
|
templatePodSpecTemplate |
|
configuration[]ConfigurationSpec |
|
repositories[]string |
|
serviceAccountNamestring |
IntegrationStatus
(Appears on: Integration)
IntegrationStatus defines the observed state of Integration
| Field | Description |
|---|---|
phaseIntegrationPhase |
|
digeststring |
|
imagestring |
|
dependencies[]string |
|
profileTraitProfile |
|
kitstring |
Deprecated: use the IntegrationKit field |
integrationKitKubernetes core/v1.ObjectReference |
|
platformstring |
|
generatedSources[]SourceSpec |
|
generatedResources[]ResourceSpec |
|
runtimeVersionstring |
|
runtimeProviderRuntimeProvider |
|
configuration[]ConfigurationSpec |
|
conditions[]IntegrationCondition |
|
versionstring |
|
replicasint32 |
|
selectorstring |
|
capabilities[]string |
|
lastInitTimestampKubernetes meta/v1.Time |
The timestamp representing the last time when this integration was initialized. |
KanikoTask
(Appears on: Task)
KanikoTask –
| Field | Description |
|---|---|
BaseTaskBaseTask |
(Members of |
PublishTaskPublishTask |
(Members of |
verbosebool |
|
httpProxySecretstring |
|
cacheKanikoTaskCache |
KanikoTaskCache
(Appears on: KanikoTask)
KanikoTaskCache –
| Field | Description |
|---|---|
enabledbool |
|
persistentVolumeClaimstring |
Language
(string alias)
(Appears on: SourceSpec)
Language –
MavenArtifact
(Appears on: CamelArtifactDependency, CamelLoader, Capability, MavenSpec, RuntimeSpec)
MavenArtifact –
| Field | Description |
|---|---|
groupIdstring |
|
artifactIdstring |
|
versionstring |
MavenSpec
(Appears on: BuilderTask, IntegrationPlatformBuildSpec)
MavenSpec –
| Field | Description |
|---|---|
localRepositorystring |
The path of the local Maven repository. |
propertiesmap[string]string |
The Maven properties. |
settingsValueSource |
A reference to the ConfigMap or Secret key that contains the Maven settings. |
caSecretKubernetes core/v1.SecretKeySelector |
The Secret name and key, containing the CA certificate(s) used to connect to remote Maven repositories. It can contain X.509 certificates, and PKCS#7 formatted certificate chains. A JKS formatted keystore is automatically created to store the CA certificate(s), and configured to be used as a trusted certificate(s) by the Maven commands. Note that the root CA certificates are also imported into the created keystore. |
timeoutKubernetes meta/v1.Duration |
Deprecated: use IntegrationPlatform.Spec.Build.Timeout instead |
repositories[]Repository |
|
extension[]MavenArtifact |
Maven build extensions https://maven.apache.org/guides/mini/guide-using-extensions.html |
PlatformInjectable
PlatformInjectable –
PodSpec
(Appears on: PodSpecTemplate)
| Field | Description |
|---|---|
volumes[]Kubernetes core/v1.Volume |
|
initContainers[]Kubernetes core/v1.Container |
|
containers[]Kubernetes core/v1.Container |
|
ephemeralContainers[]Kubernetes core/v1.EphemeralContainer |
|
restartPolicyKubernetes core/v1.RestartPolicy |
|
terminationGracePeriodSecondsint64 |
|
activeDeadlineSecondsint64 |
|
dnsPolicyKubernetes core/v1.DNSPolicy |
|
nodeSelectormap[string]string |
|
topologySpreadConstraints[]Kubernetes core/v1.TopologySpreadConstraint |
PodSpecTemplate
(Appears on: IntegrationSpec)
| Field | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
specPodSpec |
|
PublishTask
(Appears on: BuildahTask, KanikoTask, SpectrumTask)
PublishTask –
| Field | Description |
|---|---|
contextDirstring |
|
baseImagestring |
|
imagestring |
|
registryIntegrationPlatformRegistrySpec |
RawMessage
([]byte alias)
(Appears on: BeanProperties, EndpointProperties, ErrorHandlerParameters, ErrorHandlerRef, ErrorHandlerSpec, Flow, Template, TraitConfiguration)
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.
Repository
(Appears on: MavenSpec)
Repository –
| Field | Description |
|---|---|
idstring |
|
namestring |
|
urlstring |
|
snapshotsRepositoryPolicy |
|
releasesRepositoryPolicy |
RepositoryPolicy
(Appears on: Repository)
RepositoryPolicy –
| Field | Description |
|---|---|
enabledbool |
|
updatePolicystring |
|
checksumPolicystring |
ResourceCondition
ResourceCondition is a common type for all conditions
ResourceSpec
(Appears on: BuilderTask, IntegrationSpec, IntegrationStatus)
ResourceSpec –
| Field | Description |
|---|---|
DataSpecDataSpec |
(Members of |
typeResourceType |
|
mountPathstring |
ResourceType
(string alias)
(Appears on: ResourceSpec)
ResourceType –
RuntimeProvider
(string alias)
(Appears on: IntegrationKitStatus, IntegrationPlatformBuildSpec, IntegrationStatus, RuntimeSpec)
RuntimeProvider –
RuntimeSpec
(Appears on: BuilderTask, CamelCatalogSpec)
RuntimeSpec –
| Field | Description |
|---|---|
versionstring |
|
providerRuntimeProvider |
|
applicationClassstring |
|
dependencies[]MavenArtifact |
|
metadatamap[string]string |
|
capabilitiesmap[string]github.com/apache/camel-k/pkg/apis/camel/v1.Capability |
S2iTask
(Appears on: Task)
S2iTask –
| Field | Description |
|---|---|
BaseTaskBaseTask |
(Members of |
contextDirstring |
|
tagstring |
SourceSpec
(Appears on: BuilderTask, IntegrationSpec, IntegrationStatus, KameletSpec)
SourceSpec –
| Field | Description |
|---|---|
DataSpecDataSpec |
(Members of |
languageLanguage |
|
loaderstring |
Loader is an optional id of the org.apache.camel.k.RoutesLoader that will interpret this source at runtime |
interceptors[]string |
Interceptors are optional identifiers the org.apache.camel.k.RoutesLoader uses to pre/post process sources |
typeSourceType |
Type defines the kind of source described by this object |
property-names[]string |
List of property names defined in the source (e.g. if type is “template”) |
SourceType
(string alias)
(Appears on: SourceSpec)
SpectrumTask
(Appears on: Task)
SpectrumTask –
| Field | Description |
|---|---|
BaseTaskBaseTask |
(Members of |
PublishTaskPublishTask |
(Members of |
Task
(Appears on: BuildSpec)
Task –
| Field | Description |
|---|---|
builderBuilderTask |
|
buildahBuildahTask |
|
kanikoKanikoTask |
|
spectrumSpectrumTask |
|
s2iS2iTask |
Template
(Appears on: KameletSpec)
Template is an unstructured object representing a Kamelet template in YAML/JSON DSL
| Field | Description |
|---|---|
RawMessageRawMessage |
(Members of |
TraitConfiguration
(Appears on: TraitSpec)
| Field | Description |
|---|---|
RawMessageRawMessage |
(Members of |
TraitProfile
(string alias)
(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec, IntegrationStatus)
TraitProfile represents lists of traits that are enabled for the specific installation/integration
TraitSpec
(Appears on: IntegrationKitSpec, IntegrationPlatformSpec, IntegrationSpec)
A TraitSpec contains the configuration of a trait
| Field | Description |
|---|---|
configurationTraitConfiguration |
TraitConfiguration – |
ValueSource
(Appears on: MavenSpec)
ValueSource –
| Field | Description |
|---|---|
configMapKeyRefKubernetes core/v1.ConfigMapKeySelector |
Selects a key of a ConfigMap. |
secretKeyRefKubernetes core/v1.SecretKeySelector |
Selects a key of a secret. |
camel.apache.org/v1alpha1
Package v1alpha1 contains API Schema definitions for the camel v1alpha1 API group
Kamelet
Kamelet is the Schema for the kamelets API
| Field | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1alpha1
|
||||||||||||||
kind
string
|
Kamelet |
||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
specKameletSpec |
|
||||||||||||||
statusKameletStatus |
KameletBinding
KameletBinding is the Schema for the kamelets binding API
| Field | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion
string |
camel.apache.org/v1alpha1
|
||||||||||||
kind
string
|
KameletBinding |
||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
specKameletBindingSpec |
|
||||||||||||
statusKameletBindingStatus |
AuthorizationSpec
(Appears on: KameletSpec)
AuthorizationSpec is TODO (oauth information)
BeanProperties
(Appears on: ErrorHandlerBean)
BeanProperties represent an unstructured object properties to be set on a bean
| Field | Description |
|---|---|
RawMessageRawMessage |
Endpoint
(Appears on: ErrorHandlerDeadLetterChannel, KameletBindingSpec)
Endpoint represents a source/sink external entity
| Field | Description |
|---|---|
refKubernetes core/v1.ObjectReference |
Ref can be used to declare a Kubernetes resource as source/sink endpoint |
uristring |
URI can alternatively be used to specify the (Camel) endpoint explicitly |
propertiesEndpointProperties |
Properties are a key value representation of endpoint properties |
typesmap[github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventSlot]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventTypeSpec |
Types defines the schema of the data produced/consumed by the endpoint |
EndpointProperties
(Appears on: Endpoint)
EndpointProperties is a key/value struct represented as JSON raw to allow numeric/boolean values
| Field | Description |
|---|---|
RawMessageRawMessage |
(Members of |
EndpointType
(string alias)
ErrorHandler
ErrorHandler is a generic interface that represent any type of error handler specification
ErrorHandlerBean
ErrorHandlerBean represents a bean error handler type
| Field | Description |
|---|---|
ErrorHandlerNoneErrorHandlerNone |
|
typestring |
|
propertiesBeanProperties |
ErrorHandlerDeadLetterChannel
ErrorHandlerDeadLetterChannel represents a dead letter channel error handler type
| Field | Description |
|---|---|
ErrorHandlerLogErrorHandlerLog |
|
endpointEndpoint |
ErrorHandlerLog
(Appears on: ErrorHandlerDeadLetterChannel)
ErrorHandlerLog represent a default (log) error handler type
| Field | Description |
|---|---|
ErrorHandlerNoneErrorHandlerNone |
|
parametersErrorHandlerParameters |
ErrorHandlerNone
(Appears on: ErrorHandlerBean, ErrorHandlerLog)
ErrorHandlerNone –
| Field | Description |
|---|
ErrorHandlerParameters
(Appears on: ErrorHandlerLog)
ErrorHandlerParameters represent an unstructured object for error handler parameters
| Field | Description |
|---|---|
RawMessageRawMessage |
ErrorHandlerRef
ErrorHandlerRef represents a reference to an error handler builder available in the registry
| Field | Description |
|---|---|
RawMessageRawMessage |
ErrorHandlerSpec
(Appears on: KameletBindingSpec)
ErrorHandlerSpec represents an unstructured object for an error handler
| Field | Description |
|---|---|
RawMessageRawMessage |
ErrorHandlerType
(string alias)
ErrorHandlerType –
EventSlot
(string alias)
EventTypeSpec
(Appears on: Endpoint, KameletSpec)
| Field | Description |
|---|---|
mediaTypestring |
|
schemaJSONSchemaProps |
ExternalDocumentation
(Appears on: JSONSchemaProps)
ExternalDocumentation allows referencing an external resource for extended documentation.
| Field | Description |
|---|---|
descriptionstring |
|
urlstring |
JSON
(Appears on: JSONSchemaProp, JSONSchemaProps)
JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
| Field | Description |
|---|---|
RawMessageRawMessage |
(Members of |
JSONSchemaProp
(Appears on: JSONSchemaProps)
| Field | Description |
|---|---|
idstring |
|
descriptionstring |
|
typestring |
|
formatstring |
format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:
|
titlestring |
|
defaultJSON |
default is a default value for undefined object fields. |
maximumencoding/json.Number |
|
exclusiveMaximumbool |
|
minimumencoding/json.Number |
|
exclusiveMinimumbool |
|
maxLengthint64 |
|
minLengthint64 |
|
patternstring |
|
maxItemsint64 |
|
minItemsint64 |
|
uniqueItemsbool |
|
maxPropertiesint64 |
|
minPropertiesint64 |
|
multipleOfencoding/json.Number |
|
enum[]JSON |
|
exampleJSON |
|
nullablebool |
|
x-descriptors[]string |
The list of descriptors that determine which UI components to use on different views |
JSONSchemaProps
(Appears on: EventTypeSpec, KameletSpec)
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
| Field | Description |
|---|---|
idstring |
|
descriptionstring |
|
titlestring |
|
propertiesmap[string]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.JSONSchemaProp |
|
required[]string |
|
exampleJSON |
|
externalDocsExternalDocumentation |
|
$schemaJSONSchemaURL |
|
typestring |
JSONSchemaURL
(string alias)
(Appears on: JSONSchemaProps)
JSONSchemaURL represents a schema url.
KameletBindingCondition
(Appears on: KameletBindingStatus)
KameletBindingCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeKameletBindingConditionType |
Type of kameletBinding condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
KameletBindingConditionType
(string alias)
(Appears on: KameletBindingCondition)
KameletBindingPhase
(string alias)
(Appears on: KameletBindingStatus)
KameletBindingSpec
(Appears on: KameletBinding)
KameletBindingSpec –
| Field | Description |
|---|---|
integrationIntegrationSpec |
Integration is an optional integration used to specify custom parameters |
sourceEndpoint |
Source is the starting point of the integration defined by this binding |
sinkEndpoint |
Sink is the destination of the integration defined by this binding |
errorHandlerErrorHandlerSpec |
ErrorHandler is an optional handler called upon an error occuring in the integration |
steps[]Endpoint |
Steps contains an optional list of intermediate steps that are executed between the Source and the Sink |
replicasint32 |
Replicas is the number of desired replicas for the binding |
KameletBindingStatus
(Appears on: KameletBinding)
KameletBindingStatus –
| Field | Description |
|---|---|
phaseKameletBindingPhase |
Phase – |
conditions[]KameletBindingCondition |
Conditions – |
replicasint32 |
Replicas is the number of actual replicas of the binding |
selectorstring |
Selector allows to identify pods belonging to the binding |
KameletCondition
(Appears on: KameletStatus)
KameletCondition describes the state of a resource at a certain point.
| Field | Description |
|---|---|
typeKameletConditionType |
Type of kamelet condition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition, one of True, False, Unknown. |
lastUpdateTimeKubernetes meta/v1.Time |
The last time this condition was updated. |
lastTransitionTimeKubernetes meta/v1.Time |
Last time the condition transitioned from one status to another. |
reasonstring |
The reason for the condition’s last transition. |
messagestring |
A human readable message indicating details about the transition. |
KameletConditionType
(string alias)
(Appears on: KameletCondition)
KameletPhase
(string alias)
(Appears on: KameletStatus)
KameletProperty
(Appears on: KameletStatus)
| Field | Description |
|---|---|
namestring |
|
defaultstring |
KameletSpec
(Appears on: Kamelet)
KameletSpec defines the desired state of Kamelet
| Field | Description |
|---|---|
definitionJSONSchemaProps |
|
sources[]SourceSpec |
|
templateTemplate |
|
flowFlow |
Deprecated: use template |
authorizationAuthorizationSpec |
|
typesmap[github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventSlot]github.com/apache/camel-k/pkg/apis/camel/v1alpha1.EventTypeSpec |
|
dependencies[]string |
KameletStatus
(Appears on: Kamelet)
KameletStatus defines the observed state of Kamelet
| Field | Description |
|---|---|
phaseKameletPhase |
|
conditions[]KameletCondition |
|
properties[]KameletProperty |
RawMessage
([]byte alias)
(Appears on: JSON)
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.