You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AKS-Arc/aks-edge-howto-deploy-azure-iot.md
+37-36Lines changed: 37 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@ description: Learn how to run the quickstart script that creates an Arc-enabled
4
4
author: rcheeran
5
5
ms.author: rcheeran
6
6
ms.topic: how-to
7
-
ms.date: 01/13/2025
7
+
ms.date: 03/24/2025
8
8
ms.custom: template-how-to
9
9
---
10
10
11
11
# Create and configure an AKS Edge Essentials cluster that can run Azure IoT Operations
12
12
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.
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.
14
14
15
15
> [!NOTE]
16
16
> Azure IoT Operations supports AKS Edge Essentials when deployed on k3s single machine clusters only. K8s clusters are not supported for AIO and deploying clusters on multiple machines is an experimental feature.
@@ -58,61 +58,62 @@ To run the quickstart script, perform the following steps:
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
65
68
```
66
69
67
-
1.[Optional][Azure Arc gateway (preview)](/azure/azure-arc/servers/arc-gateway?tabs=portal) lets you onboard infrastructure to Azure Arc using only 7 endpoints. To use Azure Arc Gateway with Azure IoT Operations on AKS Edge Essentials:
70
+
1.Add the required parameter values in the **aio-aide-userconfig.json** and **aio-aksedge-config.json** files:
68
71
69
-
-[Follow step 1 to create an Arc gateway resource](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-1-create-an-arc-gateway-resource).
70
-
- Note the [URLs listed in step 2](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-2-ensure-the-required-urls-are-allowed-in-your-environment) to add to the `proxy-skip-range` in step 2.
71
-
- Follow [step 3a in the Arc gateway documentation](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-3a-onboard-azure-arc-resources-with-your-arc-gateway-resource) and save the gateway ID.
72
-
- In **AksEdgeQuickStartForAio.ps1**, find the `$aideuserConfig` definition. Set the value of `GatewayResourceId` to the gateway ID saved from the previous step.
72
+
In **aio-aide-userconfig.json**, fill in the following values:
73
73
74
-
1. Run the following command, and replace the placeholder values with your information:
74
+
|Flag|Value |
75
+
|---------|---------|
76
+
|SubscriptionId | 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). |
77
+
|TenantId | 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). |
78
+
|ResourceGroupName | The name of an existing resource group or a name for a new resource group to be created. Only one Azure IoT Operations instance is supported per resource group. |
79
+
|Location | An Azure region close to you. For a list of the Azure IoT Operations's supported Azure regions, see [Supported regions](/azure/iot-operations/overview-iot-operations#supported-regions). |
80
+
|CustomLocationOID | The object ID value that you retrieved in step 2. |
81
+
|EnableWorkloadIdentity (preview) | Enabled by default. While you can opt out before deploying the cluster, you cannot enable it after cluster creation. Workload identity federation lets you configure a user-assigned managed identity or app registration in Microsoft Entra ID to trust tokens from external identity providers (IdPs) such as Kubernetes. To configure workload identity federation, [see this article](aks-edge-workload-identity.md). |
In **aio-aksedge-config.json**, add the required **ClusterName** field and other optional fields, as follows:
79
84
80
-
|Placeholder|Value |
85
+
|Flag |Value |
81
86
|---------|---------|
82
-
|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). |
83
-
|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). |
84
-
|RESOURCE_GROUP_NAME | The name of an existing resource group or a name for a new resource group to be created. Only one Azure IoT Operations instance is supported per resource group. |
85
-
|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). |
86
-
|CLUSTER_NAME | A name for the new cluster to be created. |
87
-
|ARC_APP_OBJECT_ID | The object ID value that you retrieved in step 2. |
87
+
| ClusterName | A name for the new cluster to be created. |
88
+
|`Proxy-Https`| Provide the proxy value: `https://<proxy-server-ip-address>:<port>`. |
89
+
|`Proxy-Http`| Provide the proxy value: `http://<proxy-server-ip-address>:<port>`. |
90
+
|`Proxy-No`| Provide the proxy skip range: `<excludedIP>`,`<excludedCIDR>`. If the `http(s)_proxy` is provided, then `No` should also be updated to `localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.42.0.0/16,10.43.0.0/16,10.96.0.0/12,10.244.0.0/16,.svc,169.254.169.254`. |
88
91
89
-
There are other optional flags that you can include when you run **AksEdgeQuickStartForAio.ps1**. The optional flags are as follows:
92
+
> [!IMPORTANT]
93
+
> Preview features are available on a self-service, opt-in basis. Previews are provided "as is" and "as available," and they're excluded from the service-level agreements and limited warranty. AKS Edge Essentials previews are partially covered by customer support on a best-effort basis.
90
94
91
-
|Optional flags|Value |
92
-
|---------|---------|
93
-
|`enableWorkloadIdentity` (preview) | Enabled by default. While you can opt out before deploying the cluster, you cannot enable it after cluster creation. Workload identity federation lets you configure a user-assigned managed identity or app registration in Microsoft Entra ID to trust tokens from external identity providers (IdPs) such as Kubernetes. To configure workload identity federation, [see this article](aks-edge-workload-identity.md). |
94
-
|`proxy-https`| Provide the proxy value: `https://<proxy-server-ip-address>:<port>`. |
95
-
|`proxy-http`| Provide the proxy value: `http://<proxy-server-ip-address>:<port>`. |
96
-
|`proxy-skip-range`| Provide the proxy skip range: `<excludedIP>`,`<excludedCIDR>`. If the `http(s)_proxy` is provided, then `no_proxy` should also be updated to `localhost,127.0.0.0/8,192.168.0.0/16,172.17.0.0/16,10.42.0.0/16,10.43.0.0/16,10.96.0.0/12,10.244.0.0/16,.svc,169.254.169.254`. |
95
+
1.[Optional][Azure Arc gateway (preview)](/azure/azure-arc/servers/arc-gateway?tabs=portal) lets you onboard infrastructure to Azure Arc using only 7 endpoints. To use Azure Arc Gateway with Azure IoT Operations on AKS Edge Essentials:
97
96
98
-
You can add these flags as shown in the following example:
97
+
-[Follow step 1 to create an Arc gateway resource](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-1-create-an-arc-gateway-resource).
98
+
- Note [the URLs listed in step 2](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-2-ensure-the-required-urls-are-allowed-in-your-environment) to add to the `proxy-no` in **aio-aksedge-config.json**.
99
+
- Follow [step 3a in the Arc gateway documentation](/azure/azure-arc/servers/arc-gateway?tabs=portal#step-3a-onboard-azure-arc-resources-with-your-arc-gateway-resource) and save the gateway ID.
100
+
- In **aio-aide-userconfig.json**, set the value of `GatewayResourceId` to the gateway ID saved from the previous step.
> Preview features are available on a self-service, opt-in basis. Previews are provided "as is" and "as available," and they're excluded from the service-level agreements and limited warranty. AKS Edge Essentials previews are partially covered by customer support on a best-effort basis.
Applications that run in AKS deployments using Azure Kubernetes Service enabled by Azure Arc might need to store and retrieve data. For some application workloads, the data can use local, fast storage on an unneeded node when the pods are deleted (Kubernetes uses _pods_ to run an instance of an application).
Copy file name to clipboardExpand all lines: azure-local/known-issues.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,6 +151,8 @@ The following table lists the known issues in this release:
151
151
152
152
|Feature |Issue |Workaround |
153
153
|---------|---------|---------|
154
+
| Deployment | During Azure Local deployment via portal, **Validate selected machines** fails with this error emssage: `Mandatory extension [Lcm controller] installed version [30.2503.0.907] is not equal to the required version [30.2411.2.789] for Arc machine [Name of the machine]. Please create EdgeDevice resource again for this machine to fix the issue.`| Reinstall the correct version of `AzureEdgeLifecycleManager` extension. Follow these steps: <br> 1. Select the machine and then select **Install extensions**. <br> 2. Repeat this step for each machine you intend to cluster. It takes roughly 15 minutes for the installation to complete. <br> 3. Verify that the `AzureEdgeLifecycleManager` extension version is 30.2411.2.789. <br> 4. After the extensions are installed on all the machines in the list, select **Add machines** to refresh the list. <br> 5. Select **Validate selected machines**. The validation should succeed. |
155
+
| Deployment | During the Azure Local deployment, `DeviceManagementExtension` fails to install when a proxy is configured. | Install previous `DeviceManangementExtension` version 1.2502.0.3012 when using a proxy. |
154
156
| Operating system | Restoring the registry using *RegBack* isn't supported on Azure Local. This operation can remove the Lifecycle Manager (LCM) and Microsoft On-premises Cloud (MOC) settings on your Azure Local instance, which can corrupt the solution. ||
Copy file name to clipboardExpand all lines: azure-local/manage/add-server.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn how to manage capacity on your Azure Local, version 23H2 syst
4
4
ms.topic: article
5
5
author: alkohli
6
6
ms.author: alkohli
7
-
ms.date: 01/28/2025
7
+
ms.date: 03/25/2025
8
8
---
9
9
10
10
# Add a node on Azure Local
@@ -173,6 +173,10 @@ If you experience failures or errors while adding a node, you can capture the ou
173
173
Add-Server -Rerun
174
174
```
175
175
176
+
If you encounter an issue during the add node operation and need help from Microsoft Support, you can follow the steps in [Collect diagnostic logs for Azure Local (preview)](collect-logs.md) to collect and send the diagnostic logs to Microsoft.
177
+
178
+
You might need to provide diagnostic logs from the new node that's to be added to the cluster. Make sure you run the `Send-DiagnosticData` cmdlet from the new node.
179
+
176
180
## Next steps
177
181
178
182
- Learn more about how to [Repair a node](./repair-server.md).
This article lists the requirements and prerequisites for Azure Arc VM management on Azure Local. We recommend that you review the requirements and complete the prerequisites before you manage your Arc VMs.
16
+
This article lists the requirements and prerequisites for Azure Local VMs enabled by Azure Arc. We recommend that you review the requirements and complete the prerequisites before you manage your Azure Local VMs.
17
17
18
18
## Azure requirements
19
19
20
20
The Azure requirements include:
21
21
22
-
- To provision Arc VMs and VM resources such as virtual disks, logical network, network interfaces, and VM images through the Azure portal, you must have access to an Azure subscription with the appropriate RBAC role and permissions assigned. For more information, see [RBAC roles for Azure Local Arc VM management](./assign-vm-rbac-roles.md#about-builtin-rbac-roles).
22
+
- To provision Azure Local VMs and VM resources such as virtual disks, logical network, network interfaces, and VM images through the Azure portal, you must have access to an Azure subscription with the appropriate RBAC role and permissions assigned. For more information, see [RBAC roles for Azure Local VMs](./assign-vm-rbac-roles.md#about-builtin-rbac-roles).
23
23
24
-
-Arc VM management infrastructure is supported in the regions documented in the [Azure requirements](../concepts//system-requirements-23h2.md#azure-requirements). For Arc VM management on Azure Local, all entities must be registered, enabled, or created in the same region.
24
+
-Azure Local VM infrastructure is supported in the regions documented in the [Azure requirements](../concepts//system-requirements-23h2.md#azure-requirements). For Azure Local VMs, all entities must be registered, enabled, or created in the same region.
25
25
26
-
The entities include your Azure Local instance, Arc Resource Bridge, Custom Location, VM operator, virtual machines created from Arc and Azure Arc for Servers guest management. These entities can be in different or same resource groups as long as all resource groups are in the same region.
26
+
The entities include your Azure Local instance, Azure Arc resource bridge, Custom Location, VM operator, virtual machines created from Arc and Azure Arc for Servers guest management. These entities can be in different or same resource groups as long as all resource groups are in the same region.
27
27
28
28
29
29
## Azure Local requirements
30
30
31
-
- You have access to an Azure Local instance that is deployed, has an Arc Resource Bridge, and a custom location.
31
+
- You have access to an Azure Local instance that is deployed, has an Azure Arc resource bridge, and a custom location.
32
32
33
-
- Go to the **Overview > Server** page in the Azure Local resource. Verify that **Azure Arc** shows as **Connected**. You should also see a custom location and an Arc Resource Bridge for your system.
33
+
- Go to the **Overview > Server** page in the Azure Local resource. Verify that **Azure Arc** shows as **Connected**. You should also see a custom location and an Azure Arc resource bridge for your system.
34
34
35
35
:::image type="content" source="./media/azure-arc-vm-management-prerequisites/azure-arc-connected.png" alt-text="Screenshot of the Overview page in the Azure Local resource showing Azure Arc as connected." lightbox="./media/azure-arc-vm-management-prerequisites/azure-arc-connected.png":::
36
36
@@ -58,7 +58,7 @@ For information on Azure CLI commands for Azure Local VMs, see [az stack-hci-vm]
58
58
59
59
If you're accessing your Azure Local directly, no steps are needed on your part.
60
60
61
-
During the system deployment, an Arc Resource Bridge is created and the Azure CLI extension `stack-hci-vm` is installed on the system. You can connect to and manage the system using the Azure CLI extension.
61
+
During the system deployment, an Azure Arc resource bridge is created and the Azure CLI extension `stack-hci-vm` is installed on the system. You can connect to and manage the system using the Azure CLI extension.
62
62
63
63
### Connect to the system remotely
64
64
@@ -103,4 +103,4 @@ If you're accessing your Azure Local remotely, the following requirements must b
103
103
104
104
## Next steps
105
105
106
-
- [Assign RBAC role for Arc VM management](./assign-vm-rbac-roles.md).
106
+
- [Assign RBAC role for Azure Local VMs](./assign-vm-rbac-roles.md).
0 commit comments