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
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.
21
18
22
19
## *module.json* settings
23
20
24
-
The *module.json* file includes the following settings:
21
+
The *module.json* file has these settings:
25
22
26
23
| Setting | Description |
27
24
|---|---|
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. |
30
27
| 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. |
34
31
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:
36
33
37
34
```json
38
35
{
@@ -59,10 +56,8 @@ For example, the following *module.json* file is for a C# IoT Edge module:
59
56
}
60
57
```
61
58
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`.
65
60
66
-
## Next step
61
+
## Next steps
67
62
68
63
[Understand the requirements and tools for developing IoT Edge modules](module-development.md)
0 commit comments