blob: 5aea397a9c6415861b261b3ff082ddec6665e0b8 [file] [log] [blame]
// kafka-connector options: START
[[camel-kubernetes-deployments-kafka-connector-source]]
= camel-kubernetes-deployments-kafka-connector source configuration
When using camel-kubernetes-deployments-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-kubernetes-deployments-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-kubernetes-deployments source connector supports 31 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.masterUrl* | Kubernetes Master url | null | HIGH
| *camel.source.endpoint.apiVersion* | The Kubernetes API Version to use | null | MEDIUM
| *camel.source.endpoint.dnsDomain* | The dns domain, used for ServiceCall EIP | null | MEDIUM
| *camel.source.endpoint.kubernetesClient* | Default KubernetesClient to use if provided | null | MEDIUM
| *camel.source.endpoint.portName* | The port name, used for ServiceCall EIP | null | MEDIUM
| *camel.source.endpoint.portProtocol* | The port protocol, used for ServiceCall EIP | "tcp" | MEDIUM
| *camel.source.endpoint.bridgeErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | MEDIUM
| *camel.source.endpoint.labelKey* | The Consumer Label key when watching at some resources | null | MEDIUM
| *camel.source.endpoint.labelValue* | The Consumer Label value when watching at some resources | null | MEDIUM
| *camel.source.endpoint.namespace* | The namespace | null | MEDIUM
| *camel.source.endpoint.poolSize* | The Consumer pool size | 1 | MEDIUM
| *camel.source.endpoint.resourceName* | The Consumer Resource Name we would like to watch | null | MEDIUM
| *camel.source.endpoint.exceptionHandler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.source.endpoint.connectionTimeout* | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | null | MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.source.endpoint.caCertData* | The CA Cert Data | null | MEDIUM
| *camel.source.endpoint.caCertFile* | The CA Cert File | null | MEDIUM
| *camel.source.endpoint.clientCertData* | The Client Cert Data | null | MEDIUM
| *camel.source.endpoint.clientCertFile* | The Client Cert File | null | MEDIUM
| *camel.source.endpoint.clientKeyAlgo* | The Key Algorithm used by the client | null | MEDIUM
| *camel.source.endpoint.clientKeyData* | The Client Key data | null | MEDIUM
| *camel.source.endpoint.clientKeyFile* | The Client Key file | null | MEDIUM
| *camel.source.endpoint.clientKeyPassphrase* | The Client Key Passphrase | null | MEDIUM
| *camel.source.endpoint.oauthToken* | The Auth Token | null | MEDIUM
| *camel.source.endpoint.password* | Password to connect to Kubernetes | null | MEDIUM
| *camel.source.endpoint.trustCerts* | Define if the certs we used are trusted anyway or not | null | MEDIUM
| *camel.source.endpoint.username* | Username to connect to Kubernetes | null | MEDIUM
| *camel.component.kubernetes-deployments.bridgeError Handler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | MEDIUM
| *camel.component.kubernetes-deployments.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END