Skip to content

Commit bee1c0f

Browse files
author
Jill Grant
authored
Merge pull request #269971 from PatAltimore/patricka-edge1.5
Update IoT Edge to 1.5
2 parents 97f7c76 + 82d7ef9 commit bee1c0f

File tree

78 files changed

+245
-294
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+245
-294
lines changed

articles/iot-edge/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@
291291
- name: Azure IoT Edge 1.1 archive
292292
href: /previous-versions/azure/iot-edge
293293
- name: Runtime modules environment variables
294-
href: https://github.com/Azure/iotedge/blob/release/1.4/doc/EnvironmentVariables.md
294+
href: https://github.com/Azure/iotedge/blob/main/doc/EnvironmentVariables.md
295295
- name: Create test certificates
296296
href: how-to-create-test-certificates.md
297297
- name: Azure CLI

articles/iot-edge/configure-connect-verify-gpu.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services: iot-edge
1212

1313
# Tutorial: Configure, connect, and verify an IoT Edge module for a GPU
1414

15-
[!INCLUDE [iot-edge-version-1.4](includes/iot-edge-version-1.4.md)]
15+
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1616

1717
This tutorial shows you how to build a GPU-enabled virtual machine (VM). From the VM, you'll see how to run an IoT Edge device that allocates work from one of its modules to your GPU.
1818

@@ -43,12 +43,10 @@ To create a GPU-optimized virtual machine (VM), choosing the right size is impor
4343

4444
Let's create an IoT Edge VM with the [Azure Resource Manager (ARM)](../azure-resource-manager/management/overview.md) template in GitHub, then configure it to be GPU-optimized.
4545

46-
1. Go to the IoT Edge VM deployment template in GitHub: [Azure/iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy/tree/1.4).
46+
1. Go to the IoT Edge VM deployment template in GitHub: [Azure/iotedge-vm-deploy](https://github.com/Azure/iotedge-vm-deploy).
4747

4848
1. Select the **Deploy to Azure** button, which initiates the creation of a custom VM for you in the Azure portal.
4949

50-
:::image type="content" source="media/configure-connect-verify-gpu/deploy-to-azure-button.png" alt-text="Screenshot of the Deploy to Azure button in GitHub.":::
51-
5250
1. Fill out the **Custom deployment** fields with your Azure credentials and resources:
5351

5452
| **Property** | **Description or sample value** |

articles/iot-edge/configure-device.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ type = "docker"
338338
imagePullPolicy = "..." # "on-create" or "never". Defaults to "on-create"
339339

340340
[agent.config]
341-
image = "mcr.microsoft.com/azureiotedge-agent:1.4"
341+
image = "mcr.microsoft.com/azureiotedge-agent:1.5"
342342
createOptions = { HostConfig = { Binds = ["/iotedge/storage:/iotedge/storage"] } }
343343

344344
[agent.config.auth]

articles/iot-edge/debug-module-vs-code.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,10 +374,10 @@ Remote SSH debugging prerequisites may be different depending on the language yo
374374
PS C:\> docker ps
375375
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
376376
a317b8058786 myacr.azurecr.io/filtermodule:0.0.1-amd64 "dotnet filtermodule…" 24 hours ago Up 6 minutes filtermodule
377-
d4d949f8dfb9 mcr.microsoft.com/azureiotedge-hub:1.4 "/bin/sh -c 'echo \"$…" 24 hours ago Up 6 minutes 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:5671->5671/tcp, :::5671->5671/tcp, 0.0.0.0:8883->8883/tcp, :::8883->8883/tcp, 1883/tcp edgeHub
377+
d4d949f8dfb9 mcr.microsoft.com/azureiotedge-hub:1.5 "/bin/sh -c 'echo \"$…" 24 hours ago Up 6 minutes 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:5671->5671/tcp, :::5671->5671/tcp, 0.0.0.0:8883->8883/tcp, :::8883->8883/tcp, 1883/tcp edgeHub
378378
1f0da9cfe8e8 mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0 "/bin/sh -c 'echo \"$…" 24 hours ago Up 6 minutes
379379
tempSensor
380-
66078969d843 mcr.microsoft.com/azureiotedge-agent:1.4 "/bin/sh -c 'exec /a…" 24 hours ago Up 6 minutes
380+
66078969d843 mcr.microsoft.com/azureiotedge-agent:1.5 "/bin/sh -c 'exec /a…" 24 hours ago Up 6 minutes
381381
edgeAgent
382382
```
383383

articles/iot-edge/gpu-acceleration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services: iot-edge
1212

1313
# GPU acceleration for Azure IoT Edge for Linux on Windows
1414

15-
[!INCLUDE [iot-edge-version-1.4](includes/iot-edge-version-1.4.md)]
15+
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1616

1717
GPUs are a popular choice for artificial intelligence computations, because they offer parallel processing capabilities and can often execute vision-based inferencing faster than CPUs. To better support artificial intelligence and machine learning applications, Azure IoT Edge for Linux on Windows (EFLOW) can expose a GPU to the virtual machine's Linux module.
1818

articles/iot-edge/how-to-access-built-in-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Choose different and unique host port numbers if you are mapping both the edgeHu
4545
> [!NOTE]
4646
> The environment variable `httpSettings__enabled` should not be set to `false` for built-in metrics to be available for collection.
4747
>
48-
> Environment variables that can be used to disable metrics are listed in the [azure/iotedge repo doc](https://github.com/Azure/iotedge/blob/master/doc/EnvironmentVariables.md).
48+
> Environment variables that can be used to disable metrics are listed in the [azure/iotedge repo doc](https://github.com/Azure/iotedge/blob/main/doc/EnvironmentVariables.md).
4949
5050
## Available metrics
5151

articles/iot-edge/how-to-access-dtpm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ services: iot-edge
1313

1414
# dTPM access for Azure IoT Edge for Linux on Windows
1515

16-
[!INCLUDE [iot-edge-version-1.4](includes/iot-edge-version-1.4.md)]
16+
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1717

1818
A Trusted platform module (TPM) chip is a secure crypto-processor that is designed to carry out cryptographic operations. This technology is designed to provide hardware-based, security-related functions. The Azure IoT Edge for Linux on Windows (EFLOW) virtual machine doesn't have a virtual TPMs attached to the VM. However, the user can enable or disable the TPM passthrough feature, that allows the EFLOW virtual machine to use the Windows host OS TPM. The TPM passthrough feature enables two main scenarios:
1919

@@ -27,7 +27,7 @@ This article describes how to develop a sample code in C# to read cryptographic
2727
2828
## Prerequisites
2929

30-
- A Windows host OS with a TPM or vTPM (ig using Windows host OS virtual machine).
30+
- A Windows host OS with a TPM or vTPM (if using Windows host OS virtual machine).
3131
- EFLOW virtual machine with TPM passthrough enabled. Using an elevated PowerShell session, use `Set-EflowVmFeature -feature "DpsTpm" -enable` to enable TPM passthrough. For more information, see [Set-EflowVmFeature to enable TPM passthrough](./reference-iot-edge-for-linux-on-windows-functions.md#set-eflowvmfeature).
3232
- Ensure that the NV index (default index=3001) is initialized with 8 bytes of data. The default AuthValue used by the sample is {1,2,3,4,5,6,7,8} which corresponds to the NV (Windows) Sample in the TSS.MSR libraries when writing to the TPM. All index initialization must take place on the Windows Host before reading from the EFLOW VM. For more information about TPM samples, see [TSS.MSR](https://github.com/microsoft/TSS.MSR).
3333

@@ -87,7 +87,7 @@ Once the executable file and dependency files are created, you need to copy the
8787
cd "C:\Users\User"
8888
```
8989
90-
1. Create a *tar* file with all the files created in previous steps. For more information about PowerShell *tar* support, see [Tar and Curl Come to Windows](https://devblogs.microsoft.com/commandline/tar-and-curl-come-to-windows/).
90+
1. Create a *tar* file with all the files created in previous steps.
9191
For example, if you have all your files under the folder _TPM_, you can use the following command to create the _TPM.tar_ file.
9292
```powershell
9393
tar -cvzf TPM.tar ".\TPM"

articles/iot-edge/how-to-access-host-storage-from-module.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services: iot-edge
1212

1313
# Give modules access to a device's local storage
1414

15-
[!INCLUDE [iot-edge-version-1.4](includes/iot-edge-version-1.4.md)]
15+
[!INCLUDE [iot-edge-version-all-supported](includes/iot-edge-version-all-supported.md)]
1616

1717

1818
IoT Edge modules can use storage on the host IoT Edge device itself for improved reliability, especially when operating offline.
@@ -28,7 +28,7 @@ To set up system modules to use persistent storage:
2828
1. For both IoT Edge hub and IoT Edge agent, add an environment variable called **StorageFolder** that points to a directory in the module.
2929
1. For both IoT Edge hub and IoT Edge agent, add binds to connect a local directory on the host machine to a directory in the module. For example:
3030

31-
:::image type="content" source="./media/how-to-access-host-storage-from-module/offline-storage-1-4.png" alt-text="Screenshot that shows how to add create options and environment variables for local storage.":::
31+
:::image type="content" source="./media/how-to-access-host-storage-from-module/offline-storage.png" alt-text="Screenshot that shows how to add create options and environment variables for local storage.":::
3232

3333
Replace `<HostStoragePath>` and `<ModuleStoragePath>` with your host and module storage path. Both values must be an absolute path and `<HostStoragePath>` must exist.
3434

@@ -50,7 +50,7 @@ Your deployment manifest would be similar to the following:
5050
}
5151
},
5252
"settings": {
53-
"image": "mcr.microsoft.com/azureiotedge-agent:1.4",
53+
"image": "mcr.microsoft.com/azureiotedge-agent:1.5",
5454
"createOptions": "{\"HostConfig\":{\"Binds\":[\"/srv/edgeAgent:/tmp/edgeAgent\"]}}"
5555
},
5656
"type": "docker"
@@ -63,7 +63,7 @@ Your deployment manifest would be similar to the following:
6363
},
6464
"restartPolicy": "always",
6565
"settings": {
66-
"image": "mcr.microsoft.com/azureiotedge-hub:1.4",
66+
"image": "mcr.microsoft.com/azureiotedge-hub:1.5",
6767
"createOptions": "{\"HostConfig\":{\"Binds\":[\"/srv/edgeHub:/tmp/edgeHub\"],\"PortBindings\":{\"443/tcp\":[{\"HostPort\":\"443\"}],\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}]}}}"
6868
},
6969
"status": "running",
@@ -103,11 +103,8 @@ If your custom module requires access to persistent storage on the host file sys
103103
}
104104
```
105105

106-
107106
Replace `<HostStoragePath>` and `<ModuleStoragePath>` with your host and module storage path; both values must be an absolute path. Refer to the [Docker Engine Mount specification](https://any-api.com/docker_com/engine/docs/Definitions/Mount) for option details.
108107

109-
110-
111108
### Host system permissions
112109

113110
Make sure that the user profile your module is using has the required read, write, and execute permissions to the host system directory. By default, containers run as `root` user that already has the required permissions. But your module's Dockerfile might specify use of a non-root user in which case host storage permissions must be manually configured.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ For X.509 self-signed authentication, sometimes referred to as thumbprint authen
127127
5. Depending on your preferred language, review samples of how X.509 certificates can be referenced in IoT applications:
128128
129129
* C#: [Set up X.509 security in your Azure IoT hub](../iot-hub/tutorial-x509-test-certificate.md)
130-
* C: [iotedge_downstream_device_sample.c](https://github.com/Azure/azure-iot-sdk-c/tree/master/iothub_client/samples/iotedge_downstream_device_sample)
130+
* C: [iotedge_downstream_device_sample.c](https://github.com/Azure/azure-iot-sdk-c/tree/main/iothub_client/samples/iotedge_downstream_device_sample)
131131
* Node.js: [simple_sample_device_x509.js](https://github.com/Azure/azure-iot-sdk-node/blob/main/device/samples/javascript/simple_sample_device_x509.js)
132132
* Java: [SendEventX509.java](https://github.com/Azure/azure-iot-sdk-java/tree/main/iothub/device/iot-device-samples/send-event-x509)
133133
* Python: [send_message_x509.py](https://github.com/Azure/azure-iot-sdk-python/blob/v2/samples/async-hub-scenarios/send_message_x509.py)
@@ -174,7 +174,7 @@ This section is based on the IoT Hub X.509 certificate tutorial series. See [Und
174174
6. Depending on your preferred language, review samples of how X.509 certificates can be referenced in IoT applications:
175175

176176
* C#: [Set up X.509 security in your Azure IoT hub](../iot-hub/tutorial-x509-test-certificate.md)
177-
* C: [iotedge_downstream_device_sample.c](https://github.com/Azure/azure-iot-sdk-c/tree/master/iothub_client/samples/iotedge_downstream_device_sample)
177+
* C: [iotedge_downstream_device_sample.c](https://github.com/Azure/azure-iot-sdk-c/tree/main/iothub_client/samples/iotedge_downstream_device_sample)
178178
* Node.js: [simple_sample_device_x509.js](https://github.com/Azure/azure-iot-sdk-node/blob/main/device/samples/javascript/simple_sample_device_x509.js)
179179
* Java: [SendEventX509.java](https://github.com/Azure/azure-iot-sdk-java/tree/main/iothub/device/iot-device-samples/send-event-x509)
180180
* Python: [send_message_x509.py](https://github.com/Azure/azure-iot-sdk-python/blob/v2/samples/async-hub-scenarios/send_message_x509.py)

articles/iot-edge/how-to-collect-and-transport-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To configure monitoring on your IoT Edge device, follow the [Tutorial: Monitor I
5656

5757
## Metrics collector module
5858

59-
A Microsoft-supplied metrics-collector module can be added to an IoT Edge deployment to collect module metrics and send them to Azure Monitor. The module code is open-source and available in the [IoT Edge GitHub repo](https://github.com/Azure/iotedge/tree/release/1.1/edge-modules/metrics-collector).
59+
A Microsoft-supplied metrics-collector module can be added to an IoT Edge deployment to collect module metrics and send them to Azure Monitor. The module code is open-source and available in the [IoT Edge GitHub repo](https://github.com/Azure/iotedge/tree/main/edge-modules/metrics-collector).
6060

6161
The metrics-collector module is provided as a multi-arch Docker container image that supports Linux X64, ARM32, ARM64, and Windows X64 (version 1809). It's publicly available at **[`mcr.microsoft.com/azureiotedge-metrics-collector`](https://aka.ms/edgemon-metrics-collector)**.
6262

0 commit comments

Comments
 (0)