Skip to content

Commit 798696d

Browse files
authored
Merge pull request #15942 from MicrosoftDocs/main
9/27/2024 PM Publish
2 parents 40a66c7 + cb8f78e commit 798696d

20 files changed

+31
-25
lines changed

AKS-Hybrid/aks-edge-howto-connect-to-arc.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ description: Connect your AKS Edge Essentials clusters to Arc
44
author: rcheeran
55
ms.author: rcheeran
66
ms.topic: how-to
7-
ms.date: 08/21/2024
7+
ms.date: 09/27/2024
88
ms.custom: template-how-to
99
---
1010

1111
# Connect your AKS Edge Essentials cluster to Arc
1212

13-
This article describes how to connect your AKS Edge Essentials cluster to [Azure Arc](/azure/azure-arc/kubernetes/overview) so that you can monitor the health of your cluster on the Azure portal. If your cluster is connected to a proxy, you can use the scripts provided in the GitHub repo to connect your cluster to Arc [as described here.](./aks-edge-howto-more-configs.md)
13+
This article describes how to connect your AKS Edge Essentials cluster to [Azure Arc](/azure/azure-arc/kubernetes/overview) so that you can monitor the health of your cluster on the Azure portal. If your cluster is connected to a proxy, you can use the scripts provided in the GitHub repo to connect your cluster to Arc [as described here](./aks-edge-howto-more-configs.md).
1414

1515
## Prerequisites
1616

17-
In addition to these prerequisites, be sure to meet all [network requirements for Azure Arc-enabled Kubernetes](/azure/azure-arc/kubernetes/network-requirements).
18-
19-
- You need 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 on the Azure portal, selecting **Access control (IAM)** on the left-hand side of the Azure portal, and then selecting **View my access**. See [the Azure documentation](/azure/azure-resource-manager/management/manage-resource-groups-portal) for more information about managing resource groups.
20-
- Enable all required resource providers in the Azure subscription, such as **Microsoft.HybridCompute**, **Microsoft.GuestConfiguration**, **Microsoft.HybridConnectivity**, **Microsoft.Kubernetes**, **Microsoft.ExtendedLocation**, and **Microsoft.KubernetesConfiguration**.
21-
- Create and verify a resource group for AKS Edge Essentials Azure resources.
17+
- Before connecting to Arc, infrastructure administrators who are the owner or contributor role of the subscription will have to:
18+
1. Enable all required resource providers in the Azure subscription, such as **Microsoft.HybridCompute**, **Microsoft.GuestConfiguration**, **Microsoft.HybridConnectivity**, **Microsoft.Kubernetes**, **Microsoft.ExtendedLocation**, and **Microsoft.KubernetesConfiguration**.
19+
1. Create and verify a resource group for AKS Edge Essentials Azure resources.
20+
- To connect to Arc, Kubernetes operators need a [**Kubernetes Cluster - Azure Arc Onboarding**](/azure/role-based-access-control/built-in-roles/containers#kubernetes-cluster---azure-arc-onboarding) role for the identity at the resource group level. To disconnect from Arc, operators need an [**Azure Kubernetes Service Arc Contributor Role**](/azure/role-based-access-control/built-in-roles/containers#azure-kubernetes-service-arc-contributor-role) role for the identity at the resource group level. To check your access level, navigate to your subscription on the Azure portal, select **Access control (IAM)** on the left-hand side, and then select **View my access**. See [the Azure documentation](/azure/azure-resource-manager/management/manage-resource-groups-portal) for more information about managing resource groups. Infrastructure administrators with owner or contributor roles can also perform actions to connect or disconnect from Arc.
21+
- In addition to these prerequisites, make sure you meet all [network requirements for Azure Arc-enabled Kubernetes](/azure/azure-arc/kubernetes/network-requirements).
2222

2323
> [!NOTE]
2424
> You need the **Contributor** role to be able to delete the resources within the resource group. Commands to disconnect from Arc will fail without this role assignment.
@@ -29,7 +29,7 @@ In addition to these prerequisites, be sure to meet all [network requirements fo
2929

3030
Run the following commands in an elevated PowerShell window to install the dependencies in PowerShell:
3131

32-
```PowerShell
32+
```powershell
3333
Install-Module Az.Resources -Repository PSGallery -Force -AllowClobber -ErrorAction Stop
3434
Install-Module Az.Accounts -Repository PSGallery -Force -AllowClobber -ErrorAction Stop
3535
Install-Module Az.ConnectedKubernetes -Repository PSGallery -Force -AllowClobber -ErrorAction Stop
@@ -41,21 +41,21 @@ Provide details of your Azure subscription in the [**aksedge-config.json**](http
4141

4242
> [!IMPORTANT]
4343
> Client secrets are a form of password. Proper management is critical to the security of your environment.
44-
> * When you create the client secret, set a very short expiration time, based on the registration timing and scope for your deployment.
45-
> * Be sure to protect the client secret value and the configuration file from general access.
46-
> * Consider that if a cluster's configuration file is backed up while it has the client secret stored, the client secret is available to anyone with access to the backup.
47-
> * Once you register a cluster, remove the client secret from the configuration file for that cluster.
48-
> * Once you register all clusters in scope for your task, you should rotate the client secret and/or delete the service principal from your Microsoft Entra ID environment.
44+
> - When you create the client secret, set a very short expiration time, based on the registration timing and scope for your deployment.
45+
> - Be sure to protect the client secret value and the configuration file from general access.
46+
> - Consider that if a cluster's configuration file is backed up while it has the client secret stored, the client secret is available to anyone with access to the backup.
47+
> - Once you register a cluster, remove the client secret from the configuration file for that cluster.
48+
> - Once you register all clusters in scope for your task, you should rotate the client secret and/or delete the service principal from your Microsoft Entra ID environment.
4949
5050
| Attribute | Value type | Description |
5151
| :------------ |:-----------|:--------|
52-
|`ClusterName` | string | Provide a name for your cluster. The default value is `hostname_cluster`. |
52+
|`ClusterName` | string | The name of your cluster. The default value is `hostname_cluster`. |
5353
|`Location` | string | The location of your resource group. Choose the location closest to your deployment. |
5454
|`SubscriptionId` | GUID | Your subscription ID. In the Azure portal, select the subscription you're using and copy/paste the subscription ID string into the JSON. |
55-
|`TenantId` | GUID | Your tenant ID. In the Azure portal, search Microsoft Entra ID, which should take you to the **Default Directory** page. From here, you can copy/paste the tenant ID string into the JSON. |
55+
|`TenantId` | GUID | Your tenant ID. In the Azure portal, search **Microsoft Entra ID**, which should take you to the **Default Directory** page. From here, you can copy/paste the tenant ID string into the JSON. |
5656
|`ResourceGroupName` | string | The name of the Azure resource group to host your Azure resources for AKS Edge Essentials. You can use an existing resource group, or if you add a new name, the system creates one for you. |
57-
|`ClientId` | GUID | Provide the application ID of the Azure service principal to use as credentials. AKS Edge Essentials uses this service principal to connect your cluster to Arc. You can use the **App Registrations** page in the Microsoft Entra resource page on the Azure portal, to list and manage the service principals in a tenant. Be aware that the service principal requires the **Kubernetes Cluster - Azure Arc Onboarding** role at either the subscription or resource group level. For more information, see [Microsoft Entra identity requirements for service principals](/azure/azure-arc/kubernetes/system-requirements#microsoft-entra-identity-requirements). |
58-
|`ClientSecret` | string | Provide the password for the service principal. |
57+
|`ClientId` | GUID | Provide the application ID of the Azure service principal to use as credentials. AKS Edge Essentials uses this service principal to connect your cluster to Arc. You can use the **App Registrations** page in the Microsoft Entra resource page on the Azure portal to list and manage the service principals in a tenant. Be aware that the service principal requires the **Kubernetes Cluster - Azure Arc Onboarding** role at either the subscription or resource group level. For more information, see [Microsoft Entra identity requirements for service principals](/azure/azure-arc/kubernetes/system-requirements#microsoft-entra-identity-requirements). |
58+
|`ClientSecret` | string | The password for the service principal. |
5959

6060
> [!NOTE]
6161
> You only need to perform this configuration once per Azure subscription. You don't need to repeat the procedure for each Kubernetes cluster.
@@ -70,7 +70,7 @@ Connect-AksEdgeArc -JsonConfigFilePath .\aksedge-config.json
7070
```
7171

7272
> [!NOTE]
73-
> This step can take up to 10 minutes and PowerShell may become stuck on **Establishing Azure Connected Kubernetes for `your cluster name`**. PowerShell outputs `True` and returns to the prompt when the process is complete.
73+
> This step can take up to 10 minutes and PowerShell might become stuck on **Establishing Azure Connected Kubernetes for `your cluster name`**. PowerShell outputs `True` and returns to the prompt when the process is complete.
7474
7575
:::image type="content" source="media/aks-edge/aks-edge-ps-arc-connection.png" alt-text="Screenshot showing PowerShell prompt while connecting to Arc." lightbox="media/aks-edge/aks-edge-ps-arc-connection.png":::
7676

azure-local/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- name: Index
2+
href: index.md
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- name: '<please enter product name here>'
2+
tocHref: /
3+
topicHref: /

azure-local/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Welcome to AzureLocal!

azure-stack/hci/update/azure-update-manager-23h2.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ For Azure Stack HCI, Azure Update Manager is supported only in the regions where
3939
To browse for available cluster updates using Azure Update Manager, follow these steps:
4040

4141
1. Sign into [the Azure portal](https://portal.azure.com) and go to **Azure Update Manager**.
42-
2. Under Manage Azure Stack HCI, select **Azure Stack HCI**.
43-
- Filter by Subscription, Resource group, Location, Status, Update readiness, Current OS version, and/or Tags to view a list of clusters.
44-
3. In the cluster list, view the clusters update status, update readiness, current OS version, and the date and time of the last successful update.
42+
2. Under the **Resources** dropdown, select **Azure Stack HCI**.
43+
- Filter by Subscription, Resource group, Location, Status, Update readiness, Current version, and/or Tags to view a list of clusters.
44+
3. In the cluster list, view the clusters update Status, Update readiness, Current version, and the date and time of the Last successful update.
4545

4646
[![Screenshot to browse for cluster updates in Azure Update Manager.](./media/azure-update-manager/main-link.png)](media/azure-update-manager/main-link.png#lightbox)
4747

@@ -50,7 +50,7 @@ To browse for available cluster updates using Azure Update Manager, follow these
5050
To install cluster updates using Azure Update Manager, follow these steps:
5151

5252
1. Sign into [the Azure portal](https://portal.azure.com) and go to **Azure Update Manager**.
53-
2. Under Manage Azure Stack HCI, select **Azure Stack HCI**.
53+
2. Under the **Resources** dropdown, select **Azure Stack HCI**.
5454
3. Select one or more clusters from the list, then select **One-time Update**.
5555

5656
[![Screenshot to install cluster updates in Azure Update Manager.](./media/azure-update-manager/install-update.png)](media/azure-update-manager/install-update.png#lightbox)
@@ -87,7 +87,7 @@ When you install cluster updates via Azure Update Manager, you can check the pro
8787
To view the progress of your clusters, update installation, and completion results, follow these steps:
8888

8989
1. Sign into [the Azure portal](https://portal.azure.com) and go to **Azure Update Manager**.
90-
2. Under Manage Azure Stack HCI, select **History**.
90+
2. Under the **Manage** dropdown, select **History**.
9191
3. Select an update run from the list with a status of **In Progress**.
9292

9393
[![Screenshot to view progress about cluster updates in Azure Update Manager.](./media/azure-update-manager/update-in-progress.png)](media/azure-update-manager/update-in-progress.png#lightbox)
@@ -103,7 +103,7 @@ To view the progress of your clusters, update installation, and completion resul
103103
To browse for your clusters update history, follow these steps:
104104

105105
1. Sign into [the Azure portal](https://portal.azure.com) and go to **Azure Update Manager**.
106-
2. Under Manage Azure Stack HCI, select **History**.
106+
2. Under the **Manage** dropdown, select **History**.
107107
3. Select an update run with a status of “**Failed to update**” or “**Successfully updated**”.
108108

109109
[![Screenshot to view update history in Azure Update Manager.](./media/azure-update-manager/update-history-progress.png)](media/azure-update-manager/update-history-progress.png#lightbox)
@@ -121,7 +121,7 @@ In addition to using Azure Update Manager, you can update individual Azure Stack
121121
To install updates on a single cluster from the Azure Stack HCI cluster resource page, follow these steps:
122122

123123
1. Sign into [the Azure portal](https://portal.azure.com) and go to **Azure Update Manager**.
124-
2. Under Manage Azure Stack HCI, select **Azure Stack HCI**.
124+
2. Under the **Resources** dropdown, select **Azure Stack HCI**.
125125
3. Select the cluster name from the list.
126126
4. Select the update and then select **One-time update**.
127127

-95 Bytes
Loading
-4.09 KB
Loading
-40.7 KB
Loading
72 KB
Loading
-23.6 KB
Loading

0 commit comments

Comments
 (0)