Skip to content

Commit e3ed845

Browse files
committed
Improve clarity of quickstarts
1 parent 105f0fd commit e3ed845

File tree

4 files changed

+42
-27
lines changed

4 files changed

+42
-27
lines changed

articles/iot-edge/quickstart-linux.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,11 @@ description: In this quickstart, learn how to deploy prebuilt code remotely to a
44
author: kgremban
55
manager: philmea
66
ms.author: kgremban
7-
ms.date: 08/14/2018
7+
ms.date: 10/14/2018
88
ms.topic: quickstart
99
ms.service: iot-edge
1010
services: iot-edge
1111
ms.custom: mvc
12-
13-
experimental: true
14-
experiment_id: 21cb7321-bcff-4b
1512
---
1613

1714
# Quickstart: Deploy your first IoT Edge module to a Linux x64 device
@@ -56,9 +53,11 @@ IoT Edge device:
5653
* A Linux device or virtual machine to act as your IoT Edge device. If you want to create a virtual machine in Azure, use the following command to get started quickly:
5754

5855
```azurecli-interactive
59-
az vm create --resource-group IoTEdgeResources --name EdgeVM --image Canonical:UbuntuServer:16.04-LTS:latest --admin-username azureuser --generate-ssh-keys --size Standard_B1ms
56+
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
6057
```
6158

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.
60+
6261
## Create an IoT hub
6362

6463
Start the quickstart by creating your IoT hub with Azure CLI.
@@ -73,7 +72,7 @@ The following code creates a free **F1** hub in the resource group **IoTEdgeReso
7372
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1
7473
```
7574

76-
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**.
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.
7776

7877
## Register an IoT Edge device
7978

@@ -90,13 +89,15 @@ Since IoT Edge devices behave and can be managed differently than typical IoT de
9089
az iot hub device-identity create --hub-name {hub_name} --device-id myEdgeDevice --edge-enabled
9190
```
9291

93-
1. Retrieve the connection string for your device, which links your physical device with its identity in IoT Hub.
92+
If you get an error about iothubowner policy keys, make sure that your cloud shell is running the latest version of the azure-cli-iot-ext extension.
93+
94+
2. Retrieve the connection string for your device, which links your physical device with its identity in IoT Hub.
9495

9596
```azurecli-interactive
9697
az iot hub device-identity show-connection-string --device-id myEdgeDevice --hub-name {hub_name}
9798
```
9899

99-
1. Copy the connection string and save it. You'll use this value to configure the IoT Edge runtime in the next section.
100+
3. Copy the connection string and save it. You'll use this value to configure the IoT Edge runtime in the next section.
100101

101102
## Install and start the IoT Edge runtime
102103

@@ -107,7 +108,15 @@ The IoT Edge runtime is deployed on all IoT Edge devices. It has three component
107108

108109
During the runtime configuration, you provide a device connection string. Use the string that you retrieved from the Azure CLI. This string associates your physical device with the IoT Edge device identity in Azure.
109110

110-
Complete the following steps in the Linux machine or VM that you prepared to function as an IoT Edge device.
111+
### Connect to your IoT Edge device
112+
113+
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.
114+
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:
116+
117+
```azurecli-interactive
118+
ssh azureuser@{publicIpAddress}
119+
```
111120

112121
### Register your device to use the software repository
113122

articles/iot-edge/quickstart.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ ms.topic: quickstart
99
ms.service: iot-edge
1010
services: iot-edge
1111
ms.custom: mvc
12-
13-
#experimental: true
14-
#experiment_id: 2c2f48c7-50a9-4e
1512
---
1613

1714
# Quickstart: Deploy your first IoT Edge module from the Azure portal to a Windows device - preview
@@ -80,7 +77,7 @@ The following code creates a free **F1** hub in the resource group **IoTEdgeReso
8077
az iot hub create --resource-group IoTEdgeResources --name {hub_name} --sku F1
8178
```
8279

83-
If you get an error because there's already one free hub in your subscription, change the SKU to **S1**.
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.
8481

8582
## Register an IoT Edge device
8683

@@ -97,13 +94,15 @@ Since IoT Edge devices behave and can be managed differently than typical IoT de
9794
az iot hub device-identity create --device-id myEdgeDevice --hub-name {hub_name} --edge-enabled
9895
```
9996

100-
1. Retrieve the connection string for your device, which links your physical device with its identity in IoT Hub.
97+
If you get an error about iothubowner policy keys, make sure that your cloud shell is running the latest version of the azure-cli-iot-ext extension.
98+
99+
2. Retrieve the connection string for your device, which links your physical device with its identity in IoT Hub.
101100

102101
```azurecli-interactive
103102
az iot hub device-identity show-connection-string --device-id myEdgeDevice --hub-name {hub_name}
104103
```
105104

106-
1. Copy the connection string and save it. You'll use this value to configure the IoT Edge runtime in the next section.
105+
3. Copy the connection string and save it. You'll use this value to configure the IoT Edge runtime in the next section.
107106

108107
## Install and start the IoT Edge runtime
109108

@@ -116,7 +115,9 @@ During the runtime installation, you're asked for a device connection string. Us
116115

117116
The instructions in this section configure the IoT Edge runtime with Linux containers. If you want to use Windows containers, see [Install Azure IoT Edge runtime on Windows to use with Windows containers](how-to-install-iot-edge-windows-with-windows.md).
118117

119-
Complete the following steps in the Windows machine or VM that you prepared to function as an IoT Edge device.
118+
### Connect to your IoT Edge device
119+
120+
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.
120121

121122
### Download and install the IoT Edge service
122123

includes/iot-edge-deploy-module.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,28 @@
55
author: kgremban
66
ms.service: iot-edge
77
ms.topic: include
8-
ms.date: 08/14/2018
8+
ms.date: 10/14/2018
99
ms.author: kgremban
1010
ms.custom: include file
1111
---
1212

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-
1. Go to **IoT Edge** under **Automatic Device Management** and select your IoT Edge device.
17-
1. Select **Set Modules**.
18-
1. In the **Deployment Modules** section of the **Add Modules** step, click **Add** then select **IoT Edge Module**.
19-
1. In the **Name** field, enter `tempSensor`.
20-
1. In the **Image URI** field, enter `mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0`.
21-
1. Leave the other settings unchanged, and select **Save**.
16+
2. Go to **IoT Edge** under **Automatic Device Management** and select your IoT Edge device.
17+
3. Select **Set Modules**. A three-step wizard opens in the portal, which guides you through adding modules, specifying routes, and reviewing the deployment.
18+
4. In the **Add Modules** step of the wizard, find the **Deployment Modules** section. Click **Add** then select **IoT Edge Module**.
19+
20+
![Add a new IoT Edge module](./media/iot-edge-deploy-module/add-module.png)
21+
22+
5. In the **Name** field, enter `tempSensor`.
23+
6. In the **Image URI** field, enter `mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0`.
24+
7. Leave the other settings unchanged, and select **Save**.
2225

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

25-
1. Back in the **Add Modules** step, select **Next**.
26-
1. In the **Specify routes** step, 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**.
28+
8. Back in first step of the wizard, select **Next**.
29+
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**.
2730

2831
```json
2932
{
@@ -33,7 +36,9 @@ One of the key capabilities of Azure IoT Edge is being able to deploy modules to
3336
}
3437
```
3538

36-
1. In the **Review Deployment** step, select **Submit**.
37-
1. 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.
39+
10. In the **Review Deployment** step of the wizard, select **Submit**.
40+
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.
41+
42+
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.
3843

3944
![View tempSensor in list of deployed modules](./media/iot-edge-deploy-module/deployed-modules.png)
39.7 KB
Loading

0 commit comments

Comments
 (0)