This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new c885344db813 CAMEL-26511: camel-docker - document socket=false as the
default, and use /var/run/docker.sock in socket mode with the default host
(#29107)
c885344db813 is described below
commit c885344db813d271929922d676038cdd2190784c
Author: Claus Ibsen <[email protected]>
AuthorDate: Tue Nov 3 18:08:42 2026 +0100
CAMEL-26511: camel-docker - document socket=false as the default, and use
/var/run/docker.sock in socket mode with the default host (#29107)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../apache/camel/catalog/components/docker.json | 10 ++--
.../camel/catalog/docs/docker-component.adoc | 23 ++++++++
.../org/apache/camel/component/docker/docker.json | 10 ++--
.../src/main/docs/docker-component.adoc | 23 ++++++++
.../component/docker/DockerClientProfile.java | 9 ++-
.../component/docker/DockerConfiguration.java | 12 ++--
.../camel/component/docker/DockerConstants.java | 5 +-
.../component/docker/DockerClientProfileTest.java | 25 ++++++++
.../component/docker/DockerConfigurationTest.java | 27 +++++++++
.../ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 14 +++++
.../dsl/DockerComponentBuilderFactory.java | 13 ++++-
.../endpoint/dsl/DockerEndpointBuilderFactory.java | 66 ++++++++++++++++------
12 files changed, 201 insertions(+), 36 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json
index 07c7b96edc4d..401bec7fec69 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docker.json
@@ -26,7 +26,7 @@
"componentProperties": {
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.docker.DockerConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use the shared docker configuration" },
"email": { "index": 1, "kind": "property", "displayName": "Email",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Email address associated with the user" },
- "host": { "index": 2, "kind": "property", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host" },
+ "host": { "index": 2, "kind": "property", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host. In socket mode (socket=true), the
path of the unix socket of the D [...]
"port": { "index": 3, "kind": "property", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 2375, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker port" },
"requestTimeout": { "index": 4, "kind": "property", "displayName":
"Request Timeout", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Request timeout for response (in seconds)" },
"bridgeErrorHandler": { "index": 5, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -39,7 +39,7 @@
"maxTotalConnections": { "index": 12, "kind": "property", "displayName":
"Max Total Connections", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Maximum total connections" },
"parameters": { "index": 13, "kind": "property", "displayName":
"Parameters", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Object>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Additional configuration
parameters as key\/value pairs" },
"serverAddress": { "index": 14, "kind": "property", "displayName": "Server
Address", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "https:\/\/index.docker.io\/v1\/",
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Server address for
docker registry." },
- "socket": { "index": 15, "kind": "property", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode" },
+ "socket": { "index": 15, "kind": "property", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode. When enabled, connects
to the unix socket of the Docker daemon, whose path i [...]
"certPath": { "index": 16, "kind": "property", "displayName": "Cert Path",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Location containing the SSL certificate chain"
},
"password": { "index": 17, "kind": "property", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Password to authenticate with" },
"secure": { "index": 18, "kind": "property", "displayName": "Secure",
"group": "security", "label": "security", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Use HTTPS communication" },
@@ -55,7 +55,7 @@
"CamelDockerMaxTotalConnections": { "index": 5, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The maximum total connections",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_TOTAL_CONNECTIONS"
},
"CamelDockerSecure": { "index": 6, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Use HTTPS communication",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SECURE" },
"CamelDockerTlsVerify": { "index": 7, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Check TLS", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_TLSVERIFY" },
- "CamelDockerSocketEnabled": { "index": 8, "kind": "header", "displayName":
"", "group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "true", "description": "Socket connection mode",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SOCKET_ENABLED" },
+ "CamelDockerSocketEnabled": { "index": 8, "kind": "header", "displayName":
"", "group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Socket connection mode: connect
to the unix socket of the Docker daemon, whose path is given by the host (the
default localhost means \/var\/run\/docker.sock)", "constantName":
"org.apache.camel.component.docker.D [...]
"CamelDockerCmdExecFactory": { "index": 9, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The fully qualified class name of the
DockerCmdExecFactory implementation to use", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD_EXEC_FACTORY" },
"CamelDockerFilter": { "index": 10, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "With label filter", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_FILTER" },
"CamelDockerShowAll": { "index": 11, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "With show all flag", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_ALL" },
@@ -138,7 +138,7 @@
"properties": {
"operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "common", "label": "", "required": true, "type": "enum", "javaType":
"org.apache.camel.component.docker.DockerOperation", "enum": [ "events",
"stats", "auth", "info", "ping", "version", "imagebuild", "imagecreate",
"imageinspect", "imagelist", "imagepull", "imagepush", "imageremove",
"imagesearch", "imagetag", "containerattach", "containercommit",
"containercopyfile", "containercreate", "containerdiff", " [...]
"email": { "index": 1, "kind": "parameter", "displayName": "Email",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Email address associated with the user" },
- "host": { "index": 2, "kind": "parameter", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host" },
+ "host": { "index": 2, "kind": "parameter", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host. In socket mode (socket=true), the
path of the unix socket of the [...]
"port": { "index": 3, "kind": "parameter", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 2375, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker port" },
"requestTimeout": { "index": 4, "kind": "parameter", "displayName":
"Request Timeout", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Request timeout for response (in seconds)" },
"bridgeErrorHandler": { "index": 5, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
@@ -152,7 +152,7 @@
"maxTotalConnections": { "index": 13, "kind": "parameter", "displayName":
"Max Total Connections", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Maximum total connections" },
"parameters": { "index": 14, "kind": "parameter", "displayName":
"Parameters", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Object>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Additional configuration
parameters as key\/value pairs" },
"serverAddress": { "index": 15, "kind": "parameter", "displayName":
"Server Address", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"https:\/\/index.docker.io\/v1\/", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Server address for docker registry." },
- "socket": { "index": 16, "kind": "parameter", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode" },
+ "socket": { "index": 16, "kind": "parameter", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode. When enabled, connects
to the unix socket of the Docker daemon, whose path [...]
"certPath": { "index": 17, "kind": "parameter", "displayName": "Cert
Path", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Location containing the SSL certificate chain"
},
"password": { "index": 18, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Password to authenticate with" },
"secure": { "index": 19, "kind": "parameter", "displayName": "Secure",
"group": "security", "label": "security", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Use HTTPS communication" },
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docker-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docker-component.adoc
index e0e3157e838e..fb2c84b30777 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docker-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docker-component.adoc
@@ -35,6 +35,29 @@ include::partial$component-endpoint-headers.adoc[]
== Usage
+=== Connecting to the Docker daemon
+
+By default, the component connects over TCP to `host` and `port`
(`tcp://localhost:2375`). Docker does not open this
+TCP port by default; it has to be enabled in the configuration of the daemon.
+
+To connect to the local unix socket of the daemon instead, set `socket=true`.
In socket mode `host` is the path of the
+socket and `port` is not used. The default host `localhost` means
`/var/run/docker.sock`:
+
+[source,java]
+----
+from("timer:info?repeatCount=1")
+ .to("docker:info?socket=true")
+ .log("${body}");
+----
+
+For a socket in another place, set its path as the host, for example
+`docker:info?socket=true&host=/run/user/1000/docker.sock`.
+
+The host can also be a full Docker host URL with a `tcp://` or `unix://`
scheme, in the same form as the `DOCKER_HOST`
+environment variable, such as `tcp://myhost:2376` or
`unix:///var/run/docker.sock`. Such a host is used as is, and the
+`port` and `socket` options are not used. Windows named pipes (`npipe://`) are
not supported by the Docker client of
+the component.
+
=== Header Strategy
All URI options can be passed as Header properties. Values found in a
diff --git
a/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json
b/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json
index 07c7b96edc4d..401bec7fec69 100644
---
a/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json
+++
b/components/camel-docker/src/generated/resources/META-INF/org/apache/camel/component/docker/docker.json
@@ -26,7 +26,7 @@
"componentProperties": {
"configuration": { "index": 0, "kind": "property", "displayName":
"Configuration", "group": "common", "label": "", "required": false, "type":
"object", "javaType": "org.apache.camel.component.docker.DockerConfiguration",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use the shared docker configuration" },
"email": { "index": 1, "kind": "property", "displayName": "Email",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Email address associated with the user" },
- "host": { "index": 2, "kind": "property", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host" },
+ "host": { "index": 2, "kind": "property", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host. In socket mode (socket=true), the
path of the unix socket of the D [...]
"port": { "index": 3, "kind": "property", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 2375, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker port" },
"requestTimeout": { "index": 4, "kind": "property", "displayName":
"Request Timeout", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Request timeout for response (in seconds)" },
"bridgeErrorHandler": { "index": 5, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
@@ -39,7 +39,7 @@
"maxTotalConnections": { "index": 12, "kind": "property", "displayName":
"Max Total Connections", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Maximum total connections" },
"parameters": { "index": 13, "kind": "property", "displayName":
"Parameters", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Object>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Additional configuration
parameters as key\/value pairs" },
"serverAddress": { "index": 14, "kind": "property", "displayName": "Server
Address", "group": "advanced", "label": "advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "https:\/\/index.docker.io\/v1\/",
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Server address for
docker registry." },
- "socket": { "index": 15, "kind": "property", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode" },
+ "socket": { "index": 15, "kind": "property", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode. When enabled, connects
to the unix socket of the Docker daemon, whose path i [...]
"certPath": { "index": 16, "kind": "property", "displayName": "Cert Path",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Location containing the SSL certificate chain"
},
"password": { "index": 17, "kind": "property", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Password to authenticate with" },
"secure": { "index": 18, "kind": "property", "displayName": "Secure",
"group": "security", "label": "security", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Use HTTPS communication" },
@@ -55,7 +55,7 @@
"CamelDockerMaxTotalConnections": { "index": 5, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The maximum total connections",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_MAX_TOTAL_CONNECTIONS"
},
"CamelDockerSecure": { "index": 6, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Use HTTPS communication",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SECURE" },
"CamelDockerTlsVerify": { "index": 7, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Check TLS", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_TLSVERIFY" },
- "CamelDockerSocketEnabled": { "index": 8, "kind": "header", "displayName":
"", "group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "true", "description": "Socket connection mode",
"constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SOCKET_ENABLED" },
+ "CamelDockerSocketEnabled": { "index": 8, "kind": "header", "displayName":
"", "group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "defaultValue": "false", "description": "Socket connection mode: connect
to the unix socket of the Docker daemon, whose path is given by the host (the
default localhost means \/var\/run\/docker.sock)", "constantName":
"org.apache.camel.component.docker.D [...]
"CamelDockerCmdExecFactory": { "index": 9, "kind": "header",
"displayName": "", "group": "common", "label": "", "required": false,
"javaType": "String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "description": "The fully qualified class name of the
DockerCmdExecFactory implementation to use", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_CMD_EXEC_FACTORY" },
"CamelDockerFilter": { "index": 10, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "With label filter", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_FILTER" },
"CamelDockerShowAll": { "index": 11, "kind": "header", "displayName": "",
"group": "common", "label": "", "required": false, "javaType": "Boolean",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "With show all flag", "constantName":
"org.apache.camel.component.docker.DockerConstants#DOCKER_SHOW_ALL" },
@@ -138,7 +138,7 @@
"properties": {
"operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "common", "label": "", "required": true, "type": "enum", "javaType":
"org.apache.camel.component.docker.DockerOperation", "enum": [ "events",
"stats", "auth", "info", "ping", "version", "imagebuild", "imagecreate",
"imageinspect", "imagelist", "imagepull", "imagepush", "imageremove",
"imagesearch", "imagetag", "containerattach", "containercommit",
"containercopyfile", "containercreate", "containerdiff", " [...]
"email": { "index": 1, "kind": "parameter", "displayName": "Email",
"group": "common", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Email address associated with the user" },
- "host": { "index": 2, "kind": "parameter", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host" },
+ "host": { "index": 2, "kind": "parameter", "displayName": "Host", "group":
"common", "label": "", "required": true, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "deprecationNote": "", "autowired":
false, "secret": false, "defaultValue": "localhost", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker host. In socket mode (socket=true), the
path of the unix socket of the [...]
"port": { "index": 3, "kind": "parameter", "displayName": "Port", "group":
"common", "label": "", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 2375, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Docker port" },
"requestTimeout": { "index": 4, "kind": "parameter", "displayName":
"Request Timeout", "group": "common", "label": "", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Request timeout for response (in seconds)" },
"bridgeErrorHandler": { "index": 5, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
@@ -152,7 +152,7 @@
"maxTotalConnections": { "index": 13, "kind": "parameter", "displayName":
"Max Total Connections", "group": "advanced", "label": "advanced", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": 100, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Maximum total connections" },
"parameters": { "index": 14, "kind": "parameter", "displayName":
"Parameters", "group": "advanced", "label": "advanced", "required": false,
"type": "object", "javaType": "java.util.Map<java.lang.String,
java.lang.Object>", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.docker.DockerConfiguration",
"configurationField": "configuration", "description": "Additional configuration
parameters as key\/value pairs" },
"serverAddress": { "index": 15, "kind": "parameter", "displayName":
"Server Address", "group": "advanced", "label": "advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"https:\/\/index.docker.io\/v1\/", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Server address for docker registry." },
- "socket": { "index": 16, "kind": "parameter", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode" },
+ "socket": { "index": 16, "kind": "parameter", "displayName": "Socket",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Socket connection mode. When enabled, connects
to the unix socket of the Docker daemon, whose path [...]
"certPath": { "index": 17, "kind": "parameter", "displayName": "Cert
Path", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Location containing the SSL certificate chain"
},
"password": { "index": 18, "kind": "parameter", "displayName": "Password",
"group": "security", "label": "security", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Password to authenticate with" },
"secure": { "index": 19, "kind": "parameter", "displayName": "Secure",
"group": "security", "label": "security", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.docker.DockerConfiguration", "configurationField":
"configuration", "description": "Use HTTPS communication" },
diff --git a/components/camel-docker/src/main/docs/docker-component.adoc
b/components/camel-docker/src/main/docs/docker-component.adoc
index e0e3157e838e..fb2c84b30777 100644
--- a/components/camel-docker/src/main/docs/docker-component.adoc
+++ b/components/camel-docker/src/main/docs/docker-component.adoc
@@ -35,6 +35,29 @@ include::partial$component-endpoint-headers.adoc[]
== Usage
+=== Connecting to the Docker daemon
+
+By default, the component connects over TCP to `host` and `port`
(`tcp://localhost:2375`). Docker does not open this
+TCP port by default; it has to be enabled in the configuration of the daemon.
+
+To connect to the local unix socket of the daemon instead, set `socket=true`.
In socket mode `host` is the path of the
+socket and `port` is not used. The default host `localhost` means
`/var/run/docker.sock`:
+
+[source,java]
+----
+from("timer:info?repeatCount=1")
+ .to("docker:info?socket=true")
+ .log("${body}");
+----
+
+For a socket in another place, set its path as the host, for example
+`docker:info?socket=true&host=/run/user/1000/docker.sock`.
+
+The host can also be a full Docker host URL with a `tcp://` or `unix://`
scheme, in the same form as the `DOCKER_HOST`
+environment variable, such as `tcp://myhost:2376` or
`unix:///var/run/docker.sock`. Such a host is used as is, and the
+`port` and `socket` options are not used. Windows named pipes (`npipe://`) are
not supported by the Docker client of
+the component.
+
=== Header Strategy
All URI options can be passed as Header properties. Values found in a
diff --git
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerClientProfile.java
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerClientProfile.java
index 1945d5fd493a..267249f2986d 100644
---
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerClientProfile.java
+++
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerClientProfile.java
@@ -142,8 +142,15 @@ public class DockerClientProfile {
public String toUrl() {
ObjectHelper.notNull(this.host, "host");
+ // a host that is already a docker host url is used as is
+ if (host.startsWith("tcp://") || host.startsWith("unix://") ||
host.startsWith("npipe://")) {
+ return host;
+ }
+
if (this.socket != null && this.socket) {
- return String.format("unix://%s", host);
+ // in socket mode the host is the path of the socket, and the
default host is the default socket
+ String path = DockerConstants.DEFAULT_HOST.equals(host) ?
DockerConstants.DEFAULT_SOCKET_PATH : host;
+ return String.format("unix://%s", path);
}
ObjectHelper.notNull(this.port, "port");
diff --git
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
index 9214894cf5c0..ff19efa16faa 100644
---
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
+++
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
@@ -36,7 +36,7 @@ public class DockerConfiguration implements Cloneable {
private DockerOperation operation;
@UriParam(defaultValue = "localhost")
@Metadata(required = true)
- private String host = "localhost";
+ private String host = DockerConstants.DEFAULT_HOST;
@UriParam(defaultValue = "2375")
private Integer port = 2375;
@UriParam(label = "security", security = "secret")
@@ -63,7 +63,7 @@ public class DockerConfiguration implements Cloneable {
private boolean followRedirectFilter;
@UriParam(label = "security", defaultValue = "false")
private boolean tlsVerify;
- @UriParam(label = "advanced", defaultValue = "true")
+ @UriParam(label = "advanced", defaultValue = "false")
private boolean socket;
@UriParam(label = "advanced", defaultValue =
"com.github.dockerjava.netty.NettyDockerCmdExecFactory")
private String cmdExecFactory = DockerConstants.DEFAULT_CMD_EXEC_FACTORY;
@@ -75,7 +75,9 @@ public class DockerConfiguration implements Cloneable {
}
/**
- * Docker host
+ * Docker host. In socket mode (socket=true), the path of the unix socket
of the Docker daemon, where the default
+ * localhost means /var/run/docker.sock. A host with a tcp:// or unix://
scheme (such as tcp://myhost:2376 or
+ * unix:///var/run/docker.sock) is used as is, and then the port and
socket options are not used.
*/
public void setHost(String host) {
this.host = host;
@@ -251,7 +253,9 @@ public class DockerConfiguration implements Cloneable {
}
/**
- * Socket connection mode
+ * Socket connection mode. When enabled, connects to the unix socket of
the Docker daemon, whose path is given by
+ * the host option (the default localhost means /var/run/docker.sock), and
the port is not used. When disabled,
+ * connects over TCP to the host and port.
*/
public void setSocket(boolean socket) {
this.socket = socket;
diff --git
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java
index 8b22cd4b2cc8..bbae44d89fb3 100644
---
a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java
+++
b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConstants.java
@@ -34,6 +34,8 @@ public final class DockerConstants {
* Endpoint configuration defaults
*/
public static final String DEFAULT_CMD_EXEC_FACTORY =
"com.github.dockerjava.netty.NettyDockerCmdExecFactory";
+ public static final String DEFAULT_HOST = "localhost";
+ public static final String DEFAULT_SOCKET_PATH = "/var/run/docker.sock";
/**
* Connectivity *
@@ -61,7 +63,8 @@ public final class DockerConstants {
public static final String DOCKER_LOGGING_FILTER =
"CamelDockerLoggingFilter";
@Metadata(description = "Check TLS", javaType = "Boolean", defaultValue =
"false")
public static final String DOCKER_TLSVERIFY = "CamelDockerTlsVerify";
- @Metadata(description = "Socket connection mode", javaType = "Boolean",
defaultValue = "true")
+ @Metadata(description = "Socket connection mode: connect to the unix
socket of the Docker daemon, whose path is given by the host (the default
localhost means /var/run/docker.sock)",
+ javaType = "Boolean", defaultValue = "false")
public static final String DOCKER_SOCKET_ENABLED =
"CamelDockerSocketEnabled";
@Metadata(description = "The fully qualified class name of the
DockerCmdExecFactory implementation to use",
javaType = "String")
diff --git
a/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerClientProfileTest.java
b/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerClientProfileTest.java
index 7db7e417bad3..0e3a1637073e 100644
---
a/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerClientProfileTest.java
+++
b/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerClientProfileTest.java
@@ -89,4 +89,29 @@ public class DockerClientProfileTest {
profile.setSocket(true);
assertEquals("unix:///var/run/docker.sock", profile.toUrl());
}
+
+ @Test
+ void clientProfileWithSocketDefaultHostUrlTest() {
+ DockerClientProfile profile = new DockerClientProfile();
+ profile.setHost(new DockerConfiguration().getHost());
+ profile.setSocket(true);
+ assertEquals("unix:///var/run/docker.sock", profile.toUrl());
+ }
+
+ @Test
+ void clientProfileWithHostUrlTest() {
+ DockerClientProfile profile = new DockerClientProfile();
+ profile.setHost("tcp://myhost:2376");
+ // Port should be ignored
+ profile.setPort(2375);
+ assertEquals("tcp://myhost:2376", profile.toUrl());
+
+ profile.setHost("unix:///var/run/docker.sock");
+ profile.setSocket(true);
+ assertEquals("unix:///var/run/docker.sock", profile.toUrl());
+
+ profile.setHost("npipe:////./pipe/docker_engine");
+ profile.setSocket(false);
+ assertEquals("npipe:////./pipe/docker_engine", profile.toUrl());
+ }
}
diff --git
a/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerConfigurationTest.java
b/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerConfigurationTest.java
index dbec4ed339ac..ccdedf548125 100644
---
a/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerConfigurationTest.java
+++
b/components/camel-docker/src/test/java/org/apache/camel/component/docker/DockerConfigurationTest.java
@@ -16,6 +16,8 @@
*/
package org.apache.camel.component.docker;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
@@ -23,10 +25,14 @@ import org.apache.camel.CamelContext;
import org.apache.camel.Message;
import org.apache.camel.impl.DefaultCamelContext;
import org.apache.camel.support.DefaultMessage;
+import org.apache.camel.util.json.JsonObject;
+import org.apache.camel.util.json.Jsoner;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
public class DockerConfigurationTest {
@@ -63,4 +69,25 @@ public class DockerConfigurationTest {
assertEquals(host, configurationProp);
}
+ @Test
+ void testSocketDefaultIsTheDocumentedDefault() throws Exception {
+ assertFalse(configuration.isSocket());
+
+ JsonObject json;
+ try (InputStream is = DockerConfigurationTest.class
+
.getResourceAsStream("/META-INF/org/apache/camel/component/docker/docker.json"))
{
+ assertNotNull(is);
+ json = (JsonObject) Jsoner.deserialize(new
String(is.readAllBytes(), StandardCharsets.UTF_8));
+ }
+ String expected = String.valueOf(configuration.isSocket());
+ assertEquals(expected, defaultValue(json, "componentProperties",
"socket"));
+ assertEquals(expected, defaultValue(json, "properties", "socket"));
+ assertEquals(expected, defaultValue(json, "headers",
DockerConstants.DOCKER_SOCKET_ENABLED));
+ }
+
+ private static String defaultValue(JsonObject json, String group, String
name) {
+ JsonObject options = json.getMap(group);
+ JsonObject option = options.getMap(name);
+ return String.valueOf(option.get("defaultValue"));
+ }
}
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
index e386d7eacac7..3c128f7ff550 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
@@ -3279,6 +3279,20 @@ it stayed started without receiving any event. The
events of the time without a
`docker:events` or `docker:stats` consumer now closes its stream: before, the
stream stayed open, and a route that was
stopped and started again received every event once more for each restart.
+=== camel-docker - the documented default of the socket option is false
+
+The `socket` option, and the `CamelDockerSocketEnabled` header, were
documented with the default `true`, but their
+default is `false`: the component connects over TCP to `host` and `port`
unless `socket=true` is set. The documented
+default is now `false`, its real default.
+
+Up to Camel 4.22, Camel Spring Boot applied the documented default `true` to
the component, so a Spring Boot
+application that did not set `camel.component.docker.socket` used the unix
socket of the Docker daemon, with `host` as
+the path of the socket. Such an application now connects over TCP instead (to
`tcp:///var/run/docker.sock:2375` when it
+set `camel.component.docker.host=/var/run/docker.sock`). A Spring Boot
application that relied on the socket must set
+`camel.component.docker.socket=true`, or set the host as a URL with the
`unix://` scheme, such as
+`camel.component.docker.host=unix:///var/run/docker.sock`. In socket mode, the
default host `localhost` now means
+`/var/run/docker.sock`.
+
=== camel-keycloak - the consumer reads every event since the previous poll
The `keycloak` consumer (`eventType=events` and `eventType=admin-events`)
reads, after its first poll, all the events
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java
index ce8743f2fbcd..f32938afeeaa 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DockerComponentBuilderFactory.java
@@ -83,7 +83,11 @@ public interface DockerComponentBuilderFactory {
/**
- * Docker host.
+ * Docker host. In socket mode (socket=true), the path of the unix
+ * socket of the Docker daemon, where the default localhost means
+ * /var/run/docker.sock. A host with a tcp:// or unix:// scheme (such
as
+ * tcp://myhost:2376 or unix:///var/run/docker.sock) is used as is, and
+ * then the port and socket options are not used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -326,11 +330,14 @@ public interface DockerComponentBuilderFactory {
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option is a: <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java
index a5670f65be9a..883670f1a865 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DockerEndpointBuilderFactory.java
@@ -58,7 +58,11 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Docker host.
+ * Docker host. In socket mode (socket=true), the path of the unix
+ * socket of the Docker daemon, where the default localhost means
+ * /var/run/docker.sock. A host with a tcp:// or unix:// scheme (such
as
+ * tcp://myhost:2376 or unix:///var/run/docker.sock) is used as is, and
+ * then the port and socket options are not used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -548,11 +552,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option is a: <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -563,11 +570,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option will be converted to a <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -604,7 +614,11 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Docker host.
+ * Docker host. In socket mode (socket=true), the path of the unix
+ * socket of the Docker daemon, where the default localhost means
+ * /var/run/docker.sock. A host with a tcp:// or unix:// scheme (such
as
+ * tcp://myhost:2376 or unix:///var/run/docker.sock) is used as is, and
+ * then the port and socket options are not used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1022,11 +1036,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option is a: <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -1037,11 +1054,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option will be converted to a <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -1079,7 +1099,11 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Docker host.
+ * Docker host. In socket mode (socket=true), the path of the unix
+ * socket of the Docker daemon, where the default localhost means
+ * /var/run/docker.sock. A host with a tcp:// or unix:// scheme (such
as
+ * tcp://myhost:2376 or unix:///var/run/docker.sock) is used as is, and
+ * then the port and socket options are not used.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -1454,11 +1478,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option is a: <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -1469,11 +1496,14 @@ public interface DockerEndpointBuilderFactory {
return this;
}
/**
- * Socket connection mode.
+ * Socket connection mode. When enabled, connects to the unix socket of
+ * the Docker daemon, whose path is given by the host option (the
+ * default localhost means /var/run/docker.sock), and the port is not
+ * used. When disabled, connects over TCP to the host and port.
*
* The option will be converted to a <code>boolean</code> type.
*
- * Default: true
+ * Default: false
* Group: advanced
*
* @param socket the value to set
@@ -1668,11 +1698,13 @@ public interface DockerEndpointBuilderFactory {
return "CamelDockerTlsVerify";
}
/**
- * Socket connection mode.
+ * Socket connection mode: connect to the unix socket of the Docker
+ * daemon, whose path is given by the host (the default localhost means
+ * /var/run/docker.sock).
*
* The option is a: {@code Boolean} type.
*
- * Default: true
+ * Default: false
* Group: common
*
* @return the name of the header {@code DockerSocketEnabled}.
