Skip to content

Commit 8578cf9

Browse files
committed
Freshness review
1 parent 86f11b1 commit 8578cf9

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

articles/iot-edge/how-to-configure-module-build-options.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to use the module.json file to configure build and deploy
44
author: PatAltimore
55

66
ms.author: patricka
7-
ms.date: 05/31/2024
7+
ms.date: 06/05/2025
88
ms.topic: how-to
99
ms.service: azure-iot-edge
1010
services: iot-edge
@@ -14,25 +14,22 @@ services: iot-edge
1414

1515
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1616

17-
The *module.json* file controls how modules are built and deployed. IoT Edge module Visual Studio
18-
and Visual Studio Code projects include the *module.json* file. The file contains IoT Edge module
19-
configuration details including the version and platform that is used when building an IoT Edge
20-
module.
17+
The *module.json* file controls how modules are built and deployed. IoT Edge module projects in Visual Studio and Visual Studio Code include the *module.json* file. This file has configuration details for the IoT Edge module, like the version and platform used when building the module.
2118

2219
## *module.json* settings
2320

24-
The *module.json* file includes the following settings:
21+
The *module.json* file has these settings:
2522

2623
| Setting | Description |
2724
|---|---|
28-
| image.repository | The repository of the module. |
29-
| image.tag.version | The version of the module. |
25+
| image.repository | The module repository. |
26+
| image.tag.version | The module version. |
3027
| image.tag.platforms | A list of supported platforms and their corresponding dockerfile. Each entry is a platform key and dockerfile pair `<platform key>:<dockerfile>`. |
31-
| image.buildOptions | The build arguments used when running `docker build`. |
32-
| image.contextPath | The context path used when running `docker build`. By default, it's the current folder of the *module.json* file. If your Docker build needs files not included in the current folder such as a reference to an external package or project, set the **contextPath** to the root path of all necessary files. Verify the files are copied in the dockerfile. |
33-
| language | The programming language of the module. |
28+
| image.buildOptions | Build arguments used when running `docker build`. |
29+
| image.contextPath | The context path used when running `docker build`. By default, it's the current folder of the *module.json* file. If your Docker build needs files not included in the current folder, like a reference to an external package or project, set **contextPath** to the root path of all necessary files. Verify the files are copied in the dockerfile. |
30+
| language | The module programming language. |
3431

35-
For example, the following *module.json* file is for a C# IoT Edge module:
32+
For example, this *module.json* file is for a C# IoT Edge module:
3633

3734
```json
3835
{
@@ -59,10 +56,8 @@ For example, the following *module.json* file is for a C# IoT Edge module:
5956
}
6057
```
6158

62-
Once the module is built, the final tag of the image is combined with both version and platform as
63-
`<repository>:<version>-<platform key>`. For this example, the image tag for `amd64.debug` is
64-
`localhost:5000/csharpmod:0.0.1-amd64.debug`.
59+
After you build the module, the final image tag combines the version and platform as `<repository>:<version>-<platform key>`. For this example, the image tag for `amd64.debug` is `localhost:5000/csharpmod:0.0.1-amd64.debug`.
6560

66-
## Next step
61+
## Next steps
6762

6863
[Understand the requirements and tools for developing IoT Edge modules](module-development.md)

0 commit comments

Comments
 (0)