Skip to content

Commit 97e6515

Browse files
committed
Acrolinx
1 parent 7c172b8 commit 97e6515

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

articles/iot-edge/configure-template.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
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.
44
author: PatAltimore
55
ms.author: patricka
66
ms.date: 02/27/2023
@@ -9,9 +9,9 @@ ms.service: iot-edge
99
services: iot-edge
1010
---
1111

12-
# Configure IoT Edge using the config.toml file
12+
# Configure IoT Edge device settings
1313

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.
1515

1616
A template containing all options can be found in the *config.toml.template* file within the `/etc/aziot` directory on an IoT Edge device.
1717

@@ -43,7 +43,7 @@ For more information about setting the *parent_hostname* parameter, see [Connect
4343

4444
## Trust bundle certificate
4545

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.
4747

4848
```toml
4949
trust_bundle_cert = "file:///var/aziot/certs/trust-bundle.pem"
@@ -69,7 +69,7 @@ This property specifies the conditions that the device attempts to automatically
6969

7070
| Mode | Description |
7171
|------|-------------|
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. |
7373
| AlwaysOnStartup | Reprovision when the device is rebooted or a crash causes the daemons to restart. |
7474
| 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. |
7575

@@ -87,7 +87,7 @@ These settings control the timeout and retries for cloud operations, such as com
8787

8888
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.
8989

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.
9191

9292
```toml
9393
cloud_timeout_sec = 10
@@ -185,7 +185,7 @@ subject = { L = "AQ", ST = "Antarctica", CN = "my-device" } # with the given DN
185185

186186
### Enable automatic renewal of the device ID certificate
187187

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'.
189189

190190
>[!IMPORTANT]
191191
> 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"
350350

351351
### Optional EST configuration for issuing the Edge CA certificate
352352

353-
If not set, the defaults in [cert_issuance.est] is used.
353+
If not set, the defaults in [cert_issuance.est] are used.
354354

355355
```toml
356356
common_name = "aziot-edge CA"
@@ -406,7 +406,7 @@ auto_generated_edge_ca_expiry_days = 90
406406

407407
## Edge CA certificate autorenewal
408408

409-
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.
410410

411411
> [!IMPORTANT]
412412
> 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

Comments
 (0)