devicewise/asset-gateway repository overview

⁠Running deviceWISE in Docker

The following Asset and Enterprise Gateway products are provided as Docker Images:

deviceWISE Asset Gateway (amd64, arm64, arm32v7)

https://hub.docker.com/repository/docker/devicewise/asset-gateway⁠

deviceWISE Enterprise Gateway (amd64)

https://hub.docker.com/repository/docker/devicewise/enterprise-gateway⁠

For more information about installing and using Docker, please visit:

https://docs.docker.com/get-docker/⁠

⁠Deployment and Management

After installing Docker on your host Operating System, you can pull the deviceWISE Gateway product of your choice by running the docker pull command.

⁠Installing deviceWISE Gateway Images

The following example demonstrates obtaining the deviceWISE Asset Gateway Image:

# docker pull devicewise/asset-gateway

For deviceWISE Enterprise Gateway, use the following command:

# docker pull devicewise/enterprise-gateway

Additionally, you can use the docker run command directly, which will pull down the Image automatically, and subsequently launch a Container.

In this example, we launch a Container by the name of dwag01 from the devicewise/asset-gateway Image:

# docker run -d --name deviceWISE --net=host devicewise/asset-gateway

For information regarding the available parameters to docker run, please refer to:

https://docs.docker.com/engine/reference/commandline/run/⁠

The above examples will deploy the "latest" Tag of the Docker Image. If a specific Tag is required, provide the Tag as follows:

# docker pull devicewise/asset-gateway:21.10.09

To see available Tags, please visit the deviceWISE Docker Hub website:

https://hub.docker.com/u/devicewise⁠

NOTE: For the remaining examples in this document, we will be using deviceWISE Asset Gateway.

After launching a Container instance, you can connect to the Node via the Workbench.

https://docs.devicewise.com/Content/Products/GatewayDevelopersGuide/Workbench/The-Workbench.htm⁠

⁠Managing deviceWISE Gateway Container Instances

After we've successfully pulled the Image and launched a Container instance, the following Docker commands can be used to control the Container instance:

Stopping, Starting, and Restarting the Container:

  # docker stop dwag01

  # docker start dwag01

  # docker restart dwag01

⁠Upgrading deviceWISE Gateway Images

Using the docker pull command, a new Tag can be pulled down from the Docker Hub site. If a specific Tag is not specified, the "latest" Tag will be pulled, replacing any existing "latest" Images in the local Image Registry.

The following is a basic procedure for upgrading a deviceWISE Gateway Image and associated Containers:

1. Using the Workbench, perform a Node back-up:

https://docs.devicewise.com/Content/Products/GatewayDevelopersGuide/Workbench/Backing-up-and-Restoring-nodes-configuration.htm⁠

1. Stop any instances of the Docker Containers tied to the current Image:

# docker stop dwag01

1. Remove the Container instances:

# docker rm dwag01

1. Using the Docker command-line utility, pull down the desired Image from Docker Hub:

# docker pull devicewise/asset-gateway

...or for a specific, new Tag:

# docker pull devicewise/asset-gateway:21.10.09

1. Launch a new Container from the updated Image:

# docker run -d --name dwag01 --net=host devicewise/asset-gateway:21.10.09

⁠Advanced Usage and Examples

Docker provides many tools and techniques to the user to allow for highly-customized deployments. Visit Docker Docs for the most complete and up-to-date information.

https://docs.docker.com/⁠

The following are a few examples which demonstrate specific deviceWISE Gateway deployment scenarios.

⁠Port Mapping with deviceWISE Gateway Containers

The deviceWISE Gateway services running in the Container listen on several ports. In the previous examples, the --net=host parameter simply mapped any port in the Container to the same port in the Host. However, it may be required to explicitly state which ports should be exposed on the Host for communication with the running Container:

https://docs.docker.com/config/containers/container-networking/⁠

In the case of using the Workbench to access the deviceWISE Gateway Container instance, UDP port 4009 and TCP port 4012 must be published to the outside world:

# docker run -d --name dwag01 -p 4009:4009/udp -p 4012:4012 devicewise/asset-gateway:21.10.09

In the above, port 4013 refers to the host machine and 4012 refers to inside the Container. The port 4012 which is inside the Container is mapped to port 4013 which is outside (host). It is possible to change the host ports and connect to multiple instances of the deviceWISE node.

Other notable ports include: