Skip to content

Commit 7c13612

Browse files
Merge pull request #282885 from kgremban/aiojuly-aksee
AKS EE prepare cluster updates + supported versions
2 parents 9b08744 + 28ea2cd commit 7c13612

File tree

3 files changed

+44
-48
lines changed

3 files changed

+44
-48
lines changed

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

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ An Azure Arc-enabled Kubernetes cluster is a prerequisite for deploying Azure Io
2525

2626
To prepare your Azure Arc-enabled Kubernetes cluster, you need:
2727

28-
- Hardware that meets the [system requirements](../../azure-arc/kubernetes/system-requirements.md).
28+
* Hardware that meets the [system requirements](../../azure-arc/kubernetes/system-requirements.md).
2929

3030
### [AKS Edge Essentials](#tab/aks-edge-essentials)
3131

@@ -45,7 +45,6 @@ To prepare your Azure Arc-enabled Kubernetes cluster, you need:
4545
* Review the [AKS Edge Essentials requirements and support matrix](/azure/aks/hybrid/aks-edge-system-requirements).
4646
* Review the [AKS Edge Essentials networking guidance](/azure/aks/hybrid/aks-edge-concept-networking).
4747

48-
4948
### [Ubuntu](#tab/ubuntu)
5049

5150
* 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.
@@ -106,51 +105,38 @@ This section provides steps to prepare and Arc-enable clusters in validated envi
106105
107106
[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, making it easy for you to deploy Kubernetes on PC-class or "light" edge hardware.
108107
109-
>[!TIP]
110-
>You can use the [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1) script to automate the steps in this section and connect your cluster.
111-
>
112-
>Open an elevated PowerShell window, change the directory to a working folder, then run the following commands:
113-
>
114-
>```powershell
115-
>$url = "https://raw.githubusercontent.com/Azure/AKS-Edge/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
116-
>Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
117-
>Unblock-File .\AksEdgeQuickStartForAio.ps1
118-
>Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
119-
>.\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>"
120-
>```
121-
>
122-
>Your machine might reboot as part of this process. If so, run the whole set of commands again.
123-
124-
Prepare your machine for AKS Edge Essentials.
125-
126-
1. Download the [installer for the validated AKS Edge Essentials](https://aka.ms/aks-edge/msi-k3s-1.2.414.0) version to your local machine.
108+
The [AksEdgeQuickStartForAio.ps1](https://github.com/Azure/AKS-Edge/blob/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1) script automates the the process of creating and connecting a cluster, and is the recommended path for deploying Azure IoT Operations on AKS Edge Essentials.
127109
128-
1. Complete the steps in [Prepare your machine for AKS Edge Essentials](/azure/aks/hybrid/aks-edge-howto-setup-machine). Be sure to use the validated installer you downloaded in the previous step and not the most recent version.
110+
1. Open an elevated PowerShell window and change the directory to a working folder.
129111
130-
Set up an AKS Edge Essentials cluster on your machine.
112+
1. Run the following commands, replacing the placeholder values with your information:
131113
132-
1. Complete the steps in [Create a single machine deployment](/azure/aks/hybrid/aks-edge-howto-single-node-deployment), but at the end of [Step 1: single machine configuration parameters](/azure/aks/hybrid/aks-edge-howto-single-node-deployment#step-1-single-machine-configuration-parameters), modify the following values in the _aksedge-config.json_ file:
114+
| Placeholder | Value |
115+
| ----------- | ----- |
116+
| SUBSCRIPTION_ID | The ID of your Azure subscription. If you don't know your subscription ID, see [Find your Azure subscription](../../azure-portal/get-subscription-tenant-id.md#find-your-azure-subscription). |
117+
| TENANT_ID | The ID of your Microsoft Entra tenant. If you don't know your tenant ID, see [Find your Microsoft Entra tenant](../../azure-portal/get-subscription-tenant-id.md#find-your-microsoft-entra-tenant). |
118+
| RESOURCE_GROUP_NAME | The name of an existing resource group or a name for a new resource group to be created. |
119+
| LOCATION | An Azure region close to you. For the list of currently supported Azure regions, see [Supported regions](../overview-iot-operations.md#supported-regions). |
120+
| CLUSTER_NAME | A name for the new cluster to be created. |
133121
134-
```json
135-
`Init.ServiceIPRangeSize` = 10
136-
`LinuxNode.DataSizeInGB` = 30
137-
`LinuxNode.MemoryInMB` = 8192
138-
```
139-
140-
1. Install **local-path** storage in the cluster by running the following command:
122+
```powershell
123+
$url = "https://raw.githubusercontent.com/Azure/AKS-Edge/main/tools/scripts/AksEdgeQuickStart/AksEdgeQuickStartForAio.ps1"
124+
Invoke-WebRequest -Uri $url -OutFile .\AksEdgeQuickStartForAio.ps1
125+
Unblock-File .\AksEdgeQuickStartForAio.ps1
126+
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
127+
.\AksEdgeQuickStartForAio.ps1 -SubscriptionId "<SUBSCRIPTION_ID>" -TenantId "<TENANT_ID>" -ResourceGroupName "<RESOURCE_GROUP_NAME>" -Location "<LOCATION>" -ClusterName "<CLUSTER_NAME>"
128+
```
141129
142-
```cmd
143-
kubectl apply -f https://raw.githubusercontent.com/Azure/AKS-Edge/main/samples/storage/local-path-provisioner/local-path-storage.yaml
144-
```
130+
If there are any issues during deployment, including if your machine reboots as part of this process, run the whole set of commands again.
145131
146-
Run the following commands to check that the deployment was successful:
132+
1. Run the following commands to check that the deployment was successful:
147133
148-
```powershell
149-
Import-Module AksEdge
150-
Get-AksEdgeDeploymentInfo
151-
```
134+
```powershell
135+
Import-Module AksEdge
136+
Get-AksEdgeDeploymentInfo
137+
```
152138
153-
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is `Connected`.
139+
In the output of the `Get-AksEdgeDeploymentInfo` command, you should see that the cluster's Arc status is `Connected`.
154140

155141
### [Ubuntu](#tab/ubuntu)
156142

@@ -213,7 +199,7 @@ Connect your cluster to Azure Arc so that it can be managed remotely.
213199

214200
### [AKS Edge Essentials](#tab/aks-edge-essentials)
215201

216-
To connect your cluster to Azure Arc, complete the steps in [Connect your AKS Edge Essentials cluster to Arc](/azure/aks/hybrid/aks-edge-howto-connect-to-arc).
202+
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.
217203
218204
### [Ubuntu](#tab/ubuntu)
219205
@@ -227,12 +213,13 @@ To connect your cluster to Azure Arc:
227213
228214
1. Set environment variables for your Azure subscription, location, a new resource group, and the cluster name as it will show up in your resource group.
229215
216+
For the list of currently supported Azure regions, see [Supported regions](../overview-iot-operations.md#supported-regions).
217+
230218
```bash
231219
# Id of the subscription where your resource group and Arc-enabled cluster will be created
232220
export SUBSCRIPTION_ID=<SUBSCRIPTION_ID>
233221
234222
# Azure region where the created resource group will be located
235-
# Currently supported regions: "eastus", "eastus2", "westus", "westus2", "westeurope", or "northeurope"
236223
export LOCATION=<REGION>
237224
238225
# Name of a new resource group to create which will hold the Arc-enabled cluster and Azure IoT Operations resources
@@ -242,9 +229,6 @@ To connect your cluster to Azure Arc:
242229
export CLUSTER_NAME=<NEW_CLUSTER_NAME>
243230
```
244231
245-
>[!NOTE]
246-
>West US 3 was a supported region in previous versions of Azure IoT Operations, but isn't supported with versions 0.6.x.
247-
248232
1. Set the Azure subscription context for all commands:
249233
250234
```azurecli

articles/iot-operations/includes/prepare-codespaces.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,13 @@ To create your codespace and cluster, use the following steps:
2929
| --------- | ----- |
3030
| SUBSCRIPTION_ID | Your Azure subscription ID. |
3131
| RESOURCE_GROUP | A name for a new Azure resource group where your cluster will be created. |
32-
| LOCATION | An Azure region close to you. The following regions are supported in public preview: eastus, eastus2, westus, westus2, westeurope, or northeurope. |
32+
| LOCATION | An Azure region close to you. For the list of currently supported regions, see [Supported regions](../overview-iot-operations.md#supported-regions). |
3333

3434
>[!TIP]
3535
>The values you provide as secrets in this step get saved on your GitHub account to be used in this and future codespaces. They're also automatically added as environment variables in the codespace terminal, and you can use those environment variables in the CLI commands in the next section.
3636
>
3737
>Additionally, this codespace automatically creates a `CLUSTER_NAME` environment variable which is set with the codespace name.
3838
39-
>[!NOTE]
40-
>West US 3 was a supported region in previous versions of Azure IoT Operations, but isn't supported with versions 0.6.x.
41-
4239
1. Select **Create new codespace**.
4340

4441
1. Once the codespace is ready, select the menu button at the top left, then select **Open in VS Code Desktop**.

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ ms.author: dobett
66
ms.topic: conceptual
77
ms.custom:
88
- ignite-2023
9+
- references_regions
910
ms.date: 07/31/2024
1011
---
1112

@@ -95,6 +96,20 @@ To secure communication between devices and the cloud through isolated network e
9596

9697
[!INCLUDE [validated-environments](includes/validated-environments.md)]
9798

99+
## Supported regions
100+
101+
In the 0.6.x public preview release, Azure IoT Operations supports clusters that are Arc-enabled in the following regions:
102+
103+
* East US
104+
* East US 2
105+
* West US
106+
* West US 2
107+
* West Europe
108+
* North Europe
109+
110+
>[!NOTE]
111+
>West US 3 was supported in previous versions of Azure IoT Operations, but isn't supported in version 0.6.x.
112+
98113
## Next step
99114

100115
Try the [Quickstart: Get started with an end-to-end sample](get-started-end-to-end-sample/quickstart-deploy.md).

0 commit comments

Comments
 (0)