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/configure-template.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Configure IoT Edge using the config.toml file
3
-
description: This article shows you how to configure the config.toml file for IoT Edge.
2
+
title: Configure IoT Edge device settings
3
+
description: This article shows you how to configure IoT Edge device settings and options using the config.toml file.
4
4
author: PatAltimore
5
5
ms.author: patricka
6
6
ms.date: 02/27/2023
@@ -9,9 +9,9 @@ ms.service: iot-edge
9
9
services: iot-edge
10
10
---
11
11
12
-
# Configure IoT Edge using the config.toml file
12
+
# Configure IoT Edge device settings
13
13
14
-
This article shows settings and options for configuring the IoT Edge *config.toml* file found in the `/etc/aziot` directory on an IoT Edge device. IoT Edge uses the *config.toml* to initialize settings for the device. Each of the sections of the `config.toml` file has several options. Not all options are mandatory, as they apply to specific scenarios.
14
+
This article shows settings and options for configuring the IoT Edge *config.toml* file found in the `/etc/aziot` directory on an IoT Edge device. IoT Edge uses the *config.toml*file to initialize settings for the device. Each of the sections of the `config.toml` file has several options. Not all options are mandatory, as they apply to specific scenarios.
15
15
16
16
A template containing all options can be found in the *config.toml.template* file within the `/etc/aziot` directory on an IoT Edge device.
17
17
@@ -43,7 +43,7 @@ For more information about setting the *parent_hostname* parameter, see [Connect
43
43
44
44
## Trust bundle certificate
45
45
46
-
Using a self-signed certificate authority (CA) certificate as a root of trust with IoT Edge and modules is known as trust bundle. If you are using a trust bundle, update the **trust_bundle_cert** parameter with the file URI to the root CA certificate on your device.
46
+
Using a self-signed certificate authority (CA) certificate as a root of trust with IoT Edge and modules is known as trust bundle. If you're using a trust bundle, update the **trust_bundle_cert** parameter with the file URI to the root CA certificate on your device.
@@ -69,7 +69,7 @@ This property specifies the conditions that the device attempts to automatically
69
69
70
70
| Mode | Description |
71
71
|------|-------------|
72
-
| Dynamic | Reprovision when the device detects that it may have been moved from one IoT Hub to another. This is the default. |
72
+
| Dynamic | Reprovision when the device detects that it may have been moved from one IoT Hub to another. This mode is the default. |
73
73
| AlwaysOnStartup | Reprovision when the device is rebooted or a crash causes the daemons to restart. |
74
74
| OnErrorOnly | Never trigger device reprovisioning automatically. Device reprovisioning only occurs as fallback, if the device is unable to connect to IoT Hub during identity provisioning due to connectivity errors. This fallback behavior is implicit in Dynamic and AlwaysOnStartup modes as well. |
75
75
@@ -87,7 +87,7 @@ These settings control the timeout and retries for cloud operations, such as com
87
87
88
88
The **cloud_timeout_sec** parameter is the deadline in seconds for a network request to cloud services. For example, an HTTP request. A response from the cloud service must be received before this deadline, or the request fails as a timeout.
89
89
90
-
The **cloud_retries** parameter controls how many times a request may be retried after the first try fails. The client always sends at least once, so the value is number of retries after the first try fails. For example, `cloud_retries = 2` means that the client makes a total of 3 attempts).
90
+
The **cloud_retries** parameter controls how many times a request may be retried after the first try fails. The client always sends at least once, so the value is number of retries after the first try fails. For example, `cloud_retries = 2` means that the client makes a total of three attempts.
91
91
92
92
```toml
93
93
cloud_timeout_sec = 10
@@ -185,7 +185,7 @@ subject = { L = "AQ", ST = "Antarctica", CN = "my-device" } # with the given DN
185
185
186
186
### Enable automatic renewal of the device ID certificate
187
187
188
-
Autorenewal requires a known certificate issuance method. This means that 'method' is either 'est' or 'local_ca'.
188
+
Autorenewal requires a known certificate issuance method. Set **method** to either 'est' or 'local_ca'.
189
189
190
190
>[!IMPORTANT]
191
191
> Only enable autorenewal if this device is configured for CA-based DPS enrollment. Using autorenewal for an individual enrollment causes the device to be unable to reprovision.
@@ -350,7 +350,7 @@ method = "est"
350
350
351
351
### Optional EST configuration for issuing the Edge CA certificate
352
352
353
-
If not set, the defaults in [cert_issuance.est]is used.
353
+
If not set, the defaults in [cert_issuance.est]are used.
This setting manages autorenewal of the Edge CA certificate. This applies when the Edge CA is configured as *quickstart* or when the Edge CA has an issuance `method` set. Edge CA certificates loaded from files generally can't be autorenewed as the Edge runtime won't have enough information to renew them.
409
+
This setting manages autorenewal of the Edge CA certificate. Autorenewal applies when the Edge CA is configured as *quickstart* or when the Edge CA has an issuance `method` set. Edge CA certificates loaded from files generally can't be autorenewed as the Edge runtime doesn't have enough information to renew them.
410
410
411
411
> [!IMPORTANT]
412
412
> Renewal of an Edge CA requires all server certificates issued by that CA to be regenerated. This regeneration is done by restarting all modules. The time of Edge CA renewal can't be guaranteed. If random module restarts are unacceptable for your use case, disable autorenewal.
0 commit comments