blob: 3e341ae112ac5674ea4729e1a13ff571478cd0b0 [file] [log] [blame]
// kafka-connector options: START
[[camel-kubernetes-hpa-kafka-connector-sink]]
= camel-kubernetes-hpa-kafka-connector sink configuration
When using camel-kubernetes-hpa-kafka-connector as sink 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-hpa-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-kubernetes-hpa sink connector supports 25 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.masterUrl* | Kubernetes Master url | null | HIGH
| *camel.sink.endpoint.apiVersion* | The Kubernetes API Version to use | null | MEDIUM
| *camel.sink.endpoint.dnsDomain* | The dns domain, used for ServiceCall EIP | null | MEDIUM
| *camel.sink.endpoint.kubernetesClient* | Default KubernetesClient to use if provided | null | MEDIUM
| *camel.sink.endpoint.portName* | The port name, used for ServiceCall EIP | null | MEDIUM
| *camel.sink.endpoint.portProtocol* | The port protocol, used for ServiceCall EIP | "tcp" | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.sink.endpoint.operation* | Producer operation to do on Kubernetes | null | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.connectionTimeout* | Connection timeout in milliseconds to use when making requests to the Kubernetes API server. | null | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.caCertData* | The CA Cert Data | null | MEDIUM
| *camel.sink.endpoint.caCertFile* | The CA Cert File | null | MEDIUM
| *camel.sink.endpoint.clientCertData* | The Client Cert Data | null | MEDIUM
| *camel.sink.endpoint.clientCertFile* | The Client Cert File | null | MEDIUM
| *camel.sink.endpoint.clientKeyAlgo* | The Key Algorithm used by the client | null | MEDIUM
| *camel.sink.endpoint.clientKeyData* | The Client Key data | null | MEDIUM
| *camel.sink.endpoint.clientKeyFile* | The Client Key file | null | MEDIUM
| *camel.sink.endpoint.clientKeyPassphrase* | The Client Key Passphrase | null | MEDIUM
| *camel.sink.endpoint.oauthToken* | The Auth Token | null | MEDIUM
| *camel.sink.endpoint.password* | Password to connect to Kubernetes | null | MEDIUM
| *camel.sink.endpoint.trustCerts* | Define if the certs we used are trusted anyway or not | null | MEDIUM
| *camel.sink.endpoint.username* | Username to connect to Kubernetes | null | MEDIUM
| *camel.component.kubernetes-hpa.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.component.kubernetes-hpa.basicProperty Binding* | 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