Skip to content

Commit f647c7b

Browse files
committed
link to aks-ee docs; slim down supported environment statements
1 parent e00c177 commit f647c7b

File tree

5 files changed

+13
-70
lines changed

5 files changed

+13
-70
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: 7 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,11 @@ 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-
2927
### [AKS Edge Essentials](#tab/aks-edge-essentials)
3028

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:
29+
To prepare an Azure Arc-enabled Kubernetes cluster, you need:
3630

37-
```bash
38-
az extension add --upgrade --name azure-iot-ops
39-
az extension add --upgrade --name connectedk8s
40-
```
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.
4132

4233
* Hardware that meets the system requirements:
4334

@@ -48,6 +39,8 @@ To prepare your Azure Arc-enabled Kubernetes cluster, you need:
4839

4940
### [Ubuntu](#tab/ubuntu)
5041

42+
To prepare an Azure Arc-enabled Kubernetes cluster, you need:
43+
5144
* 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.
5245

5346
* 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).
@@ -69,7 +62,7 @@ To prepare your Azure Arc-enabled Kubernetes cluster, you need:
6962

7063
---
7164

72-
## Create a cluster
65+
## Create and Arc-enable a cluster
7366

7467
This section provides steps to create clusters in validated environments on Linux and Windows.
7568

@@ -79,43 +72,7 @@ This section provides steps to create clusters in validated environments on Linu
7972

8073
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.
8174

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-
```
89-
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-
```
108-
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.
110-
111-
1. Run the following commands to check that the deployment was successful:
112-
113-
```powershell
114-
Import-Module AksEdge
115-
Get-AksEdgeDeploymentInfo
116-
```
117-
118-
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is `Connected`.
75+
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).
11976

12077
### [Ubuntu](#tab/ubuntu)
12178

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

168125
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).
169126

170-
---
171-
172-
## Arc-enable your cluster
127+
### Arc-enable your cluster
173128

174129
Connect your cluster to Azure Arc so that it can be managed remotely.
175130

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-
184131
1. On the machine where you deployed the Kubernetes cluster, sign in with Azure CLI:
185132

186133
```azurecli

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ 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).
20-
2119
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).
2220

2321
## Choose your features

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: 2 additions & 3 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 has validated Azure IoT Operations against the following fixed-set of infrastructures and environments:
1414

1515
| Environment | Version |
1616
| ----------- | ------- |
1717
| 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 |
1818
| 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 |
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+
Currently Azure IoT Operations doesn't support ARM64 architectures.

0 commit comments

Comments
 (0)