Skip to content

Commit 149a291

Browse files
authored
Merge pull request #101958 from kgremban/jan22-bulkformatting
Bulk formatting and acrolinx updates
2 parents 54d957e + e11c711 commit 149a291

15 files changed

+302
-292
lines changed

articles/iot-edge/how-to-authenticate-downstream-device.md

Lines changed: 40 additions & 45 deletions
Large diffs are not rendered by default.

articles/iot-edge/how-to-deploy-blob.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Azure portal guides you through creating a deployment manifest and pushing t
3232

3333
### Configure a deployment manifest
3434

35-
A deployment manifest is a JSON document that describes which modules to deploy, how data flows between the modules, and desired properties of the module twins. The Azure portal has a wizard that walks you through creating a deployment manifest, instead of building the JSON document manually. It has three steps organized into tabs: **Modules**, **Routes**, and **Review + Create**.
35+
A deployment manifest is a JSON document that describes which modules to deploy, how data flows between the modules, and desired properties of the module twins. The Azure portal has a wizard that walks you through creating a deployment manifest. It has three steps organized into tabs: **Modules**, **Routes**, and **Review + Create**.
3636

3737
#### Add modules
3838

@@ -52,11 +52,11 @@ A deployment manifest is a JSON document that describes which modules to deploy,
5252
> [!IMPORTANT]
5353
> Azure IoT Edge is case-sensitive when you make calls to modules, and the Storage SDK also defaults to lowercase. Although the name of the module in the [Azure Marketplace](how-to-deploy-modules-portal.md#deploy-modules-from-azure-marketplace) is **AzureBlobStorageonIoTEdge**, changing the name to lowercase helps to ensure that your connections to the Azure Blob Storage on IoT Edge module aren't interrupted.
5454
55-
3. On the **Container Create Options** tab, you will provide JSON code to provide storage account information and a mount for the storage on your device.
55+
3. Open the **Container Create Options** tab.
5656

5757
![Module Twin Settings](./media/how-to-deploy-blob/addmodule-tab3.png)
5858

59-
Copy and paste the following JSON into the box, referring to the placeholder descriptions in the next step.
59+
Copy and paste the following JSON into the box, to provide storage account information and a mount for the storage on your device.
6060

6161
```json
6262
{
@@ -75,21 +75,21 @@ A deployment manifest is a JSON document that describes which modules to deploy,
7575
}
7676
```
7777

78-
4. Update the JSON that you copied for **Container Create Options** with the following information:
78+
4. Update the JSON that you copied into **Container Create Options** with the following information:
7979

8080
- Replace `<your storage account name>` with a name that you can remember. Account names should be 3 to 24 characters long, with lowercase letters and numbers. No spaces.
8181

8282
- Replace `<your storage account key>` with a 64-byte base64 key. You can generate a key with tools like [GeneratePlus](https://generate.plus/en/base64). You'll use these credentials to access the blob storage from other modules.
8383

84-
- Replace `<storage mount>` according to your container operating system. Provide the name of a [volume](https://docs.docker.com/storage/volumes/) or the absolute path to a directory on your IoT Edge device where you want the blob module to store its data. The storage mount maps a location on your device that you provide to a set location in the module.
84+
- Replace `<storage mount>` according to your container operating system. Provide the name of a [volume](https://docs.docker.com/storage/volumes/) or the absolute path to an existing directory on your IoT Edge device where the blob module will store its data. The storage mount maps a location on your device that you provide to a set location in the module.
8585

8686
- For Linux containers, the format is *\<storage path or volume>:/blobroot*. For example
8787
- use [volume mount](https://docs.docker.com/storage/volumes/): **my-volume:/blobroot**
8888
- use [bind mount](https://docs.docker.com/storage/bind-mounts/): **/srv/containerdata:/blobroot**. Make sure to follow the steps to [grant directory access to the container user](how-to-store-data-blob.md#granting-directory-access-to-container-user-on-linux)
8989
- For Windows containers, the format is *\<storage path or volume>:C:/BlobRoot*. For example
9090
- use [volume mount](https://docs.docker.com/storage/volumes/): **my-volume:C:/blobroot**.
9191
- use [bind mount](https://docs.docker.com/storage/bind-mounts/): **C:/ContainerData:C:/BlobRoot**.
92-
- Instead of using your local drive, you can map your SMB network location, for more information see [using SMB share as your local storage](how-to-store-data-blob.md#using-smb-share-as-your-local-storage)
92+
- Instead of using your local drive, you can map your SMB network location, for more information, see [using SMB share as your local storage](how-to-store-data-blob.md#using-smb-share-as-your-local-storage)
9393

9494
> [!IMPORTANT]
9595
> Do not change the second half of the storage mount value, which points to a specific location in the module. The storage mount should always end with **:/blobroot** for Linux containers and **:C:/BlobRoot** for Windows containers.
@@ -256,6 +256,7 @@ Edit **Container Create Options** (in the Azure portal) or the **createOptions**
256256
When you connect to additional blob storage modules, change the endpoint to point to the updated host port.
257257

258258
## Next steps
259+
259260
Learn more about [Azure Blob Storage on IoT Edge](how-to-store-data-blob.md)
260261

261262
For more information about how deployment manifests work and how to create them, see [Understand how IoT Edge modules can be used, configured, and reused](module-composition.md).

articles/iot-edge/how-to-install-iot-edge-linux.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ ms.author: kgremban
1515

1616
The Azure IoT Edge runtime is what turns a device into an IoT Edge device. The runtime can be deployed on devices as small as a Raspberry Pi or as large as an industrial server. Once a device is configured with the IoT Edge runtime, you can start deploying business logic to it from the cloud. To learn more, see [Understand the Azure IoT Edge runtime and its architecture](iot-edge-runtime.md).
1717

18-
This article lists the steps to install the Azure IoT Edge runtime on an X64, ARM32, or ARM64 Linux device. Installation packages are provided for Ubuntu Server 16.04, Ubuntu Server 18.04, and Raspbian Stretch. Refer to [Azure IoT Edge supported systems](support.md#operating-systems) for a list of supported Linux operating systems and architectures.
19-
20-
>[!NOTE]
21-
>Support for ARM64 devices is in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
18+
This article lists the steps to install the Azure IoT Edge runtime on an X64, ARM32, or ARM64 Linux device. We provide installation packages for Ubuntu Server 16.04, Ubuntu Server 18.04, and Raspbian Stretch. Refer to [Azure IoT Edge supported systems](support.md#operating-systems) for a list of supported Linux operating systems and architectures.
2219

2320
> [!NOTE]
2421
> Packages in the Linux software repositories are subject to the license terms located in each package (/usr/share/doc/*package-name*). Read the license terms prior to using the package. Your installation and use of the package constitutes your acceptance of these terms. If you do not agree with the license terms, do not use the package.
@@ -27,6 +24,9 @@ This article lists the steps to install the Azure IoT Edge runtime on an X64, AR
2724

2825
Use the following sections to install the most recent version of the Azure IoT Edge runtime onto your device.
2926

27+
>[!NOTE]
28+
>Support for ARM64 devices is in [public preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
29+
3030
### Register Microsoft key and software repository feed
3131

3232
Prepare your device for the IoT Edge runtime installation.
@@ -66,9 +66,9 @@ Install Microsoft GPG public key
6666

6767
### Install the container runtime
6868

69-
Azure IoT Edge relies on an [OCI-compatible](https://www.opencontainers.org/) container runtime. For production scenarios, we recommended that you use the [Moby-based](https://mobyproject.org/) engine provided below. It is the only container engine officially supported with Azure IoT Edge. Docker CE/EE container images are compatible with the Moby runtime.
69+
Azure IoT Edge relies on an [OCI-compatible](https://www.opencontainers.org/) container runtime. For production scenarios, we recommended that you use the [Moby-based](https://mobyproject.org/) engine provided below. The Moby engine is the only container engine officially supported with Azure IoT Edge. Docker CE/EE container images are compatible with the Moby runtime.
7070

71-
Perform apt update.
71+
Update package lists on your device.
7272

7373
```bash
7474
sudo apt-get update
@@ -86,15 +86,15 @@ Install the Moby command-line interface (CLI). The CLI is useful for development
8686
sudo apt-get install moby-cli
8787
```
8888

89-
If you encounter errors when installing the Moby container runtime, follow the steps to [Verify your Linux kernel for Moby compatibility](#verify-your-linux-kernel-for-moby-compatibility), provided later in this article.
89+
If you get errors when installing the Moby container runtime, follow the steps to [Verify your Linux kernel for Moby compatibility](#verify-your-linux-kernel-for-moby-compatibility), provided later in this article.
9090

9191
### Install the Azure IoT Edge Security Daemon
9292

9393
The **IoT Edge security daemon** provides and maintains security standards on the IoT Edge device. The daemon starts on every boot and bootstraps the device by starting the rest of the IoT Edge runtime.
9494

9595
The installation command also installs the standard version of the **libiothsm** if not already present.
9696

97-
Perform apt update.
97+
Update package lists on your device.
9898

9999
```bash
100100
sudo apt-get update
@@ -106,53 +106,53 @@ Install the security daemon. The package is installed at `/etc/iotedge/`.
106106
sudo apt-get install iotedge
107107
```
108108

109-
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the [Configure the security daemon](#configure-the-security-daemon) section to finish provisioning your device.
109+
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the [Configure the security daemon](#configure-the-security-daemon) section to complete device provisioning.
110110

111111
## Install a specific runtime version
112112

113113
If you want to install a specific version of Moby and the Azure IoT Edge runtime instead of using the latest versions, you can target the component files directly from the IoT Edge GitHub repository. Use the following steps to get all of the IoT Edge components onto your device: the Moby engine and CLI, the libiothsm, and finally the IoT Edge security daemon. Skip to the next section, [Configure the security daemon](#configure-the-security-daemon), if you do not want to change to a specific runtime version.
114114

115-
1. Navigate to the [Azure IoT Edge releases](https://github.com/Azure/azure-iotedge/releases), and find the release version that you want to target.
115+
1. Navigate to the [Azure IoT Edge releases](https://github.com/Azure/azure-iotedge/releases), and find the release version that you want to target.
116116

117117
2. Expand the **Assets** section for that version.
118118

119-
3. There may or may not be updates to the Moby engine in any given release. If you see files that start with **moby-engine** and **moby-cli**, use the following commands to update those components. If you don't see any Moby files, go back through the older release assets until you find the most recent version.
119+
3. There may or may not be updates to the Moby engine in any given release. If you see files that start with **moby-engine** and **moby-cli**, use the following commands to update those components. If you don't see any Moby files, go back through the older release assets until you find the most recent version.
120120

121121
1. Find the **moby-engine** file that matches your IoT Edge device's architecture. Right-click on the file link and copy the link address.
122122

123-
2. Use the copied link in the following command to install that version of the Moby engine:
123+
2. Use the copied link in the following command to install that version of the Moby engine:
124124

125125
```bash
126126
curl -L <moby-engine link> -o moby_engine.deb && sudo dpkg -i ./moby_engine.deb
127127
```
128128

129-
3. Find the **moby-cli** file that matches your IoT Edge device's architecture. The Moby CLI is an optional component, but can be helpful during development. Right-click on the file link and copy the link address.
129+
3. Find the **moby-cli** file that matches your IoT Edge device's architecture. The Moby CLI is an optional component, but can be helpful during development. Right-click on the file link and copy the link address.
130130
131-
4. Use the copied link in the following command to install that version of the Moby CLI:
131+
4. Use the copied link in the following command to install that version of the Moby CLI:
132132
133133
```bash
134134
curl -L <moby-cli link> -o moby_cli.deb && sudo dpkg -i ./moby_cli.deb
135135
```
136136
137-
4. Every release should have new files for the IoT Edge security daemon and the hsmlib. Use the following commands to update those components.
137+
4. Every release should have new files for the IoT Edge security daemon and the hsmlib. Use the following commands to update those components.
138138
139-
1. Find the **libiothsm-std** file that matches your IoT Edge device's architecture. Right-click on the file link and copy the link address.
139+
1. Find the **libiothsm-std** file that matches your IoT Edge device's architecture. Right-click on the file link and copy the link address.
140140

141141
2. Use the copied link in the following command to install that version of the hsmlib:
142142

143143
```bash
144144
curl -L <libiothsm-std link> -o libiothsm-std.deb && sudo dpkg -i ./libiothsm-std.deb
145145
```
146146

147-
3. Find the **iotedge** file that matches your IoT Edge device's architecture. Right-click on the file link and copy the link address.
147+
3. Find the **iotedge** file that matches your IoT Edge device's architecture. Right-click on the file link and copy the link address.
148148
149-
4. Use the copied link in the following command to install that version of the IoT Edge security daemon.
149+
4. Use the copied link in the following command to install that version of the IoT Edge security daemon.
150150
151151
```bash
152152
curl -L <iotedge link> -o iotedge.deb && sudo dpkg -i ./iotedge.deb
153153
```
154154
155-
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the next section to finish provisioning your device.
155+
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the next section to complete device provisioning.
156156
157157
## Configure the security daemon
158158
@@ -258,7 +258,7 @@ Examine daemon logs:
258258
journalctl -u iotedge --no-pager --no-full
259259
```
260260
261-
Run an automated check for the most common configuration and networking errors:
261+
Run an automated check for the most common configuration and networking errors:
262262
263263
```bash
264264
sudo iotedge check
@@ -292,8 +292,7 @@ Many embedded device manufacturers ship device images that contain custom Linux
292292
./check-config.sh
293293
```
294294
295-
This will provide a detailed output that contains the status of kernel features that are used by the Moby runtime. You will want to ensure that all items under `Generally Necessary` and `Network Drivers` are enabled to ensure that your kernel is fully compatible with the Moby runtime. If you have identified any missing features, enable them by rebuilding your kernel from source and selecting the associated modules for inclusion in the appropriate kernel .config. Similarly, if you are using a kernel configuration generator like defconfig or menuconfig, find and enable the respective features and rebuild your kernel accordingly. Once you have deployed your newly modified kernel, run the check-config script again to verify that all the required features were successfully enabled.
296-
295+
This command provides a detailed output that contains the status of kernel features that are used by the Moby runtime. You will want to ensure that all items under `Generally Necessary` and `Network Drivers` are enabled to ensure that your kernel is fully compatible with the Moby runtime. If you have identified any missing features, enable them by rebuilding your kernel from source and selecting the associated modules for inclusion in the appropriate kernel .config. Similarly, if you are using a kernel configuration generator like defconfig or menuconfig, find and enable the respective features and rebuild your kernel accordingly. Once you have deployed your newly modified kernel, run the check-config script again to verify that all the required features were successfully enabled.
297296
298297
## Uninstall IoT Edge
299298
@@ -305,7 +304,7 @@ Remove the IoT Edge runtime.
305304
sudo apt-get remove --purge iotedge
306305
```
307306
308-
When the IoT Edge runtime is removed, the container that it created are stopped but still exist on your device. View all containers to see which ones remain.
307+
When the IoT Edge runtime is removed, the containers that it created are stopped but still exist on your device. View all containers to see which ones remain.
309308
310309
```bash
311310
sudo docker ps -a

0 commit comments

Comments
 (0)