About Azure Arc gateway for Azure Stack HCI, version 23H2 (preview)
Applies to: Azure Stack HCI, version 23H2, releases 2408 and 2408.1
This article provides an overview of the Azure Arc gateway for Azure Stack HCI, version 23H2. The Arc gateway can be enabled on new deployments of Azure Stack HCI running software version 2408 or later. This article also describes how to create and delete the Arc gateway resource in Azure.
You can use the Arc gateway to significantly reduce the number of required endpoints needed to deploy and manage Azure Stack HCI clusters. Once you create the Arc gateway, you can connect to and use it for new deployments of Azure Stack HCI.
For information on how to deploy the Azure Arc gateway for standalone servers (not Azure Stack HCI node servers), see Simplify network configuration requirements through Azure Arc gateway.
Important
This feature is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.
How it works
The Arc gateway works by introducing the following components:
Arc gateway resource – An Azure resource that acts as a common entry point for Azure traffic. This gateway resource has a specific domain or URL that you can use. When you create the Arc gateway resource, this domain or URL is a part of the success response.
Arc proxy – A new component that is added to the Arc Agentry. This component runs as a service (Called the Azure Arc Proxy) and works as a forward proxy for the Azure Arc agents and extensions. The gateway router doesn't need any configuration from your side. This router is part of the Arc core agentry and runs within the context of an Arc-enabled resource.
Once you integrate the Arc gateway with version 2408 of Azure Stack HCI cluster deployments, each cluster node gets Arc proxy along with other Arc Agents.
When Arc gateway is used, the http and https traffic flow changes as follows:
Traffic flow for Azure Stack HCI host operating system components
OS proxy settings are used to route all HTTPS host traffic through Arc proxy.
From Arc proxy, the traffic is forwarded to Arc gateway.
Based on the configuration in the Arc gateway, if allowed, the traffic is sent to target services. If not allowed, Arc proxy redirects this traffic to the enterprise proxy (or direct outbound if no proxy set). Arc proxy automatically determines the right path for the endpoint.
Traffic flow for Arc appliance Arc Resource Bridge (ARB) and AKS control plane
The routable IP (failover clustered IP resource as of now) is used to forward the traffic through Arc proxy running on the Azure Stack HCI host nodes.
ARB and AKS forward proxy are configured to use the routable IP.
With the proxy settings in place, ARB, and AKS outbound traffic is forwarded to Arc Proxy running on one of the Azure Stack HCI nodes over the routable IP.
Once the traffic reaches Arc proxy, the remaining flow takes the same path as described. If traffic to the target service is allowed, it is sent to Arc gateway. If not, it is sent to the enterprise proxy (or direct outbound if no proxy set). Note that for AKS specifically, this path is used for downloading docker images for Arc Agentry and Arc Extension Pods.
Traffic flow for Arc VMs in version 2408
Http and https traffic are forwarded to the enterprise proxy. Arc proxy inside the Arc VM is not yet supported in this version.
Traffic flows are illustrated in the following diagram:
Supported and unsupported scenarios
You can use the Arc gateway in the following scenario for Azure Stack HCI version 2408:
- Enable Arc gateway during deployment of new Azure Stack HCI version 2408 clusters.
Unsupported scenarios for Azure Stack HCI version 2408 include:
Azure Stack HCI clusters updated from versions 2402 or 2405 to version 2408 can't take advantage of all the new endpoints supported by this Arc gateway public preview. Host components, Arc extensions, ARB, and AKS required endpoints are only supported when enabling the Arc gateway as part of a new version 2408 deployment.
Enabling Arc gateway after version 2408 deployment cannot take advantage of all the new endpoints supported by this Arc gateway public preview. Host, Arc extensions, ARB, and AKS required endpoints are only supported when enabling the Arc gateway as part of a new version 2408 deployment.
Azure Stack HCI 2408 endpoints not redirected
As part of the Azure Stack HCI version 2408 preview update, the endpoints from the table are required and must be allowlisted in your proxy or firewall to deploy the Azure Stack HCI cluster. These endpoints are not redirected via the Arc gateway:
Endpoint # | Required endpoint | Component |
---|---|---|
1 | http://go.microsoft.com:443 |
Environment Checker |
2 | http://www.powershellgallery.com:443 |
Environment Checker |
3 | http://psg-prod-eastus.azureedge.net:443 |
Environment Checker |
4 | http://onegetcdn.azureedge.net:443 |
Environment Checker |
5 | http://login.microsoftonline.com:443 |
Environment Checker |
6 | http://aka.ms:443 |
Environment Checker |
7 | http://azurestackreleases.download.prss.microsoft.com:443 |
Environment Checker |
8 | http://download.microsoft.com:443 |
Environment Checker |
9 | http://portal.azure.com:443 |
Environment Checker |
10 | http://management.azure.com:443 |
Environment Checker |
11 | http://www.office.com:443 |
Environment Checker |
12 | http://gbl.his.arc.azure.com:443 |
Arc agent |
13 | http://<region>.his.arc.azure.com:443 |
Arc agent |
14 | http://dc.services.visualstudio.com:443 |
Arc agent |
15 | http://<yourarcgatewayId>.gw.arc.azure.com:443 |
Arc gateway |
16 | http://<yourkeyvaultname>.vault.azure.net:443 |
Azure Key Vault |
17 | http://<yourblobstorageforcloudwitnessname>.blob.core.windows.net:443 |
Cloud Witness Storage Account |
18 | http://files.pythonhosted.org:443 |
Microsoft On-premises Cloud/ARB/AKS |
19 | http://pypi.org:443 |
Microsoft On-premises Cloud/ARB/AKS |
20 | http://raw.githubusercontent.com:443 |
Microsoft On-premises Cloud/ARB/AKS |
21 | http://pythonhosted.org:443 |
Microsoft On-premises Cloud/ARB/AKS |
22 | http://hciarcvmsstorage.z13.web.core.windows.net:443 |
Microsoft On-premises Cloud/ARB/AKS |
23 | http://ocsp.digicert.com |
Certificate Revocation List for Arc extensions |
24 | http://s.symcd.com |
Certificate Revocation List for Arc extensions |
25 | http://ts-ocsp.ws.symantec.com |
Certificate Revocation List for Arc extensions |
26 | http://ocsp.globalsign.com |
Certificate Revocation List for Arc extensions |
27 | http://ocsp2.globalsign.com |
Certificate Revocation List for Arc extensions |
28 | http://oneocsp.microsoft.com |
Certificate Revocation List for Arc extensions |
29 | http://dl.delivery.mp.microsoft.com |
LCM Binaries |
30 | http://*.tlu.dl.delivery.mp.microsoft.com |
LCM Binaries |
31 | http://*.windowsupdate.com |
Windows Update |
32 | http://*.windowsupdate.microsoft.com |
Windows Update |
33 | http://*.update.microsoft.com |
Windows Update |
Restrictions and limitations
Consider the following limitations of Arc gateway in this release:
- TLS terminating proxies aren't supported with the Arc gateway preview.
- Use of ExpressRoute, Site-to-Site VPN, or Private Endpoints in addition to the Arc gateway (Preview) isn't supported.
Prerequisite
Register your Azure subscription to join the limited public preview of the Arc gateway. You can then create the Arc gateway resource in Azure. Azure Arc gateway Limited Public Preview Sign-up form.
Warning
Only the standard ISO OS image available at https://aka.ms/PVenEREWEEW should be used to test the Arc gateway public preview on Azure Stack HCI, version 2408. Do not use the ISO image available in Azure portal.
Create the Arc gateway resource in Azure
You first create the Arc gateway resource in your Azure subscription. Don't create the Arc gateway resource from any of the HCI nodes. Do so from any computer that has an internet connection, for example, your laptop.
To create the Arc gateway resource in Azure, follow these steps:
Download the az connectedmachine.whl file extension. This file contains the az connected machine commands required to create and manage your gateway resource.
Install the Azure Command Line Interface (CLI).
Run the following command to add the extension:
az extension add --allow-preview true --yes --source [whl file path]
On a computer with access to Azure, run the following commands to create your Arc gateway resource:
az login --use-device-code az account set --subscription [subscription name or id] az connectedmachine gateway create --name [Your Gateway Name] --resource-group [Your Resource Group] --location [Location] --gateway-type public --allowed-features *
The gateway creation process takes about four to five minutes to complete.
Delete the Arc gateway resource
To delete an Arc gateway resource, you must first detach it from the servers to which it is attached.
To detach the gateway resource from your Arc-enabled server, set the connection type to direct instead of gateway. Run the following command:
azcmagent config set connection.type direct
To delete the gateway resource, run the following command:
az connectedmachine gateway delete --resource group <resource group name> --gateway-name <gateway resource name>
This operation can take a couple of minutes.