This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch CAMEL-26511-docker-socket-default in repository https://gitbox.apache.org/repos/asf/camel.git
commit d6ee6f8b5e01bdee0538a1b87521272c02055003 Author: Claus Ibsen <[email protected]> AuthorDate: Tue Nov 3 15:42:23 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 The socket option and the CamelDockerSocketEnabled header were documented with default true, but the field has always defaulted to false (TCP to localhost:2375). The documented default is now false, which matches what the component does, so nothing changes for users. With socket=true and the default host localhost, the client connected to unix://localhost, which never works. The default host now means /var/run/docker.sock in socket mode. The docs say that in socket mode the host is the path of the socket. Co-Authored-By: Claude Opus 5.5 <[email protected]> Signed-off-by: Claus Ibsen <[email protected]> --- .../apache/camel/catalog/components/docker.json | 10 ++-- .../camel/catalog/docs/docker-component.adoc | 18 +++++++ .../org/apache/camel/component/docker/docker.json | 10 ++-- .../src/main/docs/docker-component.adoc | 18 +++++++ .../component/docker/DockerClientProfile.java | 4 +- .../component/docker/DockerConfiguration.java | 11 ++-- .../camel/component/docker/DockerConstants.java | 5 +- .../component/docker/DockerClientProfileTest.java | 8 +++ .../component/docker/DockerConfigurationTest.java | 27 ++++++++++ .../dsl/DockerComponentBuilderFactory.java | 11 ++-- .../endpoint/dsl/DockerEndpointBuilderFactory.java | 60 ++++++++++++++++------ 11 files changed, 146 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..6002f5e41948 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..c760467c4dd5 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,24 @@ 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`. + === 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..6002f5e41948 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..c760467c4dd5 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -35,6 +35,24 @@ 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`. + === 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..b3b799e62111 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 @@ -143,7 +143,9 @@ public class DockerClientProfile { ObjectHelper.notNull(this.host, "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..59d3b0ff1f96 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,8 @@ 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. */ public void setHost(String host) { this.host = host; @@ -251,7 +252,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..e51da288b6ab 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,12 @@ 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()); + } } 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/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..d618587bbceb 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,9 @@ 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. * * The option is a: <code>java.lang.String</code> type. * @@ -326,11 +328,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..080defa2deef 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,9 @@ 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. * * The option is a: <code>java.lang.String</code> type. * @@ -548,11 +550,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 +568,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 +612,9 @@ 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. * * The option is a: <code>java.lang.String</code> type. * @@ -1022,11 +1032,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 +1050,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 +1095,9 @@ 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. * * The option is a: <code>java.lang.String</code> type. * @@ -1454,11 +1472,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 +1490,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 +1692,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}.
