camel-docker-kafka-connector source configuration

Connector Description: Manage Docker containers.

When using camel-docker-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<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>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.docker.CamelDockerSourceConnector

The camel-docker source connector supports 41 options, which are listed below.

Name Description Default Priority

camel.source.path.operation

Required 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].

Enum values:

  • 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

HIGH

camel.source.endpoint.email

Email address associated with the user.

MEDIUM

camel.source.endpoint.host

Required Docker host.

"localhost"

HIGH

camel.source.endpoint.port

Docker port.

"2375"

MEDIUM

camel.source.endpoint.requestTimeout

Request timeout for response (in seconds).

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.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.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.cmdExecFactory

The fully qualified class name of the DockerCmdExecFactory implementation to use.

"com.github.dockerjava.netty.NettyDockerCmdExecFactory"

MEDIUM

camel.source.endpoint.followRedirectFilter

Whether to follow redirect filter.

false

MEDIUM

camel.source.endpoint.loggingFilter

Whether to use logging filter.

false

MEDIUM

camel.source.endpoint.maxPerRouteConnections

Maximum route connections.

"100"

MEDIUM

camel.source.endpoint.maxTotalConnections

Maximum total connections.

"100"

MEDIUM

camel.source.endpoint.parameters

Additional configuration parameters as key/value pairs.

MEDIUM

camel.source.endpoint.serverAddress

Server address for docker registry.

"https://index.docker.io/v1/"

MEDIUM

camel.source.endpoint.socket

Socket connection mode.

true

MEDIUM

camel.source.endpoint.certPath

Location containing the SSL certificate chain.

MEDIUM

camel.source.endpoint.password

Password to authenticate with.

MEDIUM

camel.source.endpoint.secure

Use HTTPS communication.

false

MEDIUM

camel.source.endpoint.tlsVerify

Check TLS.

false

MEDIUM

camel.source.endpoint.username

User name to authenticate with.

MEDIUM

camel.component.docker.configuration

To use the shared docker configuration.

MEDIUM

camel.component.docker.email

Email address associated with the user.

MEDIUM

camel.component.docker.host

Required Docker host.

"localhost"

HIGH

camel.component.docker.port

Docker port.

"2375"

MEDIUM

camel.component.docker.requestTimeout

Request timeout for response (in seconds).

MEDIUM

camel.component.docker.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.component.docker.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.docker.cmdExecFactory

The fully qualified class name of the DockerCmdExecFactory implementation to use.

"com.github.dockerjava.netty.NettyDockerCmdExecFactory"

MEDIUM

camel.component.docker.followRedirectFilter

Whether to follow redirect filter.

false

MEDIUM

camel.component.docker.loggingFilter

Whether to use logging filter.

false

MEDIUM

camel.component.docker.maxPerRouteConnections

Maximum route connections.

"100"

MEDIUM

camel.component.docker.maxTotalConnections

Maximum total connections.

"100"

MEDIUM

camel.component.docker.parameters

Additional configuration parameters as key/value pairs.

MEDIUM

camel.component.docker.serverAddress

Server address for docker registry.

"https://index.docker.io/v1/"

MEDIUM

camel.component.docker.socket

Socket connection mode.

true

MEDIUM

camel.component.docker.certPath

Location containing the SSL certificate chain.

MEDIUM

camel.component.docker.password

Password to authenticate with.

MEDIUM

camel.component.docker.secure

Use HTTPS communication.

false

MEDIUM

camel.component.docker.tlsVerify

Check TLS.

false

MEDIUM

camel.component.docker.username

User name to authenticate with.

MEDIUM

The camel-docker source connector has no converters out of the box.

The camel-docker source connector has no transforms out of the box.

The camel-docker source connector has no aggregation strategies out of the box.

Back to top