camel-docker-kafka-connector sink configuration

Connector Description: Manage Docker containers.

When using camel-docker-kafka-connector as sink 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 sink connector in Kafka connect you’ll need to set the following connector.class

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

The camel-docker sink connector supports 39 options, which are listed below.

Name Description Default Priority

camel.sink.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.sink.endpoint.email

Email address associated with the user.

MEDIUM

camel.sink.endpoint.host

Required Docker host.

"localhost"

HIGH

camel.sink.endpoint.port

Docker port.

"2375"

MEDIUM

camel.sink.endpoint.requestTimeout

Request timeout for response (in seconds).

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

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

"com.github.dockerjava.netty.NettyDockerCmdExecFactory"

MEDIUM

camel.sink.endpoint.followRedirectFilter

Whether to follow redirect filter.

false

MEDIUM

camel.sink.endpoint.loggingFilter

Whether to use logging filter.

false

MEDIUM

camel.sink.endpoint.maxPerRouteConnections

Maximum route connections.

"100"

MEDIUM

camel.sink.endpoint.maxTotalConnections

Maximum total connections.

"100"

MEDIUM

camel.sink.endpoint.parameters

Additional configuration parameters as key/value pairs.

MEDIUM

camel.sink.endpoint.serverAddress

Server address for docker registry.

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

MEDIUM

camel.sink.endpoint.socket

Socket connection mode.

true

MEDIUM

camel.sink.endpoint.certPath

Location containing the SSL certificate chain.

MEDIUM

camel.sink.endpoint.password

Password to authenticate with.

MEDIUM

camel.sink.endpoint.secure

Use HTTPS communication.

false

MEDIUM

camel.sink.endpoint.tlsVerify

Check TLS.

false

MEDIUM

camel.sink.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.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.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 sink connector has no converters out of the box.

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

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

Back to top