How to configure individual modules for 100+ edge devices

Question

I have 100+ edge devices with multiple modules, managed by an automatic deployment. Each device has it's own characteristics, like max allowed values. We also have an external module which requires account credentials (id/password/certificate/key) unique for each device.

I tried:

update the module twin directly/manually, but this fails as we use automated deployment for all other settings and configuration, see IotEdge module twin update gets reverted
using module twin updates with layered deployments. This works, however we have to create a layered deployment for each device. Only 100 deployments are supported by iot hub, so not scalable.

How can I get this this done? Does IoT Edge have a recommended approach / support / workaround for this? Or should we build something our self?

Example of the layered deployment to enable the external module and set the property defaults:

"content": {
    "modulesContent": {
        "$edgeAgent": {
            "properties.desired.modules.externalModule1": {
                "settings": {
                    "image": "123.azurecr.io/externalModule1:0.1.12",
                    "createOptions": "{\"NetworkingConfig\":{\"EndpointsConfig\":{\"host\":{}}},\"HostConfig\":{\"NetworkMode\":\"host\",\"LogConfig\":{\"Type\":\"json-file\",\"Config\":{\"max-size\":\"10m\",\"max-file\":\"3\"}}}}"
                },
                "type": "docker",
                "status": "running",
                "restartPolicy": "always",
                "version": "1.0"
            }
        },
        "externalModule1": {
            "properties.desired": {
                "MaxChargePower": 5000,
                "MaxDischargePower": 10000
            }
        }
    }
  }
}

Example of the layered deployment to set the device specific values:

{
  "content": {
    "modulesContent": {
        "$edgeAgent": {},
        "externalModule1": {       
          "properties.desired.MaxChargePower": 6000,
          "properties.desired.MaxDischargePower": 15000,
          "properties.desired.iotpool_account": {
            "iotpool_id" : "<insert iotpool id>",
            "iotpool_password" : "<insert iotpool password>",
            "cert" : "<insert cert>",
            "key" : "<insert key>"
          }
        }
    }
  }
}

Do you have the ability to modify code for the module that needs to perform device specific behavior? — Venkat Yalla, Jun 19 '20 at 19:09
How are you setting the module twin in the base deployment? Can you share a snippet? — Venkat Yalla, Jun 26 '20 at 19:12
@VenkatYalla I've updated the questing with the deployment json we are using a the moment. — William, Jun 28 '20 at 18:07

Venkat Yalla · Accepted Answer · 2023-02-15T01:25:25.997

You can modify the module twin directly per-device without having an automatic deployment targeting the device overriding it.

The key is to reference a specific section of the desired properties in the automatic deployment (base or layered). In your example -

"content": {
    "modulesContent": {
        "$edgeAgent": {
            "properties.desired.modules.externalModule1": {
                "settings": {
                    "image": "123.azurecr.io/externalModule1:0.1.12",
                    "createOptions": "{\"NetworkingConfig\":{\"EndpointsConfig\":{\"host\":{}}},\"HostConfig\":{\"NetworkMode\":\"host\",\"LogConfig\":{\"Type\":\"json-file\",\"Config\":{\"max-size\":\"10m\",\"max-file\":\"3\"}}}}"
                },
                "type": "docker",
                "status": "running",
                "restartPolicy": "always",
                "version": "1.0"
            }
        },
        "externalModule1": {
            "properties.desired": {
                "MaxChargePower": 5000,
                "MaxDischargePower": 10000
            }
        }
    }
  }
}

changes to..

"content": {
    "modulesContent": {
        "$edgeAgent": {
            "properties.desired.modules.externalModule1": {
                "settings": {
                    "image": "123.azurecr.io/externalModule1:0.1.12",
                    "createOptions": "{\"NetworkingConfig\":{\"EndpointsConfig\":{\"host\":{}}},\"HostConfig\":{\"NetworkMode\":\"host\",\"LogConfig\":{\"Type\":\"json-file\",\"Config\":{\"max-size\":\"10m\",\"max-file\":\"3\"}}}}"
                },
                "type": "docker",
                "status": "running",
                "restartPolicy": "always",
                "version": "1.0"
            }
        },
        "externalModule1" {
            "properties.desired.powerSettings": {
                "MaxChargePower": 5000,
                "MaxDischargePower": 10000
            }
        }
    }
}

Now you can specialize per-device using the module twin without having it overwritten. You don't need to use nested deployments so you won't run into the number of deployments limit:

          "properties.desired.iotpool_account": {
            "iotpool_id" : "<insert iotpool id>",
            "iotpool_password" : "<insert iotpool password>",
            "cert" : "<insert cert>",
            "key" : "<insert key>"
          }

There is a mistake in the "change to"-json, which makes it an invalid json. The module name "externalModule1" needs to be a separate key in the JSON, which has a child "properties.desirred.powerSettings" — Thijs, Jun 24 '22 at 09:36

How to configure individual modules for 100+ edge devices

1 Answers1

Linked