Skip to content

Commit d2d0c29

Browse files
Merge pull request #256462 from JnHs/jh-arck8-ccrole
prereqs and roles
2 parents b71208d + 1775ac5 commit d2d0c29

File tree

2 files changed

+31
-41
lines changed

2 files changed

+31
-41
lines changed

articles/azure-arc/includes/arc-region-note.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ author: MikeRayMSFT
33
ms.author: mikeray
44
ms.service: azure-arc
55
ms.topic: include
6-
ms.date: 12/13/2022
6+
ms.date: 10/27/2023
77
---
88

99
To get the region segment of a regional endpoint, remove all spaces from the Azure region name. For example, *East US 2* region, the region name is `eastus2`.
@@ -12,6 +12,10 @@ For example: `san-af-<region>-prod.azurewebsites.net` should be `san-af-eastus2-
1212

1313
To see a list of all regions, run this command:
1414

15-
```azcli
15+
```azure-cli
1616
az account list-locations -o table
1717
```
18+
19+
```azurepowershell
20+
Get-AzLocation | Format-Table
21+
```

articles/azure-arc/kubernetes/cluster-connect.md

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Use cluster connect to securely connect to Azure Arc-enabled Kubernetes clusters."
3-
ms.date: 10/12/2023
3+
ms.date: 10/27/2023
44
ms.topic: how-to
55
ms.custom: devx-track-azurecli
66
description: "With cluster connect, you can securely connect to Azure Arc-enabled Kubernetes clusters from anywhere without requiring any inbound port to be enabled on the firewall."
@@ -19,9 +19,14 @@ Before you begin, review the [conceptual overview of the cluster connect feature
1919

2020
## Prerequisites
2121

22+
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
23+
24+
- An existing Azure Arc-enabled Kubernetes connected cluster.
25+
- If you haven't connected a cluster yet, use our [quickstart](quickstart-connect-cluster.md).
26+
- [Upgrade your agents](agent-upgrade.md#manually-upgrade-agents) to the latest version.
27+
2228
### [Azure CLI](#tab/azure-cli)
2329

24-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
2530

2631
- [Install](/cli/azure/install-azure-cli) or [update](/cli/azure/update-azure-cli) Azure CLI to the latest version.
2732

@@ -37,20 +42,6 @@ Before you begin, review the [conceptual overview of the cluster connect feature
3742
az extension update --name connectedk8s
3843
```
3944

40-
- An existing Azure Arc-enabled Kubernetes connected cluster.
41-
- If you haven't connected a cluster yet, use our [quickstart](quickstart-connect-cluster.md).
42-
- [Upgrade your agents](agent-upgrade.md#manually-upgrade-agents) to the latest version.
43-
44-
- In addition to meeting the [network requirements for Arc-enabled Kubernetes](network-requirements.md), enable these endpoints for outbound access:
45-
46-
| Endpoint | Port |
47-
|----------------|-------|
48-
|`*.servicebus.windows.net` | 443 |
49-
|`guestnotificationservice.azure.com`, `*.guestnotificationservice.azure.com` | 443 |
50-
51-
> [!NOTE]
52-
> To translate the `*.servicebus.windows.net` wildcard into specific endpoints, use the command `\GET https://guestnotificationservice.azure.com/urls/allowlist?api-version=2020-01-01&location=<location>`. Within this command, the region must be specified for the `<location>` placeholder.
53-
5445
- Replace the placeholders and run the below command to set the environment variables used in this document:
5546

5647
```azurecli
@@ -61,24 +52,8 @@ Before you begin, review the [conceptual overview of the cluster connect feature
6152

6253
### [Azure PowerShell](#tab/azure-powershell)
6354

64-
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
65-
6655
- Install [Azure PowerShell version 6.6.0 or later](/powershell/azure/install-azure-powershell).
6756

68-
- An existing Azure Arc-enabled Kubernetes connected cluster.
69-
- If you haven't connected a cluster yet, use our [quickstart](quickstart-connect-cluster.md).
70-
- [Upgrade your agents](agent-upgrade.md#manually-upgrade-agents) to the latest version.
71-
72-
- In addition to meeting the [network requirements for Arc-enabled Kubernetes](network-requirements.md), enable these endpoints for outbound access:
73-
74-
| Endpoint | Port |
75-
|----------------|-------|
76-
|`*.servicebus.windows.net` | 443 |
77-
|`guestnotificationservice.azure.com`, `*.guestnotificationservice.azure.com` | 443 |
78-
79-
> [!NOTE]
80-
> To translate the `*.servicebus.windows.net` wildcard into specific endpoints, use the command `\GET https://guestnotificationservice.azure.com/urls/allowlist?api-version=2020-01-01&location=<location>`. Within this command, the region must be specified for the `<location>` placeholder.
81-
8257
- Replace the placeholders and run the below command to set the environment variables used in this document:
8358

8459
```azurepowershell
@@ -89,6 +64,16 @@ Before you begin, review the [conceptual overview of the cluster connect feature
8964

9065
---
9166

67+
- In addition to meeting the [network requirements for Arc-enabled Kubernetes](network-requirements.md), enable these endpoints for outbound access:
68+
69+
| Endpoint | Port |
70+
|----------------|-------|
71+
|`*.servicebus.windows.net` | 443 |
72+
|`guestnotificationservice.azure.com`, `*.guestnotificationservice.azure.com` | 443 |
73+
74+
> [!NOTE]
75+
> To translate the `*.servicebus.windows.net` wildcard into specific endpoints, use the command `\GET https://guestnotificationservice.azure.com/urls/allowlist?api-version=2020-01-01&location=<location>`. Within this command, the region must be specified for the `<location>` placeholder.
76+
9277
[!INCLUDE [arc-region-note](../includes/arc-region-note.md)]
9378

9479
## Set up authentication
@@ -117,13 +102,13 @@ On the existing Arc-enabled cluster, create the ClusterRoleBinding with either M
117102
118103
1. Authorize the entity with appropriate permissions.
119104
120-
- If you are using Kubernetes native ClusterRoleBinding or RoleBinding for authorization checks on the cluster, with the `kubeconfig` file pointing to the `apiserver` of your cluster for direct access, you can create one mapped to the Microsoft Entra entity (service principal or user) that needs to access this cluster. Example:
105+
- If you're using Kubernetes native ClusterRoleBinding or RoleBinding for authorization checks on the cluster, with the `kubeconfig` file pointing to the `apiserver` of your cluster for direct access, you can create one mapped to the Microsoft Entra entity (service principal or user) that needs to access this cluster. For example:
121106
122107
```console
123108
kubectl create clusterrolebinding demo-user-binding --clusterrole cluster-admin --user=$AAD_ENTITY_OBJECT_ID
124109
```
125110
126-
- If you are using Azure RBAC for authorization checks on the cluster, you can create an Azure role assignment mapped to the Microsoft Entra entity. Example:
111+
- If you're using Azure RBAC for authorization checks on the cluster, you can create an applicable [Azure role assignment](azure-rbac.md#built-in-roles) mapped to the Microsoft Entra entity. For example:
127112
128113
```azurecli
129114
az role assignment create --role "Azure Arc Kubernetes Viewer" --assignee $AAD_ENTITY_OBJECT_ID --scope $ARM_ID_CLUSTER
@@ -148,15 +133,16 @@ On the existing Arc-enabled cluster, create the ClusterRoleBinding with either M
148133
149134
1. Authorize the entity with appropriate permissions.
150135
151-
- If you are using Kubernetes native ClusterRoleBinding or RoleBinding for authorization checks on the cluster, with the `kubeconfig` file pointing to the `apiserver` of your cluster for direct access, you can create one mapped to the Microsoft Entra entity (service principal or user) that needs to access this cluster. Example:
136+
- If you're using Kubernetes native ClusterRoleBinding or RoleBinding for authorization checks on the cluster, with the `kubeconfig` file pointing to the `apiserver` of your cluster for direct access, you can create one mapped to the Microsoft Entra entity (service principal or user) that needs to access this cluster. For example:
152137
153138
```console
154139
kubectl create clusterrolebinding demo-user-binding --clusterrole cluster-admin --user=$AAD_ENTITY_OBJECT_ID
155140
```
156141
157-
- If you are using [Azure RBAC for authorization checks](azure-rbac.md) on the cluster, you can create an Azure role assignment mapped to the Microsoft Entra entity. Example:
142+
- If you're using [Azure RBAC for authorization checks](azure-rbac.md) on the cluster, you can create an applicable [Azure role assignment](azure-rbac.md#built-in-roles) mapped to the Microsoft Entra entity. For example:
158143
159-
```azurecli
144+
```azurepowershell
145+
160146
az role assignment create --role "Azure Arc Kubernetes Viewer" --assignee $AAD_ENTITY_OBJECT_ID --scope $ARM_ID_CLUSTER
161147
az role assignment create --role "Azure Arc Enabled Kubernetes Cluster User Role" --assignee $AAD_ENTITY_OBJECT_ID --scope $ARM_ID_CLUSTER
162148
```
@@ -278,7 +264,7 @@ Use `az connectedk8s show` to check your Arc-enabled Kubernetes agent version.
278264

279265
### [Agent version < 1.11.7](#tab/agent-version)
280266

281-
When making requests to the Kubernetes cluster, if the Microsoft Entra entity used is a part of more than 200 groups, you may see the following error:
267+
When making requests to the Kubernetes cluster, if the Microsoft Entra entity used is a part of more than 200 groups, you might see the following error:
282268

283269
`You must be logged in to the server (Error:Error while retrieving group info. Error:Overage claim (users with more than 200 group membership) is currently not supported.`
284270

@@ -289,7 +275,7 @@ This is a known limitation. To get past this error:
289275

290276
### [Agent version >= 1.11.7](#tab/agent-version-latest)
291277

292-
When making requests to the Kubernetes cluster, if the Microsoft Entra service principal used is a part of more than 200 groups, you may see the following error:
278+
When making requests to the Kubernetes cluster, if the Microsoft Entra service principal used is a part of more than 200 groups, you might see the following error:
293279

294280
`Overage claim (users with more than 200 group membership) for SPN is currently not supported. For troubleshooting, please refer to aka.ms/overageclaimtroubleshoot`
295281

0 commit comments

Comments
 (0)