Skip to content

Commit a1cc5c2

Browse files
committed
Acrolinx review
1 parent e3ed845 commit a1cc5c2

File tree

3 files changed

+22
-15
lines changed

3 files changed

+22
-15
lines changed

articles/iot-edge/quickstart-linux.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ IoT Edge device:
5656
az vm create --resource-group IoTEdgeResources --name EdgeVM --image Canonical:UbuntuServer:16.04-LTS:latest --admin-username azureuser --generate-ssh-keys --size Standard_DS1_v2
5757
```
5858

59-
When you create a new virtual machine, make a note of the **publicIpAddress**, which is provided as part of the create command output. You use this publicIpAddress to connect to the virtual machine later in the quickstart.
59+
When you create a new virtual machine, make a note of the **publicIpAddress**, which is provided as part of the create command output. You use this public IP address to connect to the virtual machine later in the quickstart.
6060

6161
## Create an IoT hub
6262

@@ -72,7 +72,7 @@ The following code creates a free **F1** hub in the resource group **IoTEdgeReso
7272
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1
7373
```
7474

75-
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**. If you get an error that the IoT Hub name is not available, it means that someone else already has a hub with that name. Try a new name.
75+
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**. If you get an error that the IoT Hub name isn't available, it means that someone else already has a hub with that name. Try a new name.
7676

7777
## Register an IoT Edge device
7878

@@ -81,7 +81,7 @@ Register an IoT Edge device with your newly created IoT hub.
8181

8282
Create a device identity for your simulated device so that it can communicate with your IoT hub. The device identity lives in the cloud, and you use a unique device connection string to associate a physical device to a device identity.
8383

84-
Since IoT Edge devices behave and can be managed differently than typical IoT devices, you declare this to be an IoT Edge device from the beginning.
84+
Since IoT Edge devices behave and can be managed differently than typical IoT devices, declare this identity to be for an IoT Edge device with the `--edge-enabled` flag.
8585

8686
1. In the Azure cloud shell, enter the following command to create a device named **myEdgeDevice** in your hub.
8787

@@ -112,7 +112,7 @@ During the runtime configuration, you provide a device connection string. Use th
112112

113113
The steps in this section all take place on your IoT Edge device. If you're using your own machine as the IoT Edge device, you can skip this part. If you're using a virtual machine or secondary hardware, you want to connect to that machine now.
114114

115-
If you created an Azure virtual machine for this quickstart, retrieve the public IP address that was output by the creation command. If you didn't save this information earlier, you can find it by navigating to your virtual machine in the Azure portal, and reading the overview details. Use the following command to connect to your virtual machine:
115+
If you created an Azure virtual machine for this quickstart, retrieve the public IP address that was output by the creation command. You can also find the public IP address on your virtual machine's overview page in the Azure portal. Use the following command to connect to your virtual machine. Replace **{publicIpAddress}** with your machine's address.
116116

117117
```azurecli-interactive
118118
ssh azureuser@{publicIpAddress}
@@ -122,7 +122,7 @@ ssh azureuser@{publicIpAddress}
122122

123123
The packages that you need to run the IoT Edge runtime are managed in a software repository. Configure your IoT Edge device to access this repository.
124124

125-
The steps in this section are for x64 devices running **Ubuntu 16.04**. To access the software repository on other versions of Linux or device architectures, see [Install the Azure IoT Edge runtime on Linux (x64)](how-to-install-iot-edge-linux.md) or [Install Azure IoT Edge runtime on Linux (ARM32v7/armhf)](how-to-install-iot-edge-linux-arm.md).
125+
The steps in this section are for x64 devices running **Ubuntu 16.04**. To access the software repository on other versions of Linux or device architectures, see [Install the Azure IoT Edge runtime on Linux (x64)](how-to-install-iot-edge-linux.md) or [Linux (ARM32v7/armhf)](how-to-install-iot-edge-linux-arm.md).
126126

127127
1. On the machine that you're using as an IoT Edge device, install the repository configuration.
128128

@@ -171,7 +171,7 @@ The security daemon installs as a system service so that the IoT Edge runtime st
171171
sudo apt-get install iotedge
172172
```
173173

174-
2. Open the IoT Edge configuration file. It is a protected file so you may have to use elevated privileges to access it.
174+
2. Open the IoT Edge configuration file. It's a protected file so you may have to use elevated privileges to access it.
175175

176176
```bash
177177
sudo nano /etc/iotedge/config.yaml
@@ -249,15 +249,15 @@ View the messages being sent from the tempSensor module:
249249

250250
The temperature sensor module may be waiting to connect to Edge Hub if the last line you see in the log is `Using transport Mqtt_Tcp_Only`. Try killing the module and letting the Edge Agent restart it. You can kill it with the command `sudo docker stop tempSensor`.
251251

252-
You can also view the telemetry as it arrives at your IoT hub by using the [Azure IoT Toolkit extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit).
252+
You can also watch the messages arrive at your IoT hub by using the [Azure IoT Toolkit extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit).
253253

254254
## Clean up resources
255255

256256
If you want to continue on to the IoT Edge tutorials, you can use the device that you registered and set up in this quickstart. Otherwise, you can delete the Azure resources that you created and remove the IoT Edge runtime from your device.
257257

258258
### Delete Azure resources
259259

260-
If you created your virtual machine and IoT hub in a new resource group, you can delete that group and all the associated resources. If there's anything in that resource group that you want to keep, then just delete the individual resources that you want to clean up.
260+
If you created your virtual machine and IoT hub in a new resource group, you can delete that group and all the associated resources. Double check the contents of the resource group to make sure that there's nothing you want to keep. If you don't want to delete the whole group, you can delete individual resources instead.
261261

262262
Remove the **IoTEdgeResources** group.
263263

articles/iot-edge/quickstart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Try out Azure IoT Edge by running analytics on a simulated edge dev
44
author: kgremban
55
manager: philmea
66
ms.author: kgremban
7-
ms.date: 08/02/2018
7+
ms.date: 10/02/2018
88
ms.topic: quickstart
99
ms.service: iot-edge
1010
services: iot-edge
@@ -56,8 +56,8 @@ IoT Edge device:
5656
* A Windows computer or virtual machine to act as your IoT Edge device. Use a supported Windows version:
5757
* Windows 10 or newer
5858
* Windows Server 2016 or newer
59-
* If it's a Windows computer, ensure it meets the [system requirements](https://docs.microsoft.com/virtualization/hyper-v-on-windows/reference/hyper-v-requirements) for Hyper-V.
60-
* If it's a virtual machine, enable [nested virtualization](https://docs.microsoft.com/virtualization/hyper-v-on-windows/user-guide/nested-virtualization) and allocate at least 2GB memory.
59+
* If it's a Windows computer, check that it meets the [system requirements](https://docs.microsoft.com/virtualization/hyper-v-on-windows/reference/hyper-v-requirements) for Hyper-V.
60+
* If it's a virtual machine, enable [nested virtualization](https://docs.microsoft.com/virtualization/hyper-v-on-windows/user-guide/nested-virtualization) and allocate at least 2 GB memory.
6161
* Install [Docker for Windows](https://docs.docker.com/docker-for-windows/install/) and make sure it's running.
6262

6363
> [!TIP]
@@ -77,7 +77,7 @@ The following code creates a free **F1** hub in the resource group **IoTEdgeReso
7777
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1
7878
```
7979

80-
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**. If you get an error that the IoT Hub name is not available, it means that someone else already has a hub with that name. Try a new name.
80+
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**. If you get an error that the IoT Hub name isn't available, it means that someone else already has a hub with that name. Try a new name.
8181

8282
## Register an IoT Edge device
8383

@@ -86,7 +86,7 @@ Register an IoT Edge device with your newly created IoT Hub.
8686

8787
Create a device identity for your simulated device so that it can communicate with your IoT hub. The device identity lives in the cloud, and you use a unique device connection string to associate a physical device to a device identity.
8888

89-
Since IoT Edge devices behave and can be managed differently than typical IoT devices, you declare this to be an IoT Edge device from the beginning.
89+
Since IoT Edge devices behave and can be managed differently than typical IoT devices, declare this identity to be for an IoT Edge device with the `--edge-enabled` flag.
9090

9191
1. In the Azure cloud shell, enter the following command to create a device named **myEdgeDevice** in your hub.
9292

@@ -194,15 +194,15 @@ iotedge logs tempSensor -f
194194

195195
![View the data from your module](./media/quickstart/iotedge-logs.png)
196196

197-
You can also view the messages that are received by your IoT hub by using the [Azure IoT Toolkit extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit).
197+
You can also watch the messages arrive at your IoT hub by using the [Azure IoT Toolkit extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.azure-iot-toolkit).
198198

199199
## Clean up resources
200200

201201
If you want to continue on to the IoT Edge tutorials, you can use the device that you registered and set up in this quickstart. Otherwise, you can delete the Azure resources that you created and remove the IoT Edge runtime from your device.
202202

203203
### Delete Azure resources
204204

205-
If you created your virtual machine and IoT hub in a new resource group, you can delete that group and all the associated resources. If there's anything in that resource group that you want to keep, then just delete the individual resources that you want to clean up.
205+
If you created your virtual machine and IoT hub in a new resource group, you can delete that group and all the associated resources. Double check the contents of the resource group to make sure that there's nothing you want to keep. If you don't want to delete the whole group, you can delete individual resources instead.
206206

207207
Remove the **IoTEdgeResources** group.
208208

includes/iot-edge-deploy-module.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,25 @@
1313
One of the key capabilities of Azure IoT Edge is being able to deploy modules to your IoT Edge devices from the cloud. An IoT Edge module is an executable package implemented as a container. In this section, you deploy a module that generates telemetry for your simulated device.
1414

1515
1. In the Azure portal, navigate to your IoT hub.
16+
1617
2. Go to **IoT Edge** under **Automatic Device Management** and select your IoT Edge device.
18+
1719
3. Select **Set Modules**. A three-step wizard opens in the portal, which guides you through adding modules, specifying routes, and reviewing the deployment.
20+
1821
4. In the **Add Modules** step of the wizard, find the **Deployment Modules** section. Click **Add** then select **IoT Edge Module**.
1922

2023
![Add a new IoT Edge module](./media/iot-edge-deploy-module/add-module.png)
2124

2225
5. In the **Name** field, enter `tempSensor`.
26+
2327
6. In the **Image URI** field, enter `mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0`.
28+
2429
7. Leave the other settings unchanged, and select **Save**.
2530

2631
![Save IoT Edge module after entering name and image URI](./media/iot-edge-deploy-module/name-image.png)
2732

2833
8. Back in first step of the wizard, select **Next**.
34+
2935
9. In the **Specify Routes** step of the wizard, you should have a default route that sends all messages from all modules to IoT Hub. If not, add the following code then select **Next**.
3036

3137
```json
@@ -37,6 +43,7 @@ One of the key capabilities of Azure IoT Edge is being able to deploy modules to
3743
```
3844

3945
10. In the **Review Deployment** step of the wizard, select **Submit**.
46+
4047
11. Return to the device details page and select **Refresh**. In addition to the edgeAgent module that was created when you first started the service, you should see another runtime module called **edgeHub** and the **tempSensor** module listed.
4148

4249
It may take a few minutes for the new modules to show up. The IoT Edge device has to retrieve its new deployment information from the cloud, start the containers, and then report its new status back to IoT Hub.

0 commit comments

Comments
 (0)