Chapter 84. Docker Component

Available as of Camel version 2.15

Camel component for communicating with Docker.

The Docker Camel component leverages the docker-java via the Docker Remote API.

84.1. URI format

docker://[operation]?[options]

Where operation is the specific action to perform on Docker.

84.2. General Options

The Docker component supports 2 options which are listed below.

NameDescriptionDefaultType

configuration (advanced)

To use the shared docker configuration

 

DockerConfiguration

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The Docker endpoint is configured using URI syntax:

docker:operation

with the following path and query parameters:

84.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

operation

Required Which operation to use

 

DockerOperation

84.2.2. Query Parameters (20 parameters):

NameDescriptionDefaultType

email (common)

Email address associated with the user

 

String

host (common)

Required Docker host

localhost

String

port (common)

Required Docker port

2375

Integer

requestTimeout (common)

Request timeout for response (in seconds)

 

Integer

bridgeErrorHandler (consumer)

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

boolean

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

 

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

 

ExchangePattern

cmdExecFactory (advanced)

The fully qualified class name of the DockerCmdExecFactory implementation to use

com.github.dockerjava.netty.NettyDockerCmdExecFactory

String

followRedirectFilter (advanced)

Whether to follow redirect filter

false

boolean

loggingFilter (advanced)

Whether to use logging filter

false

boolean

maxPerRouteConnections (advanced)

Maximum route connections

100

Integer

maxTotalConnections (advanced)

Maximum total connections

100

Integer

serverAddress (advanced)

Server address for docker registry.

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

String

socket (advanced)

Socket connection mode

true

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

certPath (security)

Location containing the SSL certificate chain

 

String

password (security)

Password to authenticate with

 

String

secure (security)

Use HTTPS communication

false

boolean

tlsVerify (security)

Check TLS

false

boolean

username (security)

User name to authenticate with

 

String

84.3. Header Strategy

All URI option can be passed as Header properties. Values found in a message header take precedence over URI parameters. A header property takes the form of a URI option prefixed with CamelDocker as shown below

URI OptionHeader Property

containerId

CamelDockerContainerId

84.4. Examples

The following example consumes events from Docker:

from("docker://events?host=192.168.59.103&port=2375").to("log:event");

The following example queries Docker for system wide information

from("docker://info?host=192.168.59.103&port=2375").to("log:info");

84.5. Dependencies

To use Docker in your Camel routes you need to add a dependency on camel-docker, which implements the component.

If you use Maven you can just add the following to your pom.xml, substituting the version number for the latest and greatest release (see the download page for the latest versions).

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-docker</artifactId>
  <version>x.x.x</version>
</dependency>