You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AKS-Hybrid/aks-edge-howto-deploy-azure-iot.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,25 @@
1
1
---
2
2
title: Azure IoT Operations with AKS Edge Essentials
3
-
description: Learn how to use Azure IoT Operations with AKS Edge Essentials.
3
+
description: Learn how to run the quickstart script that creates an Arc-enabled AKS Edge Essentials Kubernetes cluster that can run Azure IoT Operations.
4
4
author: rcheeran
5
5
ms.author: rcheeran
6
6
ms.topic: how-to
7
7
ms.date: 10/23/2024
8
8
ms.custom: template-how-to
9
9
---
10
10
11
-
# Deploy Azure IoT Operations on AKS Edge Essentials
11
+
# Create and configure an AKS Edge Essentials cluster that can run Azure IoT Operations
12
12
13
-
[Azure IoT Operations](/azure/iot-operations/overview-iot-operations) requires an Arc-enabled Kubernetes cluster. You can use AKS Edge Essentials to create a Microsoft-managed Kubernetes cluster and deploy Azure IoT Operations on it, as a workload. This article describes the steps to run a script that creates an AKS Edge Essentials Kubernetes cluster with the required configuration applicable for Azure IoT Operations.
13
+
Azure Kubernetes Service (AKS) Edge Essentials is one of the supported cluster platforms for [Azure IoT Operations](/azure/iot-operations/overview-iot-operations). You can use AKS Edge Essentials to create a Microsoft-managed Kubernetes cluster and deploy Azure IoT Operations on it as a workload. This article describes the steps to run a script that creates an AKS Edge Essentials Kubernetes cluster with the required configurations for Azure IoT Operations and then connects that cluster to Azure Arc.
14
14
15
15
> [!NOTE]
16
-
> Azure IoT Operations is generally available on AKS Edge Essentials when deployed on single machine clusters. Deploying clusters on multiple machines is an experimental feature.
16
+
> Azure IoT Operations supports AKS Edge Essentials when deployed on single machine clusters. Deploying clusters on multiple machines is an experimental feature.
17
17
18
18
## Prerequisites for running the script
19
19
20
20
To run the script, you need the following prerequisites:
21
21
22
-
- An Azure subscription with either the **Owner** role or a combination of **Contributor** and **User Access Administrator** roles. You can check your access level by navigating to your subscription, selecting **Access control (IAM)** on the left-hand side of the Azure portal, and then selecting **View my access**. For more information about managing resource groups, see the [Azure Resource Manager documentation](/azure/azure-resource-manager/management/manage-resource-groups-portal). If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
22
+
- An Azure subscription with either the **Owner** role or a combination of **Contributor** and **User Access Administrator** roles. You can check your access level by navigating to your subscription, selecting **Access control (IAM)** on the left-hand side of the Azure portal, and then selecting **View my access**. If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
23
23
- Azure CLI version 2.64.0 or newer installed on your development machine. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
24
24
- Install the latest version of the following extensions for Azure CLI:
25
25
@@ -29,16 +29,16 @@ To run the script, you need the following prerequisites:
29
29
```
30
30
31
31
- Hardware requirements: ensure that your machine has a minimum of 16-GB available RAM, 8 available vCPUs, and 52-GB free disk space reserved for Azure IoT Operations.
32
-
- If you deploy Azure IoT Operations to a multi-node cluster with fault tolerance enabled, review the hardware and storage requirements in [Prepare Linux for Edge Volumes](/azure/azure-arc/container-storage/prepare-linux-edge-volumes).
33
32
34
-
## Create an AKS Edge Essentials cluster for Azure IoT Operations
33
+
## Create an Azure Arc-enabled AKS Edge Essentials cluster for Azure IoT Operations
35
34
36
35
The [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1) script automates the process of creating and connecting a cluster, and is the recommended path for deploying Azure IoT Operations on AKS Edge Essentials. The script performs the following tasks:
37
36
38
37
- Downloads the latest [AKS Edge Essentials MSI from this repo](https://github.com/Azure/aks-edge).
39
38
- Installs AKS Edge Essentials, and deploys and creates a single machine Kubernetes cluster on your Windows machine.
40
39
- Connects to the Azure subscription, creates a resource group if it doesn't already exist, and connects the cluster to Arc to create an Arc-enabled Kubernetes cluster.
41
40
- Enables the custom location feature on the Arc-enabled Kubernetes cluster.
41
+
- Enables the workload identity feature on the Arc-enabled Kubernetes cluster.
42
42
- Deploys the local path provisioning.
43
43
- Configures firewall rules on the host Windows machine for the MQTT broker.
44
44
- On the Linux VM, which serves as the Kubernetes control plane node:
@@ -47,7 +47,7 @@ The [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/to
47
47
-`sudo iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 9110 -j ACCEPT`
After you download the script, perform the following steps:
50
+
To run the quickstart script, perform the following steps:
51
51
52
52
1. Open an elevated PowerShell window and change the directory to a working folder.
53
53
1. Get the `objectId` of the Microsoft Entra ID application that the Azure Arc service uses in your tenant. Run the following command exactly as written, without changing the GUID value.
@@ -71,20 +71,20 @@ After you download the script, perform the following steps:
71
71
|SUBSCRIPTION_ID | The ID of your Azure subscription. If you don't know your subscription ID, see [Find your Azure subscription](/azure/azure-portal/get-subscription-tenant-id#find-your-azure-subscription). |
72
72
|TENANT_ID | The ID of your Microsoft Entra tenant. If you don't know your tenant ID, see [Find your Microsoft Entra tenant](/azure/azure-portal/get-subscription-tenant-id#find-your-microsoft-entra-tenant). |
73
73
|RESOURCE_GROUP_NAME | The name of an existing resource group or a name for a new resource group to be created. |
74
-
|LOCATION | An Azure region close to you. For the list of currently supported Azure regions, see [Supported regions](/azure/iot-operations/overview-iot-operations#supported-regions). |
74
+
|LOCATION | An Azure region close to you. For the list of Azure IoT Operations's supported Azure regions, see [Supported regions](/azure/iot-operations/overview-iot-operations#supported-regions). |
75
75
|CLUSTER_NAME | A name for the new cluster to be created. |
76
76
|ARC_APP_OBJECT_ID | The object ID value that you retrieved in step 2. |
77
77
78
-
If there are issues during deployment; for example, if your machine reboots as part of this process, run the set of commands again.
78
+
If there are issues during deployment, like if your machine reboots as part of this process, run the set of commands again.
79
79
80
-
Run the following commands to check that the deployment was successful:
80
+
1.Run the following commands to check that the deployment was successful:
81
81
82
-
```powershell
83
-
Import-Module AksEdge
84
-
Get-AksEdgeDeploymentInfo
85
-
```
82
+
```powershell
83
+
Import-Module AksEdge
84
+
Get-AksEdgeDeploymentInfo
85
+
```
86
86
87
-
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is **Connected**.
87
+
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is **Connected**.
0 commit comments