Skip to content

Commit f3c8ed5

Browse files
authored
Merge pull request #16333 from v-sissondan/arc-gateway
Arc gateway updates
2 parents 8c7ec1d + 097e868 commit f3c8ed5

4 files changed

+101
-163
lines changed

azure-local/deploy/deployment-azure-arc-gateway-configure-manually.md

Lines changed: 15 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Configure Arc proxy manually for Azure gateway on Azure Local, version 24
33
description: Learn how to configure Arc proxy manually for Azure gateway on Azure Local, version 2408 and 2408.1 (preview).
44
author: alkohli
55
ms.topic: how-to
6-
ms.date: 10/15/2024
6+
ms.date: 11/18/2024
77
ms.author: alkohli
88
ms.service: azure-stack-hci
99
---
1010

1111
# Configure Arc proxy manually for Azure gateway on Azure Local (preview)
1212

13-
Applies to: Azure Local, version 23H2, release 2408.1 and 2408
13+
Applies to: Azure Local, version 23H2, release 2408, 2408.1, 2408.2, and 2411
1414

1515
After creating the Arc gateway resource in your Azure subscription, you can enable the new Arc gateway preview features. This article details how to manually configure the Arc proxy before Arc registration.
1616

@@ -20,86 +20,46 @@ After creating the Arc gateway resource in your Azure subscription, you can enab
2020

2121
Make sure the following prerequisites are met before proceeding:
2222

23-
- You’ve access to an Azure Local, version 23H2 system.
23+
- You’ve access to an Azure Local instance running version 23H2.
2424

2525
- An Arc gateway resource created in the same subscription as used to deploy Azure Local. For more information, see [Create the Arc gateway resource in Azure](deployment-azure-arc-gateway-overview.md#create-the-arc-gateway-resource-in-azure).
2626

27-
> [!Warning]
28-
> Only the standard ISO OS image available at https://aka.ms/PVenEREWEEW should be used to test the Arc gateway public preview on Azure Local, version 2408. Do not use the ISO image available in Azure portal.
29-
30-
## Step 1: Manually configure the proxy on each node
27+
## Step 1: Manually configure the proxy
3128

3229
If you need to configure the Arc proxy on your Azure Local machines before starting the Arc registration process, follow the instructions at [Configure proxy settings for Azure Local, version 23H2](../manage/configure-proxy-settings-23h2.md).
3330

3431
Ensure that you configure the proxy and the bypass list for all the machines on your system.
3532

3633
## Step 2: Get the ArcGatewayID
3734

38-
You need the proxy and the Arc gateway ID (ArcGatewayID) from Azure to run the registration script on Azure Local machines. To get the ArcGatewayID, run the following `az connectedmachine gateway list` command from any computer that is not an Azure Local machine.
39-
40-
Here's an example:
41-
42-
```azurecli
43-
PS C:\> az connectedmachine gateway list
44-
45-
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
46-
47-
[
48-
  {
49-
    "allowedFeatures": [
50-
      "*"
51-
    ],
52-
    "gatewayEndpoint": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx.gw.arc.azure.com",
53-
    "gatewayId": "xxxxxxx-xxxx-xxx-xxxx-xxxxxxxxx",
54-
    "gatewayType": "Public",
55-
    "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/yourresourcegroup/providers/Microsoft.HybridCompute/gateways/yourArcgateway",
56-
    "location": "eastus",
57-
    "name": " yourArcgateway",
58-
    "provisioningState": "Succeeded",
59-
    "resourceGroup": "yourresourcegroup",
60-
    "type": "Microsoft.HybridCompute/gateways"
61-
  }
62-
]
63-
```
35+
You need the proxy and the Arc gateway ID (ArcGatewayID) from Azure to run the registration script on Azure Local machines. You can find the Arc gateway ID on the Azure portal overview page of the resource.
6436

6537
## Step 3: Register new machines in Azure Arc
6638

67-
You run the initialization script by passing the ArcGatewayID parameter and the proxy server parameters. Here's an example of how you should change the `Invoke-AzStackHciArcInitialization` parameters on the initialization script:
39+
To register new version 2408 or version 2411 machines in Azure Arc, you run the initialization script by passing the ArcGatewayID parameter and the proxy server parameters. Here's an example of how you should change the `Invoke-AzStackHciArcInitialization` parameters on the initialization script:
6840

6941
```azurecli
70-
#Install required PowerShell modules in your machine for registration
71-
72-
Install-Module Az.Accounts -RequiredVersion 2.13.2
73-
74-
Install-Module Az.Resources -RequiredVersion 6.12.0
75-
76-
Install-Module Az.ConnectedMachine -RequiredVersion 0.5.2
77-
78-
#Install Arc registration script from PSGallery
79-
80-
Install-Module AzsHCI.ARCinstaller
81-
82-
#Define the subscription where you want to register your machine as Arc device
42+
#Define the subscription where you want to register your server as Arc device.
8343
84-
$Subscription = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
44+
$Subscription = "yoursubscription>"
8545
86-
#Define the resource group where you want to register your machine as Arc device
46+
#Define the resource group where you want to register your server as Arc device.
8747
8848
$RG = "yourresourcegroupname"
8949
90-
#Define the tenant you will use to register your machine as Arc device
50+
#Define the tenant you will use to register your server as Arc device.
9151
92-
$Tenant = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
52+
$Tenant = "yourtenant"
9353
9454
#Define Proxy Server if necessary
9555
9656
$ProxyServer = "http://x.x.x.x:port"
9757
9858
#Define the Arc gateway resource ID from Azure
9959
100-
$ArcgwId = "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx /resourceGroups/ yourresourcegroupname /providers/Microsoft.HybridCompute/gateways/yourarcgatewayname"
60+
$ArcgwId = "/subscriptions/yoursubscription/resourceGroups/yourresourcegroupname/providers/Microsoft.HybridCompute/gateways/yourarcgatewayname"
10161
102-
#Connect to your Azure account and Subscription
62+
#Connect to your Azure account and subscription
10363
10464
Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
10565
@@ -126,7 +86,7 @@ Once the Azure Local machines are registered in Azure Arc and all the extensions
12686

12787
## Step 5: Verify that the setup succeeded
12888

129-
Once the deployment validation starts, you can connect to the first Azure Local machine from your machine and open the Arc gateway log to monitor which endpoints are redirected to the Arc gateway and which ones continue using your firewall or proxy.
89+
Once the deployment validation starts, you can connect to the first Azure Local machine from your system and open the Arc gateway log to monitor which endpoints are redirected to the Arc gateway and which ones continue using your firewall or proxy.
13090

13191
You can find the Arc gateway log at: *c:\programdata\AzureConnectedMAchineAgent\Log\arcproxy.log*.
13292

@@ -136,7 +96,7 @@ To check the Arc agent configuration and verify that it is using the Arc gateway
13696

13797
The result should show the following values:
13898

139-
- **Agent version** is **1.45**.
99+
- **Agent version** is **1.45** or above.
140100

141101
- **Agent Status** is **Connected**.
142102

azure-local/deploy/deployment-azure-arc-gateway-configure-via-script.md

Lines changed: 14 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Configure Arc proxy via registration script for Azure gateway on Azure Lo
33
description: Learn how to Configure Arc proxy via registration script for Azure gateway on Azure Local, version 2408 (preview).
44
author: alkohli
55
ms.topic: how-to
6-
ms.date: 10/16/2024
6+
ms.date: 11/18/2024
77
ms.author: alkohli
88
ms.service: azure-stack-hci
99
---
1010

1111
# Configure Arc proxy via registration script for Azure gateway on Azure Local (preview)
1212

13-
Applies to: Azure Local, version 23H2, release 2408.1 and 2408
13+
Applies to: Azure Local, version 23H2, release 2408, 2408.1, 2408.2, and 2411
1414

1515
After creating the Arc gateway resource in your Azure subscription, you can enable the new Arc gateway preview features. This article details how to configure the Arc proxy before Arc registration using a registration script for the Arc gateway on Azure Local.
1616

@@ -26,63 +26,32 @@ Make sure the following prerequisites are met before proceeding:
2626

2727
- An Arc gateway resource created in the same subscription as used to deploy Azure Local. For more information, see [Create the Arc gateway resource in Azure](deployment-azure-arc-gateway-overview.md#create-the-arc-gateway-resource-in-azure).
2828

29-
> [!Warning]
30-
> Only the standard ISO OS image available at https://aka.ms/PVenEREWEEW should be used to test the Arc gateway public preview on Azure Local, version 2408. Do not use the ISO image available in Azure portal.
31-
3229
## Step 1: Get the ArcGatewayID
3330

34-
You need the proxy and the ArcGatewayID from Azure to run the registration script on Azure Local machine. To get the ArcGatewayID value, run the `az connectedmachine gateway list` command described previously. Do not run this command from any Azure Local machines:
35-
36-
```azurecli
37-
PS C:\> az connectedmachine gateway list
38-
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
39-
[
40-
  {
41-
    "allowedFeatures": [
42-
      "*"
43-
    ],
44-
    "gatewayEndpoint": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx.gw.arc.azure.com",
45-
    "gatewayId": "xxxxxxx-xxxx-xxx-xxxx-xxxxxxxxx",
46-
    "gatewayType": "Public",
47-
    "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/yourresourcegroup/providers/Microsoft.HybridCompute/gateways/yourArcgateway",
48-
    "location": "eastus",
49-
    "name": " yourArcgateway",
50-
    "provisioningState": "Succeeded",
51-
    "resourceGroup": "yourresourcegroup",
52-
    "type": "Microsoft.HybridCompute/gateways"
53-
  }
54-
]
55-
```
31+
You need the proxy and the ArcGatewayID from Azure to run the registration script on Azure Local machines. You can find the Arc gateway id on the Azure portal overview page of the resource.
5632

57-
## Step 2: Register new Azure Local machines running version 2408
33+
## Step 2: Register new machines in Azure Arc
5834

59-
You can run the initialization script by passing the `ArcGatewayID`, `Proxy server`, and `Proxy bypass list` parameters.
35+
To register new version 2408 or version 2411 machines in Azure Arc, you run
36+
the initialization script by passing the `ArcGatewayID`, `Proxy server`, and `Proxy bypass list` parameters.
6037

6138
Here's an example of how you should change these parameters for the `Invoke-AzStackHciArcInitialization` initialization script. Once registration is completed, the Azure Local machines are registered in Azure Arc using the Arc gateway:
6239

6340
```azurecli
64-
#Install required PowerShell modules in your machine for registration
65-
Install-Module Az.Accounts -RequiredVersion 2.13.2
66-
Install-Module Az.Resources -RequiredVersion 6.12.0
67-
Install-Module Az.ConnectedMachine -RequiredVersion 0.5.2
68-
69-
#Install Arc registration script from PSGallery
70-
Install-Module AzsHCI.ARCinstaller
71-
72-
#Define the subscription where you want to register your machine as Arc device
73-
$Subscription = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
41+
#Define the subscription where you want to register your server as Arc device.
42+
$Subscription = "yoursubscription"
7443
75-
#Define the resource group where you want to register your machine as Arc device
44+
#Define the resource group where you want to register your server as Arc device.
7645
$RG = "yourresourcegroupname"
7746
78-
#Define the tenant to use to register your machine as Arc device
79-
$Tenant = "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
47+
#Define the tenant to use to register your server as Arc device.
48+
$Tenant = "yourtenant"
8049
8150
#Define Proxy Server if necessary
8251
$ProxyServer = "http://x.x.x.x:port"
8352
8453
#Define the Arc gateway resource ID from Azure
85-
$ArcgwId = "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx /resourceGroups/ yourresourcegroupname /providers/Microsoft.HybridCompute/gateways/yourarcgatewayname"
54+
$ArcgwId = "/subscriptions/yourarcgatewayid/resourceGroups/yourresourcegroupname/providers/Microsoft.HybridCompute/gateways/yourarcgatewayname"
8655
8756
#Define the bypass list for the proxy. Use semicolon to separate each item from the list.
8857
# Use "localhost" instead of <local>
@@ -91,7 +60,7 @@ $ArcgwId = "/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx /resourceGroups/ yo
9160
# Append * for domain names exclusions like *.contoso.com
9261
# DO NOT INCLUDE .svc on the list. The registration script takes care of Environment Variables configuration.
9362
94-
$ProxyBypassList = "localhost;127.0.0.1;*.contoso.com;Node1;Node2;Node3;Node4;Node5;192.168.*.*;HCI-cluster1"
63+
$ProxyBypassList = "localhost;127.0.0.1;*.contoso.com;machine1;machine2;machine3;machine4;machine5;192.168.*.*;AzureLocal-1"
9564
9665
#Connect to your Azure account and Subscription
9766
Connect-AzAccount -SubscriptionId $Subscription -TenantId $Tenant -DeviceCode
@@ -118,7 +87,7 @@ To check the Arc agent configuration and verify that it is using the gateway, ru
11887

11988
The values displayed should be as follows:
12089

121-
- **Agent version** is **1.45**.
90+
- **Agent version** is **1.45** or above.
12291

12392
- **Agent Status** should show as **Connected**.
12493

0 commit comments

Comments
 (0)