Deploy Bosch IoT Gateway Software as an Edge Module

Prerequisites

• Setup Azure IoT Edge device
• Create a container registry

Generate Bosch IoT Gateway Software image

• Setup Eclipse Plugins
• Provide board extensions
• Generate a Target Image based on the provided Image Descriptor

Build Docker image

Go to the folder where Dockerfile is located and push the image to the registry.

• Login (sudo docker login <scrLoginServer>)
• Build (sudo docker build -t <module_name> .)
• Tag (sudo docker tag <module_name> <scrLoginServer>/<module_name>:<module_version>)
• Push (sudo docker push <scrLoginServer>/<module_name>:<module_version>)
• List container images

Deploy Bosch IoT Gateway Software on the Edge device

• Configure the deployment manifest

Configure to establish the connection to the IoT Hub and Edge runtime

The user have to provide configuration information to establish the connection to the Azure IoT Hub and Edge runtime. There are three system properties:

• mbs.azure.iot.connectionString - this property contains the IoT Hub connection String. The user is need to provide the connection string to enable the application to perform operations on the IoT Hub such as adding devices to the IoT Hub.
• mbs.azure.iot.gatewayHostname - this property contains the hostname assign to the machine where Edge runtime is running. The user is need to provide the hostaname to redirect the messaging and twin updates through the Edge. This property is optional. If this property is not provided messages and twin updates are send to the IoT Hub directly.
• mbs.azure.iot.edge.pathToCertificate - this property contains the location to the certificates used by the Edge runtime (trusted_ca_certs). The user is need to provide the path to certificates to authenticate the downstream device with IoT Hub.

There are two ways to specify these system properties. From the Azure portal and from default.prs binvms/<vm_name> in the runtime installation.

If you would like to use the Azure IoT Integration without setting up an Azure IoT Edge device, Bosch IoT Gateway can communicate with Azure IoT Hub. In such case, these system properties need to be added in the default.prs binvms/<vm_name> in the runtime installation.

From the Azure portal

Configure the deployment manifest. Open the Container Create Options and provide the following JSON

{

  "Env": [

    "VM_ARGS=-Dmbs.azure.iot.connectionString=<IoT_Hub_Connection_String> -Dmbs.azure.iot.edge.gatewayHostname=<Gateway_HostName> -Dmbs.azure.iot.edge.pathToCertificate=<Path_To_Sertificate>"

  ],

  "Mounts": [

    {

      "Type": "bind",

      "Source": "<path_to_the_directory_on_the_Docker_daemon_host>",

      "Destination": "<path_to_the_directory_mounted_in_the_container>",

      "Mode": "",

      "RW": true,

      "Propagation": "rprivate"

    }

  ],

  "NetworkingConfig": {

    "EndpointsConfig": {

      "host": {}

    }

  },

  "HostConfig": {

    "Privileged": true,

    "NetworkMode": "host",

    "Binds": [

      "<path_to_the_directory_on_the_Docker_daemon_host>:<path_to_the_directory_mounted_in_the_container>"

    ]

  }

}

Configure Bosch IoT Gateway Software network services

To provide access to the Telnet and Web Admin Console functionality the user needs to bind the container ports to the host port. The JSON object in the form { <port>/<protocol>: [{"HostPort": "<port>"}]}. The Telnet port is 23. The Web Admin Console uses the default HTTP port 80.