Skip to content

Commit 88b7284

Browse files
sethmanheimsethmanheim
authored
Merge pull request #16163 from MicrosoftDocs/release-ignite-aks
Merge AKS EE content to main for release
2 parents d670164 + 99e0eb3 commit 88b7284

File tree

2 files changed

+138
-0
lines changed

2 files changed

+138
-0
lines changed

‎AKS-Hybrid/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@
196196
href: aks-edge-howto-setup-nested-environment.md
197197
- name: Use GitOps with AKS Edge Essentials
198198
href: aks-edge-howto-use-gitops.md
199+
- name: Deploy Azure IoT Operations
200+
href: aks-edge-howto-deploy-azure-iot.md
199201
- name: Offline installation
200202
href: aks-edge-howto-offline-install.md
201203
- name: Access TPM secrets

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

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: Azure IoT Operations with AKS Edge Essentials
3+
description: Learn how to use Azure IoT Operations with AKS Edge Essentials.
4+
author: rcheeran
5+
ms.author: rcheeran
6+
ms.topic: how-to
7+
ms.date: 10/23/2024
8+
ms.custom: template-how-to
9+
---
10+
11+
# Deploy Azure IoT Operations on AKS Edge Essentials
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.
14+
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.
17+
18+
## Prerequisites for running the script
19+
20+
To run the script, you need the following prerequisites:
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.
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+
- Install the latest version of the following extensions for Azure CLI:
25+
26+
```bash
27+
az extension add --upgrade --name azure-iot-ops
28+
az extension add --upgrade --name connectedk8s
29+
```
30+
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+
34+
## Create an AKS Edge Essentials cluster for Azure IoT Operations
35+
36+
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+
38+
- Downloads the latest [AKS Edge Essentials MSI from this repo](https://github.com/Azure/aks-edge).
39+
- Installs AKS Edge Essentials, and deploys and creates a single machine Kubernetes cluster on your Windows machine.
40+
- 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+
- Enables the custom location feature on the Arc-enabled Kubernetes cluster.
42+
- Deploys the local path provisioning.
43+
- Configures firewall rules on the host Windows machine for the MQTT broker.
44+
- On the Linux VM, which serves as the Kubernetes control plane node:
45+
- Configures the port proxy for the Kubernetes service default IP range of 10.96.0.0/28.
46+
- Configures the IP table rules:
47+
- `sudo iptables -A INPUT -p tcp -m state --state NEW -m tcp --dport 9110 -j ACCEPT`
48+
- `sudo iptables -A INPUT -p tcp --dport (10124, 8420, 2379, 50051) -j ACCEPT`
49+
50+
After you download the script, perform the following steps:
51+
52+
1. Open an elevated PowerShell window and change the directory to a working folder.
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.
54+
55+
```azurecli
56+
az ad sp show --id bc313c14-388c-4e7d-a58e-70017303ee3b --query id -o tsv
57+
```
58+
59+
1. Run the following commands, replacing the placeholder values with your information:
60+
61+
```powershell
62+
$url = "https://raw.githubusercontent.com/Azure/AKS-Edge/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
63+
Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
64+
Unblock-File .\AksEdgeQuickStartForAio.ps1
65+
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
66+
.\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>" -CustomLocationOid "<ARC_APP_OBJECT_ID>"
67+
```
68+
69+
|Placeholder|Value |
70+
|---------|---------|
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+
|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+
|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). |
75+
|CLUSTER_NAME | A name for the new cluster to be created. |
76+
|ARC_APP_OBJECT_ID | The object ID value that you retrieved in step 2. |
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.
79+
80+
Run the following commands to check that the deployment was successful:
81+
82+
```powershell
83+
Import-Module AksEdge
84+
Get-AksEdgeDeploymentInfo
85+
```
86+
87+
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is **Connected**.
88+
89+
## Verify your cluster
90+
91+
To verify that your cluster is ready for Azure IoT Operations deployment, you can use the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) helper command in the Azure IoT Operations extension for Azure CLI. When you run this command on the cluster host, it checks connectivity to Azure Resource Manager and Microsoft Container Registry endpoints:
92+
93+
```azurecli
94+
az iot ops verify-host
95+
```
96+
97+
To verify that your Kubernetes cluster is Azure Arc-enabled, run the following command:
98+
99+
```bash
100+
kubectl get deployments,pods -n azure-arc
101+
```
102+
103+
The output looks similar to the following example:
104+
105+
```output
106+
NAME READY UP-TO-DATE AVAILABLE AGE
107+
deployment.apps/clusterconnect-agent 1/1 1 1 10m
108+
deployment.apps/extension-manager 1/1 1 1 10m
109+
deployment.apps/clusteridentityoperator 1/1 1 1 10m
110+
deployment.apps/controller-manager 1/1 1 1 10m
111+
deployment.apps/flux-logs-agent 1/1 1 1 10m
112+
deployment.apps/cluster-metadata-operator 1/1 1 1 10m
113+
deployment.apps/extension-events-collector 1/1 1 1 10m
114+
deployment.apps/config-agent 1/1 1 1 10m
115+
deployment.apps/kube-aad-proxy 1/1 1 1 10m
116+
deployment.apps/resource-sync-agent 1/1 1 1 10m
117+
deployment.apps/metrics-agent 1/1 1 1 10m
118+
119+
NAME READY STATUS RESTARTS AGE
120+
pod/clusterconnect-agent-5948cdfb4c-vzfst 3/3 Running 0 10m
121+
pod/extension-manager-65b8f7f4cb-tp7pp 3/3 Running 0 10m
122+
pod/clusteridentityoperator-6d64fdb886-p5m25 2/2 Running 0 10m
123+
pod/controller-manager-567c9647db-qkprs 2/2 Running 0 10m
124+
pod/flux-logs-agent-7bf6f4bf8c-mr5df 1/1 Running 0 10m
125+
pod/cluster-metadata-operator-7cc4c554d4-nck9z 2/2 Running 0 10m
126+
pod/extension-events-collector-58dfb78cb5-vxbzq 2/2 Running 0 10m
127+
pod/config-agent-7579f558d9-5jnwq 2/2 Running 0 10m
128+
pod/kube-aad-proxy-56d9f754d8-9gthm 2/2 Running 0 10m
129+
pod/resource-sync-agent-769bb66b79-z9n46 2/2 Running 0 10m
130+
pod/metrics-agent-6588f97dc-455j8 2/2 Running 0 10m
131+
```
132+
133+
## Next steps
134+
135+
- [Deploy Azure IoT Operations](/azure/iot-operations/deploy-iot-ops/howto-deploy-iot-operations)
136+
- [Uninstall AKS cluster](aks-edge-howto-uninstall.md)

0 commit comments

Comments
 (0)