blob: 078f7ded2e82571a7a020f3e3b81178e862e8c9b [file] [log] [blame]
// kafka-connector options: START
[[camel-kubernetes-nodes-kafka-connector-source]]
= camel-kubernetes-nodes-kafka-connector source configuration
When using camel-kubernetes-nodes-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-nodes-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-kubernetes-nodes 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 | ConfigDef.Importance.HIGH
| *camel.source.endpoint.api Version* | The Kubernetes API Version to use | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.dns Domain* | The dns domain, used for ServiceCall EIP | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.kubernetes Client* | Default KubernetesClient to use if provided | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.portName* | The port name, used for ServiceCall EIP | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.port Protocol* | The port protocol, used for ServiceCall EIP | "tcp" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.labelKey* | The Consumer Label key when watching at some resources | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.label Value* | The Consumer Label value when watching at some resources | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.namespace* | The namespace | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.poolSize* | The Consumer pool size | 1 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.resource Name* | The Consumer Resource Name we would like to watch | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | 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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.connection Timeout* | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.caCert Data* | The CA Cert Data | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.caCert File* | The CA Cert File | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client CertData* | The Client Cert Data | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client CertFile* | The Client Cert File | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client KeyAlgo* | The Key Algorithm used by the client | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client KeyData* | The Client Key data | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client KeyFile* | The Client Key file | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.client KeyPassphrase* | The Client Key Passphrase | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.oauth Token* | The Auth Token | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.password* | Password to connect to Kubernetes | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.trust Certs* | Define if the certs we used are trusted anyway or not | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.username* | Username to connect to Kubernetes | null | ConfigDef.Importance.MEDIUM
| * camel.component.kubernetes-nodes.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| * camel.component.kubernetes-nodes.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END