Run Device Service from Docker Compose

[sounak-1989]

Hi guys,
I have developed my device service with a lot of support from this community. Thanks for that. Now I want to dockerize the service and add it to the edgex-compose docker-compose.yml file.

I have been able to create a local docker image and added the service to the docker-compose.yml. But whenever the device service is trying to send an HTTP request to other services it gets a connection refused.

Few things to note:

• In the docker-compose.yml file I have opened up all host_ip to 0.0.0.0 to make it visible to my network.
• The security is turned off. Added environment variables to the containers.

Any Idea what might cause the issue? I can share my docker-compose.yml and the Dockerfile and the logs if needed.

Here's a snapshot of the logs from my device service

level=INFO ts=2023-06-21T21:17:11.984598015Z app=core-metadata source=config.go:391 msg="Loaded service configuration from /res/configuration.toml"
level=INFO ts=2023-06-21T21:17:11.986123974Z app=core-metadata source=variables.go:352 msg="Variables override of 'Notifications.Sender' by environment variable: NOTIFICATIONS_SENDER=edgex-core-metadata"
level=INFO ts=2023-06-21T21:17:11.986238809Z app=core-metadata source=variables.go:352 msg="Variables override of 'Databases.Primary.Host' by environment variable: DATABASES_PRIMARY_HOST=edgex-redis"
level=INFO ts=2023-06-21T21:17:11.986262384Z app=core-metadata source=variables.go:352 msg="Variables override of 'Registry.Host' by environment variable: REGISTRY_HOST=edgex-core-consul"
level=INFO ts=2023-06-21T21:17:11.98628413Z app=core-metadata source=variables.go:352 msg="Variables override of 'Clients.support-notifications.Host' by environment variable: CLIENTS_SUPPORT_NOTIFICATIONS_HOST=edgex-support-notifications"
level=INFO ts=2023-06-21T21:17:11.986304891Z app=core-metadata source=variables.go:352 msg="Variables override of 'Service.Host' by environment variable: SERVICE_HOST=edgex-core-metadata"
level=INFO ts=2023-06-21T21:17:11.986659519Z app=core-metadata source=config.go:160 msg="Using Configuration Provider access token of length 0"
level=INFO ts=2023-06-21T21:17:11.986718836Z app=core-metadata source=config.go:366 msg="Using Configuration provider (consul) from: http://edgex-core-consul:8500 with base path of edgex/core/2.0/core-metadata"
level=INFO ts=2023-06-21T21:17:19.96900657Z app=core-metadata source=config.go:551 msg="Configuration has been pushed to into Configuration Provider (5 envVars overrides applied)"
level=INFO ts=2023-06-21T21:17:19.96926975Z app=core-metadata source=registry.go:61 msg="Using Registry access token of length 0"
level=INFO ts=2023-06-21T21:17:19.969335687Z app=core-metadata source=registry.go:85 msg="Using Registry (consul) from http://edgex-core-consul:8500"
level=INFO ts=2023-06-21T21:17:20.048067465Z app=core-metadata source=database.go:120 msg="Database for V2 API connected"
level=INFO ts=2023-06-21T21:17:20.050954288Z app=core-metadata source=telemetry.go:86 msg="Telemetry starting"
level=INFO ts=2023-06-21T21:17:20.05129356Z app=core-metadata source=httpserver.go:131 msg="Web server starting (edgex-core-metadata:59881)"
level=INFO ts=2023-06-21T21:17:20.051344022Z app=core-metadata source=message.go:50 msg="Service dependencies resolved..."
level=INFO ts=2023-06-21T21:17:20.051369858Z app=core-metadata source=message.go:51 msg="Starting core-metadata 2.2.0 "
level=INFO ts=2023-06-21T21:17:20.051387113Z app=core-metadata source=message.go:55 msg="This is the EdgeX Core Metadata Microservice"
level=INFO ts=2023-06-21T21:17:20.051407704Z app=core-metadata source=message.go:58 msg="Service started in: 8.068586443s"
debian@BeagleBone:~/dependencies/edgex-compose/compose-builder$ docker logs edgex-device-io-hub
level=INFO ts=2023-06-21T21:17:15.619740615Z app=device-io-hub source=config.go:392 msg="Loaded service configuration from ./res/configuration.toml"
level=INFO ts=2023-06-21T21:17:15.64971727Z app=device-io-hub source=variables.go:377 msg="Variables override of 'Service.Host' by environment variable: SERVICE_HOST=edgex-device-io-hub"
level=INFO ts=2023-06-21T21:17:15.650634578Z app=device-io-hub source=config.go:556 msg="Using local configuration from file (1 envVars overrides applied)"
level=INFO ts=2023-06-21T21:17:15.650810754Z app=device-io-hub source=httpserver.go:133 msg="Web server starting (edgex-device-io-hub:59991)"
level=INFO ts=2023-06-21T21:17:15.650931138Z app=device-io-hub source=messaging.go:69 msg="Setting options for secure MessageBus with AuthMode='usernamepassword' and SecretName='redisdb"
level=INFO ts=2023-06-21T21:17:15.656546985Z app=device-io-hub source=messaging.go:104 msg="Connected to redis Message Bus @ redis://0.0.0.0:6379 publishing on 'edgex/events/device' prefix topic with AuthMode='usernamepassword'"
level=INFO ts=2023-06-21T21:17:15.656905403Z app=device-io-hub source=command.go:39 msg="skipping subscription to empty command request topic"
level=INFO ts=2023-06-21T21:17:15.656976225Z app=device-io-hub source=metrics.go:64 msg="0 specified for metrics reporting interval. Setting to max duration to effectively disable reporting."
level=INFO ts=2023-06-21T21:17:15.657141096Z app=device-io-hub source=manager.go:122 msg="Metrics Manager started with a report interval of 2562047h47m16.854775807s"
level=INFO ts=2023-06-21T21:17:15.657316237Z app=device-io-hub source=clients.go:160 msg="Using REST for 'core-command' clients @ http://0.0.0.0:59882"
level=INFO ts=2023-06-21T21:17:15.65752122Z app=device-io-hub source=clients.go:160 msg="Using REST for 'core-metadata' clients @ http://0.0.0.0:59881"
level=INFO ts=2023-06-21T21:17:15.658190739Z app=device-io-hub source=restrouter.go:55 msg="Registering v2 routes..."
level=ERROR ts=2023-06-21T21:17:15.683275998Z app=device-io-hub source=init.go:43 msg="Failed to init cache: failed to send a http request -> Get \"http://0.0.0.0:59881/api/v2/device/service/name/device-io-hub?limit=-1&offset=0\": dial tcp 0.0.0.0:59881: connect: connection refused"
level=INFO ts=2023-06-21T21:17:17.061357579Z app=device-io-hub source=config.go:392 msg="Loaded service configuration from ./res/configuration.toml"
level=INFO ts=2023-06-21T21:17:17.064397443Z app=device-io-hub source=variables.go:377 msg="Variables override of 'Service.Host' by environment variable: SERVICE_HOST=edgex-device-io-hub"
level=INFO ts=2023-06-21T21:17:17.065184871Z app=device-io-hub source=config.go:556 msg="Using local configuration from file (1 envVars overrides applied)"
level=INFO ts=2023-06-21T21:17:17.065427175Z app=device-io-hub source=httpserver.go:133 msg="Web server starting (edgex-device-io-hub:59991)"
level=INFO ts=2023-06-21T21:17:17.065493667Z app=device-io-hub source=messaging.go:69 msg="Setting options for secure MessageBus with AuthMode='usernamepassword' and SecretName='redisdb"
level=INFO ts=2023-06-21T21:17:17.065839564Z app=device-io-hub source=messaging.go:104 msg="Connected to redis Message Bus @ redis://0.0.0.0:6379 publishing on 'edgex/events/device' prefix topic with AuthMode='usernamepassword'"

Thanks

[lenny-goodell]

Looks like you used value of 0.0.0.0 as the host name for all the dependent services. This MUST be the docker network host name, i.e. edgex-core-data, edgex-core-metadata.

[sounak-1989]

Hi @lenny-intel ,
I am using an older branch (Kamakura) since that worked best with our current Hardware. I have changed the IP to 0.0.0.0 to expose all the services to the local network. They can still be identified by the port number. Even if I change the host service to localhost I am still getting similar issue.

Do you have a proper documentation on how to dockerize the device service? Let me know.

[bnevis-i]

Look at this:

level=INFO ts=2023-06-21T21:17:11.98628413Z app=core-metadata source=variables.go:352 msg="Variables override of 'Clients.support-notifications.Host' by environment variable: CLIENTS_SUPPORT_NOTIFICATIONS_HOST=edgex-support-notifications"
level=INFO ts=2023-06-21T21:17:11.986304891Z app=core-metadata source=variables.go:352 msg="Variables override of 'Service.Host' by environment variable: SERVICE_HOST=edgex-core-metadata"
...
level=INFO ts=2023-06-21T21:17:15.657316237Z app=device-io-hub source=clients.go:160 msg="Using REST for 'core-command' clients @ http://0.0.0.0:59882"
level=INFO ts=2023-06-21T21:17:15.65752122Z app=device-io-hub source=clients.go:160 msg="Using REST for 'core-metadata' clients @ http://0.0.0.0:59881"

So you have overridden the host name for support-notifications but not core-data or core-metadata. You have also not told it the proper message bus host. Then, you have set SERVICE_HOST to edgex-core-metadata instead of device-yourdeviceservice.

All docker services are exposed on the docker network. If you want to expose a docker service to the host network, it needs to be first properly exposed on the docker network (which it isn't), and then in the ports section of the docker-compose.yaml you need to map it to the host's ports. If you look at edgex-kong, for example, it will bind 0.0.0.0:8443:8443 which will take the port 8443 on the docker network and mirror it to all the external interfaces on the host. Most EdgeX services are set up to bind 127.0.0.1:port:port which only makes it locally-accessible. Since containers have virtualized network interfaces, it is not possible, from within a container, to cause its network interface to be externally exposed, since all those interfaces live, by default, on a Linux bridge network.

[sounak-1989]

@bnevis-i Aaah, got it. I will try to change things around and see if I can get it to work. Thanks for pointing out the issues.