You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-use-create-options.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ ms.custom:
21
21
22
22
The **createOptions** parameter in the deployment manifest lets you configure the module containers at runtime. This parameter expands your control over the modules and lets you perform tasks like restricting the module's access to the host device's resources or configuring networking.
23
23
24
-
IoT Edge modules run as Docker-compatible containers on your IoT Edge device. Docker offers many options for creating containers, and those options also apply to IoT Edge modules. For more information, see [Docker container create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate).
24
+
IoT Edge modules run as Docker-compatible containers on your IoT Edge device. Docker offers many options for creating containers, and those options also apply to IoT Edge modules. For more information, see [Docker container create options](https://docs.docker.com/reference/cli/docker/container/create/).
25
25
26
26
## Format create options
27
27
@@ -84,7 +84,7 @@ If your module needs to communicate with a service outside of the IoT Edge solut
84
84
85
85
First, ensure that a port inside the module is exposed to listen for connections. You can do this using an [EXPOSE](https://docs.docker.com/engine/reference/builder/#expose) instruction in the dockerfile. For example, `EXPOSE 8080`. The expose instruction defaults to TCP protocol if not specified, or you can specify UDP.
86
86
87
-
Then, use the **PortBindings** setting in the **HostConfig** group of the [Docker container create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate) to map the exposed port in the module to a port on the host device. For example, if you exposed port 8080 inside the module and want to map that to port 80 of the host device, the create options in the template.json file would look like the following example:
87
+
Then, use the **PortBindings** setting in the **HostConfig** group of the [Docker container create options](https://docs.docker.com/reference/cli/docker/container/create/) to map the exposed port in the module to a port on the host device. For example, if you exposed port 8080 inside the module and want to map that to port 80 of the host device, the create options in the template.json file would look like the following example:
88
88
89
89
```json
90
90
"createOptions": {
@@ -108,7 +108,7 @@ When stringified for the deployment manifest, the configuration looks like this:
108
108
109
109
### Restrict module memory and CPU usage
110
110
111
-
Declare how much of the host resources a module can use. This control ensures that one module doesn't consume too much memory or CPU, preventing other processes from running on the device. You can manage these settings with [Docker container create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate) in the **HostConfig** group, including:
111
+
Declare how much of the host resources a module can use. This control ensures that one module doesn't consume too much memory or CPU, preventing other processes from running on the device. You can manage these settings with [Docker container create options](https://docs.docker.com/reference/cli/docker/container/create/) in the **HostConfig** group, including:
112
112
113
113
***Memory**: Memory limit in bytes. For example, 268435456 bytes = 256 MB.
114
114
***MemorySwap**: Total memory limit (memory + swap). For example, 536870912 bytes = 512 MB.
Copy file name to clipboardExpand all lines: articles/iot-edge/module-edgeagent-edgehub.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,14 +42,14 @@ The module twin for the IoT Edge agent is called `$edgeAgent`. It coordinates co
42
42
| systemModules.edgeAgent.type | Has to be *docker*. | Yes |
43
43
| systemModules.edgeAgent.startupOrder | Specifies an integer for the module's position in the startup order. *0* is first, and *max integer* (4294967295) is last. If no value is provided, the default is *max integer*. | No |
44
44
| systemModules.edgeAgent.settings.image | Specifies the URI of the IoT Edge agent image. The IoT Edge agent can't update itself. | Yes |
45
-
| systemModules.edgeAgent.settings.createOptions | Specifies a stringified JSON with options for creating the IoT Edge agent container. Learn more about [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate). | No |
45
+
| systemModules.edgeAgent.settings.createOptions | Specifies a stringified JSON with options for creating the IoT Edge agent container. Learn more about [Docker create options](https://docs.docker.com/reference/cli/docker/container/create/). | No |
46
46
| systemModules.edgeAgent.configuration.id | The ID of the deployment that deployed this module. | IoT Hub sets this property when the manifest is applied using a deployment. Not part of a deployment manifest. |
47
47
| systemModules.edgeHub.type | Has to be *docker*. | Yes |
48
48
| systemModules.edgeHub.status | Has to be *running*. | Yes |
49
49
| systemModules.edgeHub.restartPolicy | Has to be *always*. | Yes |
50
50
| systemModules.edgeHub.startupOrder | An integer value for which spot a module has in the startup order. A *0* is first and *max integer* (4294967295) is last. If a value isn't provided, the default is *max integer*. | No |
51
51
| systemModules.edgeHub.settings.image | The URI of the image of the IoT Edge hub. | Yes |
52
-
| systemModules.edgeHub.settings.createOptions | A stringified JSON containing the options for the creation of the IoT Edge hub container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate)| No |
52
+
| systemModules.edgeHub.settings.createOptions | A stringified JSON containing the options for the creation of the IoT Edge hub container. [Docker create options](https://docs.docker.com/reference/cli/docker/container/create/)| No |
53
53
| systemModules.edgeHub.configuration.id | The ID of the deployment that deployed this module. | IoT Hub sets this property when the manifest is applied using a deployment. Not part of a deployment manifest. |
54
54
| modules.{moduleId}.version | A user-defined string representing the version of this module. | Yes |
55
55
| modules.{moduleId}.type | Has to be *docker*. | Yes |
@@ -59,7 +59,7 @@ The module twin for the IoT Edge agent is called `$edgeAgent`. It coordinates co
59
59
| modules.{moduleId}.imagePullPolicy | {*on-create*\|*never*} | No |
60
60
| modules.{moduleId}.env | A list of environment variables to pass to the module. Takes the format `"<name>": {"value": "<value>"}`. | No |
61
61
| modules.{moduleId}.settings.image | The URI to the module image. | Yes |
62
-
| modules.{moduleId}.settings.createOptions | A stringified JSON containing the options for the creation of the module container. [Docker create options](https://docs.docker.com/engine/api/v1.32/#operation/ContainerCreate)| No |
62
+
| modules.{moduleId}.settings.createOptions | A stringified JSON containing the options for the creation of the module container. [Docker create options](https://docs.docker.com/reference/cli/docker/container/create/)| No |
63
63
| modules.{moduleId}.configuration.id | The ID of the deployment that deployed this module. | IoT Hub sets this property when the manifest is applied using a deployment. Not part of a deployment manifest. |
64
64
| version | The current iteration that has version, commit, and build. | No |
0 commit comments