Skip to content

Commit 51ea21d

Browse files
Merge pull request #229603 from JnHs/jh-arck8-qnetreq
separate network requirements
2 parents 6cc26c2 + 073d85b commit 51ea21d

14 files changed

+47
-27
lines changed

articles/aks/dapr-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ az k8s-extension upgrade --cluster-type managedClusters \
198198

199199
## Meet network requirements
200200

201-
The Dapr extension for AKS and Arc for Kubernetes requires outbound URLs on `https://:443` to function. In addition to the `https://mcr.microsoft.com/daprio` URL for pulling Dapr artifacts, verify you've included the [outbound URLs required for AKS or Arc for Kubernetes](../azure-arc/kubernetes/quickstart-connect-cluster.md#meet-network-requirements).
201+
The Dapr extension for AKS and Arc for Kubernetes requires outbound URLs on `https://:443` to function. In addition to the `https://mcr.microsoft.com/daprio` URL for pulling Dapr artifacts, verify you've included the [outbound URLs required for AKS or Arc for Kubernetes](../azure-arc/kubernetes/network-requirements.md).
202202

203203
## Next Steps
204204

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Before you begin, review the [conceptual overview of the cluster connect feature
4040
- If you haven't connected a cluster yet, use our [quickstart](quickstart-connect-cluster.md).
4141
- [Upgrade your agents](agent-upgrade.md#manually-upgrade-agents) to the latest version.
4242

43-
- Enable the below endpoints for outbound access in addition to the ones mentioned under [connecting a Kubernetes cluster to Azure Arc](quickstart-connect-cluster.md#meet-network-requirements):
43+
- In addition to meeting the [network requirements for Arc-enabled Kubernetes](network-requirements.md), enable these endpoints for outbound access:
4444

4545
| Endpoint | Port |
4646
|----------------|-------|
@@ -68,7 +68,7 @@ Before you begin, review the [conceptual overview of the cluster connect feature
6868
- If you haven't connected a cluster yet, use our [quickstart](quickstart-connect-cluster.md).
6969
- [Upgrade your agents](agent-upgrade.md#manually-upgrade-agents) to the latest version.
7070

71-
- Enable the below endpoints for outbound access in addition to the ones mentioned under [connecting a Kubernetes cluster to Azure Arc](quickstart-connect-cluster.md#meet-network-requirements):
71+
- In addition to meeting the [network requirements for Arc-enabled Kubernetes](network-requirements.md), enable these endpoints for outbound access:
7272

7373
| Endpoint | Port |
7474
|----------------|-------|

articles/azure-arc/kubernetes/conceptual-agent-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Azure Arc agents are deployed on Kubernetes clusters when you [connect them to A
1313

1414
## Deploy agents to your cluster
1515

16-
Most on-premises datacenters enforce strict network rules that prevent inbound communication on the network boundary firewall. Azure Arc-enabled Kubernetes works with these restrictions by not requiring inbound ports on the firewall. Azure Arc agents require outbound communication to a [set list of network endpoints](quickstart-connect-cluster.md#meet-network-requirements).
16+
Most on-premises datacenters enforce strict network rules that prevent inbound communication on the network boundary firewall. Azure Arc-enabled Kubernetes works with these restrictions by not requiring inbound ports on the firewall. Azure Arc agents require outbound communication to a [set list of network endpoints](network-requirements.md).
1717

1818
:::image type="content" source="media/architectural-overview.png" alt-text="Diagram showing an architectural overview of the Azure Arc-enabled Kubernetes agents." lightbox="media/architectural-overview.png":::
1919

articles/azure-arc/kubernetes/diagnose-connection-issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Be sure that the Microsoft.Kubernetes, Microsoft.KubernetesConfiguration, and Mi
5353

5454
### Are all network requirements met?
5555

56-
Review the [network requirements](quickstart-connect-cluster.md#meet-network-requirements) and ensure that no required endpoints are blocked.
56+
Review the [network requirements](network-requirements.md) and ensure that no required endpoints are blocked.
5757

5858
### Are all pods in the `azure-arc` namespace running?
5959

@@ -99,7 +99,7 @@ az connectedk8s connect --name <cluster-name> --resource-group <resource-group>
9999

100100
### Is the proxy server able to reach required network endpoints?
101101

102-
Review the [network requirements](quickstart-connect-cluster.md#meet-network-requirements) and ensure that no required endpoints are blocked.
102+
Review the [network requirements](network-requirements.md) and ensure that no required endpoints are blocked.
103103

104104
### Is the proxy server only using HTTP?
105105

articles/azure-arc/kubernetes/includes/network-requirements.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
ms.service: azure-arc
33
ms.topic: include
4-
ms.date: 12/13/2022
4+
ms.date: 03/07/2023
55
---
66

77
### [Azure Cloud](#tab/azure-cloud)
@@ -21,8 +21,8 @@ ms.date: 12/13/2022
2121
|`https://k8connecthelm.azureedge.net` | `az connectedk8s connect` uses Helm 3 to deploy Azure Arc agents on the Kubernetes cluster. This endpoint is needed for Helm client download to facilitate deployment of the agent helm chart. |
2222
|`guestnotificationservice.azure.com`<br/>`*.guestnotificationservice.azure.com`<br/>`sts.windows.net`<br/>`https://k8sconnectcsp.azureedge.net` | For [Cluster Connect](../cluster-connect.md) and for [Custom Location](../custom-locations.md) based scenarios. |
2323
|`*.servicebus.windows.net` | For [Cluster Connect](../cluster-connect.md) and for [Custom Location](../custom-locations.md) based scenarios. |
24-
|`https://graph.microsoft.com/` | Required when [Azure RBAC](../azure-rbac.md) is configured |
25-
| `*.arc.azure.net`| To manage connected clusters in Azure portal. |
24+
|`https://graph.microsoft.com/` | Required when [Azure RBAC](../azure-rbac.md) is configured. |
25+
| `*.arc.azure.net`| Required to manage connected clusters in Azure portal. |
2626

2727
To translate the `*.servicebus.windows.net` wildcard into specific endpoints, use the command:
2828

@@ -49,7 +49,7 @@ GET https://guestnotificationservice.azure.com/urls/allowlist?api-version=2020-0
4949
|`https://k8connecthelm.azureedge.net` | `az connectedk8s connect` uses Helm 3 to deploy Azure Arc agents on the Kubernetes cluster. This endpoint is needed for Helm client download to facilitate deployment of the agent helm chart. |
5050
|`guestnotificationservice.azure.us`<br/>`*.guestnotificationservice.azure.us`<br/>`sts.windows.net`<br/>`https://k8sconnectcsp.azureedge.net` | For [Cluster Connect](../cluster-connect.md) and for [Custom Location](../custom-locations.md) based scenarios. |
5151
|`*.servicebus.usgovcloudapi.net` | For [Cluster Connect](../cluster-connect.md) and for [Custom Location](../custom-locations.md) based scenarios. |
52-
|`https://graph.microsoft.com/` | Required when [Azure RBAC](../azure-rbac.md) is configured |
52+
|`https://graph.microsoft.com/` | Required when [Azure RBAC](../azure-rbac.md) is configured. |
5353

5454
To translate the `*.servicebus.usgovcloudapi.net` wildcard into specific endpoints, use the command:
5555

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Azure Arc-enabled Kubernetes network requirements
3+
description: Learn about the networking requirements to connect Kubernetes clusters to Azure Arc.
4+
ms.date: 03/07/2023
5+
ms.topic: conceptual
6+
ms.custom: references-regions
7+
---
8+
9+
# Azure Arc-enabled Kubernetes network requirements
10+
11+
This topic describes the networking requirements for connecting a Kubernetes cluster to Azure Arc and supporting various Arc-enabled Kubernetes scenarios.
12+
13+
## Details
14+
15+
[!INCLUDE [network-requirement-principles](../includes/network-requirement-principles.md)]
16+
17+
[!INCLUDE [network-requirements](includes/network-requirements.md)]
18+
19+
For a complete list of network requirements for Azure Arc features and Azure Arc-enabled services, see [Azure Arc network requirements (Consolidated)](../network-requirements-consolidated.md).
20+
21+
## Next steps
22+
23+
- Use our [quickstart](quickstart-connect-cluster.md) to connect your cluster.
24+
- Review [frequently asked questions](faq.md) about Arc-enabled Kubernetes.

articles/azure-arc/kubernetes/plan-at-scale-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The purpose of this article is to ensure you're prepared for a successful deploy
3030
- Create a Kubernetes cluster using Docker for [Mac](https://docs.docker.com/docker-for-mac/#kubernetes) or [Windows](https://docs.docker.com/docker-for-windows/#kubernetes)
3131
- Self-managed Kubernetes cluster using [Cluster API](https://cluster-api.sigs.k8s.io/user/quick-start.html)
3232

33-
* Your machines have connectivity from your on-premises network or other cloud environment to resources in Azure, either directly or through a proxy server. More details can be found under [network prerequisites](quickstart-connect-cluster.md#meet-network-requirements).
33+
* Your machines have connectivity from your on-premises network or other cloud environment to resources in Azure, either directly or through a proxy server. More details can be found under [network prerequisites](network-requirements.md).
3434

3535
* A `kubeconfig` file pointing to the cluster you want to connect to Azure Arc.
3636
* 'Read' and 'Write' permissions for the user or service principal creating the Azure Arc-enabled Kubernetes resource type of `Microsoft.Kubernetes/connectedClusters`.

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

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ For a conceptual look at connecting clusters to Azure Arc, see [Azure Arc-enable
1515

1616
## Prerequisites
1717

18+
In addition to the prerequisites below, be sure to meet all [network requirements for Azure Arc-enabled Kubernetes](network-requirements.md).
19+
1820
### [Azure CLI](#tab/azure-cli)
1921

2022
* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
@@ -133,14 +135,6 @@ For a conceptual look at connecting clusters to Azure Arc, see [Azure Arc-enable
133135
134136
---
135137
136-
## Meet network requirements
137-
138-
[!INCLUDE [network-requirement-principles](../includes/network-requirement-principles.md)]
139-
140-
[!INCLUDE [network-requirements](includes/network-requirements.md)]
141-
142-
For a complete list of network requirements for Azure Arc features and Azure Arc-enabled services, see [Azure Arc network requirements (Consolidated)](../network-requirements-consolidated.md).
143-
144138
## Create a resource group
145139
146140
Run the following command:

articles/azure-arc/kubernetes/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
items:
3232
- name: Agent overview
3333
href: conceptual-agent-overview.md
34+
- name: Network requirements
35+
href: network-requirements.md
3436
- name: Connectivity modes
3537
href: conceptual-connectivity-modes.md
3638
- name: Data exchange between cluster and Azure

articles/azure-arc/kubernetes/troubleshooting.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ For more information, see [Debugging DNS Resolution](https://kubernetes.io/docs/
7878

7979
### Outbound network connectivity issues
8080

81-
Issues with outbound network connectivity from the cluster may arise for different reasons. First make sure all of the [network requirements](quickstart-connect-cluster.md#meet-network-requirements) have been met.
81+
Issues with outbound network connectivity from the cluster may arise for different reasons. First make sure all of the [network requirements](network-requirements.md) have been met.
8282

8383
If you encounter this issue, and your cluster is behind an outbound proxy server, make sure you have passed proxy parameters during the onboarding of your cluster and that the proxy is configured correctly. For more information, see [Connect using an outbound proxy server](quickstart-connect-cluster.md#connect-using-an-outbound-proxy-server).
8484

8585
### Unable to retrieve MSI certificate
8686

87-
Problems retrieving the MSI certificate are usually due to network issues. Check to make sure all of the [network requirements](quickstart-connect-cluster.md#meet-network-requirements) have been met, then try again.
87+
Problems retrieving the MSI certificate are usually due to network issues. Check to make sure all of the [network requirements](network-requirements.md) have been met, then try again.
8888

8989
### Azure CLI is unable to download Helm chart for Azure Arc agents
9090

@@ -183,7 +183,7 @@ To resolve this issue, try the following steps.
183183
name: azure-identity-certificate
184184
```
185185

186-
To resolve this issue, try deleting the Arc deployment by running the `az connectedk8s delete` command and reinstalling it. If the issue continues to happen, it could be an issue with your proxy settings. In that case, [try connecting your cluster to Azure Arc via a proxy](./quickstart-connect-cluster.md#connect-using-an-outbound-proxy-server) to connect your cluster to Arc via a proxy. Please also verify if all the [network prerequisites](quickstart-connect-cluster.md#meet-network-requirements) have been met.
186+
To resolve this issue, try deleting the Arc deployment by running the `az connectedk8s delete` command and reinstalling it. If the issue continues to happen, it could be an issue with your proxy settings. In that case, [try connecting your cluster to Azure Arc via a proxy](./quickstart-connect-cluster.md#connect-using-an-outbound-proxy-server) to connect your cluster to Arc via a proxy. Please also verify if all the [network prerequisites](network-requirements.md) have been met.
187187

188188
4. If the `clusterconnect-agent` and the `config-agent` pods are running, but the `kube-aad-proxy` pod is missing, check your pod security policies. This pod uses the `azure-arc-kube-aad-proxy-sa` service account, which doesn't have admin permissions but requires the permission to mount host path.
189189

@@ -487,7 +487,7 @@ az connectedk8s proxy -n AzureArcTest -g AzureArcTest
487487
Hybrid connection for the target resource does not exist. Agent might not have started successfully.
488488
```
489489

490-
Be sure to use the `connectedk8s` Azure CLI extension with version >= 1.2.0, then [connect your cluster again](quickstart-connect-cluster.md) to Azure Arc. Also, verify that you've met all the [network prerequisites](quickstart-connect-cluster.md#meet-network-requirements) needed for Arc-enabled Kubernetes.
490+
Be sure to use the `connectedk8s` Azure CLI extension with version >= 1.2.0, then [connect your cluster again](quickstart-connect-cluster.md) to Azure Arc. Also, verify that you've met all the [network prerequisites](network-requirements.md) needed for Arc-enabled Kubernetes.
491491

492492
If your cluster is behind an outbound proxy or firewall, verify that websocket connections are enabled for `*.servicebus.windows.net`, which is required specifically for the [Cluster Connect](cluster-connect.md) feature.
493493

0 commit comments

Comments
 (0)