blob: a2bab47e802286ebb468a6762a1c95d3530d0324 [file] [log] [blame]
// kafka-connector options: START
[[camel-docker-kafka-connector-source]]
= camel-docker-kafka-connector source configuration
When using camel-docker-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-docker-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-docker source connector supports 26 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.operation* | Which operation to use One of: [events] [stats] [auth] [info] [ping] [version] [imagebuild] [imagecreate] [imageinspect] [imagelist] [imagepull] [imagepushimageremove] [imagesearch] [imagetag] [containerattach] [containercommit] [containercopyfile] [containercreate] [containerdiffinspectcontainer] [containerkill] [containerlist] [containerlog] [containerpause] [containerrestart] [containerremove] [containerstartcontainerstop] [containertop] [containerunpause] [containerwait] [execcreate] [execstart] | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.email* | Email address associated with the user | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.host* | Docker host | "localhost" | ConfigDef.Importance.HIGH
| *camel.source.endpoint.port* | Docker port | "2375" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.request Timeout* | Request timeout for response (in seconds) | null | 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.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.cmdExec Factory* | The fully qualified class name of the DockerCmdExecFactory implementation to use | "com.github.dockerjava.netty.NettyDockerCmdExecFactory" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.follow RedirectFilter* | Whether to follow redirect filter | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.logging Filter* | Whether to use logging filter | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.maxPer RouteConnections* | Maximum route connections | "100" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.maxTotal Connections* | Maximum total connections | "100" | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.parameters* | Additional configuration parameters as key/value pairs | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.server Address* | Server address for docker registry. | "https://index.docker.io/v1/" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.socket* | Socket connection mode | true | 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.certPath* | Location containing the SSL certificate chain | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.password* | Password to authenticate with | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.secure* | Use HTTPS communication | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.tls Verify* | Check TLS | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.username* | User name to authenticate with | null | ConfigDef.Importance.MEDIUM
| * camel.component.docker.configuration* | To use the shared docker configuration | null | ConfigDef.Importance.MEDIUM
| *camel.component.docker.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.docker.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