You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: azure-local/deploy/deployment-arc-register-configurator-app.md
+47-36Lines changed: 47 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,17 +23,17 @@ You can use the Configurator app or Azure CLI to register your machines. Use the
23
23
24
24
Before you begin, make sure that you complete the following prerequisites:
25
25
26
-
### Node prerequisites
26
+
### Azure Local machine prerequisites
27
27
28
-
1. Procure the hardware that you intend to use as an Azure Local system. Nodes must be powered on and connected to the network.
28
+
1. Procure the hardware that you intend to use as an Azure Local system. Turn on these machines and connect them to the network.
29
29
30
30
1. Complete [prerequisites for your environment](../deploy/deployment-prerequisites.md).
31
31
32
32
1.[Prepare Active Directory](../deploy/deployment-prep-active-directory.md).
33
33
34
34
1.[Download the English-language Preview ISO](https://aka.ms/HCIReleaseImage) and install the preview version of Azure Local, version 23H2 OS.
35
35
36
-
1. Use the English-language Preview ISO that you downloaded and follow the steps for OS installation in [Install Azure Local, version 23H2 OS](../deploy/deployment-install-os.md).
36
+
1. Use the English-language Preview ISO that you downloaded and follow the steps for OS installation in [Install Azure Local Operating System](../deploy/deployment-install-os.md).
37
37
38
38
1. Download the [Configurator App for Azure Local](https://aka.ms/ConfiguratorAppForHCI).
39
39
@@ -44,7 +44,7 @@ Before you begin, make sure that you complete the following prerequisites:
44
44
45
45
### Azure prerequisites
46
46
47
-
1. Make sure your Azure subscription is registered against the required resource providers. To register, you must be an owner or contributor on your subscription. You can also ask an administrator to register.
47
+
1. Make sure that your Azure subscription is registered against the required resource providers. To register, you must be an owner or contributor on your subscription. You can also ask an administrator to register.
48
48
49
49
Run the following [PowerShell commands](/azure/azure-resource-manager/management/resource-providers-and-types#azure-powershell) to register:
50
50
@@ -63,18 +63,15 @@ Before you begin, make sure that you complete the following prerequisites:
63
63
64
64
1. Scroll down to the Tenant ID section and copy the **Tenant ID** value to use later.
65
65
66
-
1. If you [Set up an Azure Arc gateway](../deploy/deployment-azure-arc-gateway-overview.md#create-the-arc-gateway-resource-in-azure), get the resource ID of the Arc gateway. This is also referred to as the `ArcGatewayID`.
66
+
1.Skip this step if you didn't set up Azure Arc gateway. If you [Set up an Azure Arc gateway](../deploy/deployment-azure-arc-gateway-overview.md#create-the-arc-gateway-resource-in-azure), get the resource ID of the Arc gateway. This is also referred to as the `ArcGatewayID`.
67
67
68
-
To get the `ArcGatewayID`, run the following command:
68
+
1.To get the `ArcGatewayID`, run the following command:
69
69
70
-
```powershell
71
-
az connectedmachine gateway list
72
-
```
70
+
```powershell
71
+
az connectedmachine gateway list
72
+
```
73
73
74
-
1. Make a note of the Arc gateway ID to use later.
75
-
76
-
> [!NOTE]
77
-
> If you didn't set up an Azure Arc gateway, skip this step.
74
+
1. Make a note of the Arc gateway ID to use later.
78
75
79
76
1. As you register machines as Arc resources, make sure that you're either the resource group owner or have the following permissions on the resource group where the machines are provisioned:
80
77
@@ -97,30 +94,42 @@ Follow these steps to configure network settings and connect the machines to Azu
97
94
98
95
1. Open the Configurator app. Sign into the machine using the machine serial number.
99
96
100
-
:::image type="content" source="media/config-app/access-the-device-1.png" alt-text="Screenshot of the Device serial number dialog in the Configurator app for Azure Local." lightbox="media/config-app/access-the-device-1.png":::
97
+
:::image type="content" source="media/deployment-arc-register-configurator-app/access-the-device-1.png" alt-text="Screenshot of the machine serial number dialog in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/access-the-device-1.png":::
101
98
102
99
1. Sign in to the machine with local administrator credentials.
103
100
104
-
1. On the **Prerequisites** tab, verify that the minimum requirements are met. If a requirement is not met, the app displays a warning icon. Resolve the issue before you proceed.
101
+
:::image type="content" source="media/deployment-arc-register-configurator-app/access-the-device-2.png" alt-text="Screenshot of the password in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/access-the-device-2.png":::
102
+
103
+
1. On the Azure Arc agent setup page, select **Start**.
104
+
105
+
:::image type="content" source="media/deployment-arc-register-configurator-app/start-setup-1.png" alt-text="Screenshot of the Azure Arc agent setup page with Start selected in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/start-setup-1.png":::
106
+
107
+
1. On the **Prerequisites** tab, verify that the minimum requirements are met.
108
+
109
+
:::image type="content" source="media/deployment-arc-register-configurator-app/prerequisites-1.png" alt-text="Screenshot of the Prerequisites tab in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/prerequisites-1.png":::
105
110
106
-
:::image type="content" source="media/config-app/prerequisites-2.png" alt-text="Screenshot of the Prerequisites tab in the Configurator app for Azure Local." lightbox="media/config-app/prerequisites-2.png":::
111
+
If a requirement is not met, the app displays a warning icon. Resolve the issue before you proceed.
112
+
113
+
:::image type="content" source="media/deployment-arc-register-configurator-app/prerequisites-2.png" alt-text="Screenshot of the Prerequisites tab in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/prerequisites-2.png":::
107
114
108
115
1. On the **Basics** tab, configure one network interface that is connected to the internet. Select the **Pencil icon** to modify network interface settings.
109
116
110
-
:::image type="content" source="media/config-app/basics-tab-3.png" alt-text="Screenshot of the Basics tab in the Configurator app for Azure Local." lightbox="media/config-app/basics-tab-3.png":::
117
+
:::image type="content" source="media/deployment-arc-register-configurator-app/basics-tab-1.png" alt-text="Screenshot of the Basics tab in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/basics-tab-2.png":::
111
118
112
119
1. Provide the interface name, IP allocation as static or DHCP, IP address, subnet, gateway, and preferred DNS servers. Optionally, enter an alternate DNS server.
113
120
121
+
:::image type="content" source="media/deployment-arc-register-configurator-app/basics-tab-2.png" alt-text="Screenshot of the Basics tab with Network settings configured in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/basics-tab-1.png":::
122
+
114
123
> [!IMPORTANT]
115
124
> Make sure that the IPs you assign are free and not in use.
116
125
117
126
1. To specify more details, select **Enter additional details**.
118
127
119
-
:::image type="content" source="media/config-app/basics-tab-additional-details-4.png" alt-text="Screenshot of the Basics tab with additional details in the Configurator app for Azure Local." lightbox="media/config-app/basics-tab-additional-details-4.png":::
120
-
121
128
1. On the **Additional details** blade, provide the following inputs and then select **Apply**.
122
129
123
-
1. Enable Remote desktop protocol.
130
+
:::image type="content" source="media/deployment-arc-register-configurator-app/basics-tab-additional-details-1.png" alt-text="Screenshot of the Basics tab with additional details configured in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/basics-tab-additional-details-1.png":::
131
+
132
+
1. Enable **Remote desktop** protocol.
124
133
125
134
1. Select **Public endpoint** or **Proxy server** as the connectivity method. If selecting a proxy server, provide the proxy URL and the bypass list.
126
135
@@ -134,6 +143,8 @@ Follow these steps to configure network settings and connect the machines to Azu
134
143
135
144
1. On the **Arc agent setup** tab, under **Arc agent details**, specify the following inputs:
136
145
146
+
:::image type="content" source="media/deployment-arc-register-configurator-app/arc-agent-setup-tab-1.png" alt-text="Screenshot of the Arc agent setup tab in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/arc-agent-setup-tab-1.png":::
147
+
137
148
1. Enter a **Subscription ID** to register the machine.
138
149
139
150
1. Provide a **Resource group** name. This resource group contains the machine and system resources that you create.
@@ -154,15 +165,15 @@ Follow these steps to configure network settings and connect the machines to Azu
154
165
155
166
1. On the **Arc agent setup** tab, select **Next**.
156
167
157
-
:::image type="content" source="media/config-app/arc-agent-setup-tab-5.png" alt-text="Screenshot of the Arc agent setup tab in the Configurator app for Azure Local." lightbox="media/config-app/arc-agent-setup-tab-5.png":::
158
-
159
168
1. On the **Review and apply** tab, verify machine details. To modify any settings, go back. If satisfied with the current settings, select **Finish**. If you changed the hostname, your machines boot up automatically at this point and you must sign in again.
160
169
161
-
1. Wait for the configuration to complete. First, device details are uploaded followed by registration of the machines to Azure.
170
+
:::image type="content" source="media/deployment-arc-register-configurator-app/review-apply-tab-1.png" alt-text="Screenshot of the Review and apply tab in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/review-apply-tab-1.png":::
171
+
172
+
1. Wait for the configuration to complete. First, machine details are uploaded followed by registration of the machines to Azure.
162
173
163
174
1. During the Arc registration process, you must authenticate with your Azure account. The app displays a code that you must enter in the URL, displayed in the app, in order to authenticate. Follow the instructions to complete the authentication process.
164
175
165
-
:::image type="content" source="media/config-app/arc-agent-registration-6.png" alt-text="Screenshot of the Arc agent sign in and registration dialog in the Configurator app for Azure Local." lightbox="media/config-app/arc-agent-registration-6.png":::
176
+
:::image type="content" source="media/deployment-arc-register-configurator-app/arc-agent-registration-6.png" alt-text="Screenshot of the Arc agent sign in and registration dialog in the Configurator app for Azure Local." lightbox="media/deployment-arc-register-configurator-app/arc-agent-registration-6.png":::
166
177
167
178
1. Once the configuration is complete, status for Arc configuration should display **Success (Open in Azure portal)**.
168
179
@@ -190,35 +201,35 @@ If you can access the app, follow the instructions in [Run diagnostic tests](#
190
201
191
202
### Run diagnostic tests from the app
192
203
193
-
To diagnose and troubleshoot any device issues related to hardware, time server, and network, you can run the diagnostics tests. Use these steps to run the diagnostic tests from the app:
204
+
To diagnose and troubleshoot any machine issues related to hardware, time server, and network, you can run the diagnostics tests. Use these steps to run the diagnostic tests from the app:
194
205
195
206
1. Select the help icon in the top-right corner of the app to open the **Support + troubleshooting** pane.
196
207
197
-
1. Select **Run diagnostic tests**. The diagnostic tests check the health of the machine hardware, time server, and the network connectivity. The tests also check the status of the Azure Arc agent and the extensions.
208
+
1. Select **Run diagnostic tests**. The diagnostic tests check the health of the machine hardware, time server, and the network connectivity. The tests also check the status of the Azure Arc agent.
198
209
199
-
:::image type="content" source="media/deployment-arc-register-local-ui/run-diagnostics-tests-1.png" alt-text="Screenshot that shows the Support and troubleshooting pane with Run diagnostic tests selected."lightbox="media/deployment-arc-register-local-ui/run-diagnostics-tests-1.png":::
210
+
:::image type="content" source="media/deployment-arc-register-configurator-app/run-diagnostics-tests-1.png" alt-text="Screenshot that shows the Support and troubleshooting pane with Run diagnostic tests selected."lightbox="media/deployment-arc-register-configurator-app/run-diagnostics-tests-1.png":::
200
211
201
-
1. After the tests are completed, the results are displayed. Here's a sample output of the diagnostic tests when there's a device issue:
212
+
1. After the tests are completed, the results are displayed. Here's a sample output of the diagnostic tests when there's a machine issue:
202
213
203
-
:::image type="content" source="media/deployment-arc-register-local-ui/run-diagnostics-tests-2.png" alt-text="Screenshot that shows the error output after the diagnostic tests were run."lightbox="media/deployment-arc-register-local-ui/run-diagnostics-tests-1.png":::
214
+
:::image type="content" source="media/deployment-arc-register-configurator-app/run-diagnostics-tests-2.png" alt-text="Screenshot that shows the error output after the diagnostic tests were run."lightbox="media/deployment-arc-register-configurator-app/run-diagnostics-tests-1.png":::
204
215
205
216
Here's a table that describes the diagnostic tests:
| Internet connectivity | This test validates the internet connectivity of the device. |
210
-
| Web proxy (if configured) | This test validates the web proxy configuration of the device. |
211
-
| Time sync | This test validates the device time settings and checks that the time server configured on the device is valid and accessible. |
212
-
| Azure Arc agent | This test validates the Azure Arc agent is installed and running on the device. |
213
-
| Environment checker | The Environment Checker tool runs a series of tests to evaluate the deployment readiness of your environment for Azure Local deployment including those for connectivity, hardware, Active Directory, network, and Arc integration. For more information, see [Evaluate the deployment readiness of your environment for Azure Local, version 23H2](../manage/use-environment-checker.md#about-the-environment-checker-tool)|
220
+
| Internet connectivity | This test validates the internet connectivity of the machine. |
221
+
| Web proxy (if configured) | This test validates the web proxy configuration of the machine. |
222
+
| Time sync | This test validates the machine time settings and checks that the time server configured on the machine is valid and accessible. |
223
+
| Azure Arc agent | This test validates the Azure Arc agent is installed and running on the machine. |
224
+
| Environment checker | The Environment Checker tool runs a series of tests to evaluate the deployment readiness of your environment for Azure Local deployment including those for connectivity, hardware, Active Directory, network, and Arc integration. For more information, see [Evaluate the deployment readiness of your environment for Azure Local](../manage/use-environment-checker.md#about-the-environment-checker-tool) |
214
225
215
226
### Collect a Support package from the app
216
227
217
-
A log package is composed of all the relevant logs that can help Microsoft Support troubleshoot any device issues. You can generate a log package via the app. Follow these steps to collect a Support package from the app:
228
+
A log package is composed of all the relevant logs that can help Microsoft Support troubleshoot any machine issues. You can generate a log package via the app. Follow these steps to collect a Support package from the app:
218
229
219
230
1. Select the help icon in the top-right corner of the app to open the **Support + troubleshooting** pane. Select **Create** to begin support package collection. The package collection could take several minutes.
220
231
221
-
:::image type="content" source="media/deployment-arc-register-local-ui/collect-support-package-1.png" alt-text="Screenshot that shows the Support and troubleshooting pane with Create selected." lightbox="media/deployment-arc-register-local-ui/collect-support-package-1.png":::
232
+
:::image type="content" source="media/deployment-arc-register-configurator-app/collect-support-package-1.png" alt-text="Screenshot that shows the Support and troubleshooting pane with Create selected." lightbox="media/deployment-arc-register-configurator-app/collect-support-package-1.png":::
222
233
223
234
1. After the Support package is created, select **Download**. A zipped package is downloaded on your local system. You can unzip the package and view the system log files.
0 commit comments