Skip to content

Commit 94333a2

Browse files
author
Jill Grant
authored
Merge pull request #289355 from kgremban/m3-aks
link to aks-ee docs; slim down supported environment statements
2 parents 54d8be6 + 4e20c3e commit 94333a2

File tree

5 files changed

+39
-86
lines changed

5 files changed

+39
-86
lines changed

‎articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy Azure IoT Operations to a cluster
3-
description: Use the Azure CLI or Azure portal to deploy Azure IoT Operations to an Arc-enabled Kubernetes cluster.
3+
description: Use the Azure portal to deploy Azure IoT Operations to an Arc-enabled Kubernetes cluster.
44
author: kgremban
55
ms.author: kgremban
66
ms.topic: how-to
@@ -14,7 +14,7 @@ ms.date: 10/23/2024
1414

1515
[!INCLUDE [public-preview-note](../includes/public-preview-note.md)]
1616

17-
Learn how to deploy Azure IoT Operations Preview to a Kubernetes cluster using the Azure CLI or Azure portal.
17+
Learn how to deploy Azure IoT Operations Preview to a Kubernetes cluster using the Azure portal.
1818

1919
In this article, we discuss Azure IoT Operations *deployments* and *instances*, which are two different concepts:
2020

‎articles/iot-operations/deploy-iot-ops/howto-prepare-cluster.md

Lines changed: 21 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,10 @@ Microsoft supports Azure Kubernetes Service (AKS) Edge Essentials for deployment
2424

2525
If you want to deploy Azure IoT Operations to a multi-node solution, use K3s on Ubuntu.
2626

27-
To prepare your Azure Arc-enabled Kubernetes cluster, you need:
28-
29-
### [AKS Edge Essentials](#tab/aks-edge-essentials)
30-
31-
* An Azure subscription. If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
32-
33-
* 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).
34-
35-
* The latest version of the following extensions for Azure CLI:
36-
37-
```bash
38-
az extension add --upgrade --name azure-iot-ops
39-
az extension add --upgrade --name connectedk8s
40-
```
41-
42-
* Hardware that meets the system requirements:
43-
44-
* 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.
45-
* [Azure Arc-enabled Kubernetes system requirements](/azure/azure-arc/kubernetes/system-requirements).
46-
* [AKS Edge Essentials requirements and support matrix](/azure/aks/hybrid/aks-edge-system-requirements).
47-
* [AKS Edge Essentials networking guidance](/azure/aks/hybrid/aks-edge-concept-networking).
48-
4927
### [Ubuntu](#tab/ubuntu)
5028

29+
To prepare an Azure Arc-enabled Kubernetes cluster, you need:
30+
5131
* An Azure subscription. If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
5232

5333
* 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).
@@ -67,55 +47,24 @@ To prepare your Azure Arc-enabled Kubernetes cluster, you need:
6747

6848
* If you're going to 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).
6949

70-
---
71-
72-
## Create a cluster
73-
74-
This section provides steps to create clusters in validated environments on Linux and Windows.
75-
7650
### [AKS Edge Essentials](#tab/aks-edge-essentials)
7751

78-
[Azure Kubernetes Service Edge Essentials](/azure/aks/hybrid/aks-edge-overview) is an on-premises Kubernetes implementation of Azure Kubernetes Service (AKS) that automates running containerized applications at scale. AKS Edge Essentials includes a Microsoft-supported Kubernetes platform that includes a lightweight Kubernetes distribution with a small footprint and simple installation experience that supports PC-class or "light" edge hardware.
79-
80-
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.
52+
To prepare an Azure Arc-enabled Kubernetes cluster, you need:
8153

82-
1. Open an elevated PowerShell window and change the directory to a working folder.
83-
84-
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.
85-
86-
```azurecli
87-
az ad sp show --id bc313c14-388c-4e7d-a58e-70017303ee3b --query id -o tsv
88-
```
54+
* An Azure subscription. If you don't have an Azure subscription, [create one for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin.
8955

90-
1. Run the following commands, replacing the placeholder values with your information:
91-
92-
| Placeholder | Value |
93-
| ----------- | ----- |
94-
| 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). |
95-
| 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). |
96-
| RESOURCE_GROUP_NAME | The name of an existing resource group or a name for a new resource group to be created. |
97-
| LOCATION | An Azure region close to you. For the list of currently supported Azure regions, see [Supported regions](../overview-iot-operations.md#supported-regions). |
98-
| CLUSTER_NAME | A name for the new cluster to be created. |
99-
| ARC_APP_OBJECT_ID | The object ID value that you retrieved in the previous step. |
100-
101-
```powershell
102-
$url = "https://raw.githubusercontent.com/Azure/AKS-Edge/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
103-
Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
104-
Unblock-File .\AksEdgeQuickStartForAio.ps1
105-
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
106-
.\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>" -CustomLocationOid "<ARC_APP_OBJECT_ID>"
107-
```
56+
* Hardware that meets the system requirements:
10857

109-
If there are any issues during deployment, including if your machine reboots as part of this process, run the whole set of commands again.
58+
* 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.
59+
* [Azure Arc-enabled Kubernetes system requirements](/azure/azure-arc/kubernetes/system-requirements).
60+
* [AKS Edge Essentials requirements and support matrix](/azure/aks/hybrid/aks-edge-system-requirements).
61+
* [AKS Edge Essentials networking guidance](/azure/aks/hybrid/aks-edge-concept-networking).
11062

111-
1. Run the following commands to check that the deployment was successful:
63+
---
11264

113-
```powershell
114-
Import-Module AksEdge
115-
Get-AksEdgeDeploymentInfo
116-
```
65+
## Create and Arc-enable a cluster
11766

118-
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is `Connected`.
67+
This section provides steps to create clusters in validated environments on Linux and Windows.
11968

12069
### [Ubuntu](#tab/ubuntu)
12170

@@ -167,20 +116,10 @@ On multi-node clusters with at least three nodes, you have the option of enablin
167116

168117
If you want to enable fault tolerance during deployment, configure your clusters by following the steps in [Prepare Linux for Edge Volumes using a multi-node Ubuntu cluster](/azure/azure-arc/container-storage/multi-node-cluster-edge-volumes?pivots=ubuntu).
169118

170-
---
171-
172-
## Arc-enable your cluster
119+
### Arc-enable your cluster
173120

174121
Connect your cluster to Azure Arc so that it can be managed remotely.
175122

176-
### [AKS Edge Essentials](#tab/aks-edge-essentials)
177-
178-
The **AksEdgeQuickStartForAio.ps1** script that you ran in the previous section handled the steps to connect your cluster. You don't need to take any extra steps to Arc-enable.
179-
180-
### [Ubuntu](#tab/ubuntu)
181-
182-
To connect your cluster to Azure Arc:
183-
184123
1. On the machine where you deployed the Kubernetes cluster, sign in with Azure CLI:
185124

186125
```azurecli
@@ -261,6 +200,14 @@ To connect your cluster to Azure Arc:
261200
systemctl restart k3s
262201
```
263202

203+
### [AKS Edge Essentials](#tab/aks-edge-essentials)
204+
205+
[Azure Kubernetes Service Edge Essentials](/azure/aks/hybrid/aks-edge-overview) is an on-premises Kubernetes implementation of Azure Kubernetes Service (AKS) that automates running containerized applications at scale. AKS Edge Essentials includes a Microsoft-supported Kubernetes platform that includes a lightweight Kubernetes distribution with a small footprint and simple installation experience that supports PC-class or "light" edge hardware.
206+
207+
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.
208+
209+
For instructions on running the script, see [Configure an AKS Edge Essentials cluster for Azure IoT Operations](/azure/aks/hybrid/aks-edge-howto-deploy-azure-iot).
210+
264211
---
265212

266213
## Verify your cluster

‎articles/iot-operations/deploy-iot-ops/overview-deploy.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,17 @@ ms.date: 10/23/2024
1616

1717
## Supported environments
1818

19-
Azure IoT Operations should work on any Arc-enabled Kubernetes cluster except for those on Arm64 architectures. For more information, review the [Azure Arc-enabled Kubernetes system requirements](/azure/azure-arc/kubernetes/system-requirements).
19+
Microsoft supports Azure Kubernetes Service (AKS) Edge Essentials for deployments on Windows and K3s for deployments on Ubuntu.
2020

21-
Microsoft supports Azure Kubernetes Service (AKS) Edge Essentials for deployments on Windows and K3s for deployments on Ubuntu. For a list of specific hardware and software combinations that are tested and validated, see [Validated environments](../overview-iot-operations.md#validated-environments).
21+
* Minimum hardware requirements:
22+
* 16-GB RAM
23+
* 4 vCPUs
24+
25+
* Recommended hardware, especially for multi-node K3s clusters that enable fault tolerance:
26+
* 32-GB RAM
27+
* 8 vCPUs
28+
29+
[!INCLUDE [validated-environments](../includes/validated-environments.md)]
2230

2331
## Choose your features
2432

‎articles/iot-operations/get-started-end-to-end-sample/quickstart-deploy.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,9 @@ Azure IoT Operations is a suite of data services that run on Kubernetes clusters
5252

5353
## Connect a Kubernetes cluster to Azure Arc
5454

55-
Azure IoT Operations should work on any Kubernetes cluster that conforms to the Cloud Native Computing Foundation (CNCF) standards. For speed and convenience, this quickstart uses GitHub Codespaces to host your cluster.
55+
Azure IoT Operations supports Azure Kubernetes Service (AKS) Edge Essentials and K3s on Ubuntu clusters. However, for speed and convenience, this quickstart uses GitHub Codespaces to host your cluster.
5656

57-
> [!IMPORTANT]
58-
> Codespaces are easy to set up quickly and tear down later, but they're not suitable for performance evaluation or scale testing. Use GitHub Codespaces for exploration only. To learn how to deploy Azure IoT Operations to a production cluster such as AKS Edge Essentials, see [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md?tabs=aks-edge-essentials).
57+
Codespaces are easy to set up quickly and tear down later, but they're not suitable for performance evaluation or scale testing. Use GitHub Codespaces for exploration only. To learn how to deploy Azure IoT Operations to a cluster on Windows or Ubuntu, see [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md).
5958

6059
In this section, you create a new cluster and connect it to Azure Arc. If you want to reuse a cluster that you deployed Azure IoT Operations to previously, refer to the steps in [Clean up resources](#clean-up-resources) to uninstall Azure IoT Operations before continuing.
6160

‎articles/iot-operations/includes/validated-environments.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ ms.custom:
1010
- ignite-2023
1111
---
1212

13-
Azure IoT Operations ships as a set of Azure Arc-enabled Kubernetes services and is intended for use with [CNCF](https://www.cncf.io/) conformant [Arc validated partner products](/azure/azure-arc/kubernetes/validation-program). Currently, Microsoft has validated Azure IoT Operations against the following fixed-set of infrastructures and environments:
13+
Currently, Microsoft validates Azure IoT Operations against the following fixed-set of infrastructures and environments:
1414

1515
| Environment | Version |
1616
| ----------- | ------- |
17-
| AKS-EE on Windows 11 IoT Enterprise <br> on a Lenovo ThinkStation P3 Tiny machine (16 core, 32 GB RAM) with single-node cluster | AksEdge-K3s-1.29.6-1.8.202.0 |
18-
| K3S on Ubuntu 24.04 <br> on a Lenovo ThinkStation P3 Tiny machine (16 core, 32 GB RAM) with a 3-node cluster | K3s version 1.31.1 |
17+
| AKS-EE on Windows 11 IoT Enterprise <br> on a Lenovo ThinkStation P3 Tiny machine (16 core, 32-GB RAM) with single-node cluster | AksEdge-K3s-1.29.6-1.8.202.0 |
18+
| K3S on Ubuntu 24.04 <br> on a Lenovo ThinkStation P3 Tiny machine (16 core, 32-GB RAM) with a three-node cluster | K3s version 1.31.1 |
1919

20-
> [!IMPORTANT]
21-
> The environments listed previously are production-like environments that Microsoft has validated. They're not the only environments that Azure IoT Operations can run on. Azure IoT Operations can run on any Arc-enabled Kubernetes cluster that meets the [Azure Arc-enabled Kubernetes system requirements](/azure/azure-arc/kubernetes/system-requirements). Currently Azure IoT Operations doesn't support ARM64 architectures.
20+
Azure IoT Operations doesn't support Arm64 architectures.

0 commit comments

Comments
 (0)