Skip to content

Commit 8bb97dc

Browse files
authored
Update aks-edge-howto-deploy-azure-iot.md
1 parent e1d287f commit 8bb97dc

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

AKS-Hybrid/aks-edge-howto-deploy-azure-iot.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
22
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.
44
author: rcheeran
55
ms.author: rcheeran
66
ms.topic: how-to
77
ms.date: 10/23/2024
88
ms.custom: template-how-to
99
---
1010

11-
# Deploy Azure IoT Operations on AKS Edge Essentials
11+
# Create and configure an AKS Edge Essentials cluster that can run Azure IoT Operations
1212

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.
1414

1515
> [!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.
1717
1818
## Prerequisites for running the script
1919

2020
To run the script, you need the following prerequisites:
2121

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.
2323
- 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).
2424
- Install the latest version of the following extensions for Azure CLI:
2525

@@ -29,16 +29,16 @@ To run the script, you need the following prerequisites:
2929
```
3030

3131
- 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).
3332

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
3534

3635
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:
3736

3837
- Downloads the latest [AKS Edge Essentials MSI from this repo](https://github.com/Azure/aks-edge).
3938
- Installs AKS Edge Essentials, and deploys and creates a single machine Kubernetes cluster on your Windows machine.
4039
- 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.
4140
- Enables the custom location feature on the Arc-enabled Kubernetes cluster.
41+
- Enables the workload identity feature on the Arc-enabled Kubernetes cluster.
4242
- Deploys the local path provisioning.
4343
- Configures firewall rules on the host Windows machine for the MQTT broker.
4444
- 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
4747
- `sudo iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 9110 -j ACCEPT`
4848
- `sudo iptables -A INPUT -p tcp --dport (10124, 8420, 2379, 50051) -j ACCEPT`
4949

50-
After you download the script, perform the following steps:
50+
To run the quickstart script, perform the following steps:
5151

5252
1. Open an elevated PowerShell window and change the directory to a working folder.
5353
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:
7171
|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). |
7272
|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). |
7373
|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). |
7575
|CLUSTER_NAME | A name for the new cluster to be created. |
7676
|ARC_APP_OBJECT_ID | The object ID value that you retrieved in step 2. |
7777

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.
7979

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:
8181

82-
```powershell
83-
Import-Module AksEdge
84-
Get-AksEdgeDeploymentInfo
85-
```
82+
```powershell
83+
Import-Module AksEdge
84+
Get-AksEdgeDeploymentInfo
85+
```
8686

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**.
8888

8989
## Verify your cluster
9090

0 commit comments

Comments
 (0)