Skip to content

Commit 6079e2d

Browse files
author
Ryan Willis
committed
Updated directories, extension info and image
1 parent 004b254 commit 6079e2d

File tree

2 files changed

+50
-54
lines changed

2 files changed

+50
-54
lines changed

articles/azure-arc/servers/agent-overview.md

Lines changed: 50 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Overview of the Connected Machine agent
33
description: This article provides a detailed overview of the Azure Arc-enabled servers agent available, which supports monitoring virtual machines hosted in hybrid environments.
4-
ms.date: 10/12/2021
4+
ms.date: 10/25/2021
55
ms.topic: conceptual
66
ms.custom: devx-track-azurepowershell
77
---
@@ -25,9 +25,9 @@ The Azure Connected Machine agent package contains several logical components, w
2525

2626
Note the following behavior with Azure Policy [guest configuration](../../governance/policy/concepts/guest-configuration.md) for a disconnected machine:
2727

28-
* An Azure Policy assignment that targets disconnected machines is unaffected.
29-
* Guest assignment is stored locally for 14 days. Within the 14-day period, if the Connected Machine agent reconnects to the service, policy assignments are reapplied.
30-
* Assignments are deleted after 14 days, and are not reassigned to the machine after the 14-day period.
28+
* An Azure Policy assignment that targets disconnected machines is unaffected.
29+
* Guest assignment is stored locally for 14 days. Within the 14-day period, if the Connected Machine agent reconnects to the service, policy assignments are reapplied.
30+
* Assignments are deleted after 14 days, and are not reassigned to the machine after the 14-day period.
3131

3232
* The Extension agent manages VM extensions, including install, uninstall, and upgrade. Extensions are downloaded from Azure and copied to the `%SystemDrive%\%ProgramFiles%\AzureConnectedMachineAgent\ExtensionService\downloads` folder on Windows, and for Linux to `/opt/GC_Ext/downloads`. On Windows, the extension is installed to the following path `%SystemDrive%\Packages\Plugins\<extension>`, and on Linux the extension is installed to `/var/lib/waagent/<extension>`.
3333

@@ -48,7 +48,7 @@ Metadata information about the connected machine is collected after the Connecte
4848
* Public key for managed identity
4949
* Policy compliance status and details (if using guest configuration policies)
5050
* SQL Server installed (Boolean value)
51-
* Cluster resource ID (for Azure Stack HCI nodes)
51+
* Cluster resource ID (for Azure Stack HCI nodes)
5252

5353
The following metadata information is requested by the agent from Azure:
5454

@@ -79,19 +79,20 @@ Azure Arc-enabled servers support the installation of the Connected Machine agen
7979

8080
The following versions of the Windows and Linux operating system are officially supported for the Azure Connected Machine agent:
8181

82-
- Windows Server 2008 R2 SP1, Windows Server 2012 R2, 2016, 2019, and 2022 (including Server Core)
83-
- Ubuntu 16.04, 18.04, and 20.04 LTS (x64)
84-
- CentOS Linux 7 and 8 (x64)
85-
- SUSE Linux Enterprise Server (SLES) 12 and 15 (x64)
86-
- Red Hat Enterprise Linux (RHEL) 7 and 8 (x64)
87-
- Amazon Linux 2 (x64)
88-
- Oracle Linux 7
82+
* Windows Server 2008 R2 SP1, Windows Server 2012 R2, 2016, 2019, and 2022 (including Server Core)
83+
* Ubuntu 16.04, 18.04, and 20.04 LTS (x64)
84+
* CentOS Linux 7 and 8 (x64)
85+
* SUSE Linux Enterprise Server (SLES) 12 and 15 (x64)
86+
* Red Hat Enterprise Linux (RHEL) 7 and 8 (x64)
87+
* Amazon Linux 2 (x64)
88+
* Oracle Linux 7
8989

9090
> [!WARNING]
9191
> The Linux hostname or Windows computer name cannot use one of the reserved words or trademarks in the name, otherwise attempting to register the connected machine with Azure will fail. See [Resolve reserved resource name errors](../../azure-resource-manager/templates/error-reserved-resource-name.md) for a list of the reserved words.
9292
9393
> [!NOTE]
9494
> While Azure Arc-enabled servers supports Amazon Linux, the following do not support this distro:
95+
>
9596
> * The Dependency agent used by Azure Monitor VM insights
9697
> * Azure Automation Update Management
9798
@@ -175,14 +176,15 @@ URLs:
175176

176177
| Agent resource | Description |
177178
|---------|---------|
179+
|`azgn*.servicebus.windows.net`|Azure Arc Connectivity Platform|
178180
|`management.azure.com`|Azure Resource Manager|
179181
|`login.windows.net`|Azure Active Directory|
180182
|`login.microsoftonline.com`|Azure Active Directory|
181183
|`pas.windows.net`|Azure Active Directory|
182-
|`dc.services.visualstudio.com`|Application Insights|
183-
|`*.guestconfiguration.azure.com` |Guest configuration|
184-
|`*.his.arc.azure.com`|Hybrid Identity Service|
184+
|`*.guestconfiguration.azure.com` |Extension and guest configuration services|
185+
|`*.his.arc.azure.com`|Metadata and hybrid identity services|
185186
|`*.blob.core.windows.net`|Download source for Azure Arc-enabled servers extensions|
187+
|`dc.services.visualstudio.com`|Agent telemetry|
186188

187189
For a list of IP addresses for each service tag/region, see the JSON file - [Azure IP Ranges and Service Tags – Public Cloud](https://www.microsoft.com/download/details.aspx?id=56519). Microsoft publishes weekly updates containing each Azure Service and the IP ranges it uses. This information in the JSON file is the current point-in-time list of the IP ranges that correspond to each service tag. The IP addresses are subject to change. If IP address ranges are required for your firewall configuration, then the **AzureCloud** Service Tag should be used to allow access to all Azure services. Do not disable security monitoring or inspection of these URLs, allow them as you would other Internet traffic.
188190

@@ -218,47 +220,44 @@ After installing the Connected Machine agent for Windows, the following system-w
218220

219221
|Folder |Description |
220222
|-------|------------|
221-
|%ProgramFiles%\AzureConnectedMachineAgent |Default installation path containing the agent support files.|
222-
|%ProgramData%\AzureConnectedMachineAgent |Contains the agent configuration files.|
223-
|%ProgramData%\AzureConnectedMachineAgent\Tokens |Contains the acquired tokens.|
224-
|%ProgramData%\AzureConnectedMachineAgent\Config |Contains the agent configuration file `agentconfig.json` recording its registration information with the service.|
225-
|%ProgramFiles%\ArcConnectedMachineAgent\ExtensionService\GC | Installation path containing the guest configuration agent files. |
226-
|%ProgramData%\GuestConfig |Contains the (applied) policies from Azure.|
227-
|%ProgramFiles%\AzureConnectedMachineAgent\ExtensionService\downloads | Extensions are downloaded from Azure and copied here.|
223+
|%ProgramFiles%\AzureConnectedMachineAgent |azcmagent CLI and instance metadata service executables.|
224+
|%ProgramFiles%\AzureConnectedMachineAgent\ExtensionService\GC | Extension service executables.|
225+
|%ProgramFiles%\AzureConnectedMachineAgent\GuestConfig\GC | Guest configuration (policy) service executables.|
226+
|%ProgramData%\AzureConnectedMachineAgent |Configuration, log and identity token files for azcmagent CLI and instance metadata service.|
227+
|%ProgramData%\GuestConfig |Extension package downloads, guest configuration (policy) definition downloads, and logs for the extension and guest configuration services.|
228228

229229
* The following Windows services are created on the target machine during installation of the agent.
230230

231231
|Service name |Display name |Process name |Description |
232232
|-------------|-------------|-------------|------------|
233-
|himds |Azure Hybrid Instance Metadata Service |himds |This service implements the Azure Instance Metadata service (IMDS) to manage the connection to Azure and the connected machine's Azure identity.|
233+
|himds |Azure Hybrid Instance Metadata Service |himds |This service implements the Hybrid Instance Metadata service (IMDS) to manage the connection to Azure and the connected machine's Azure identity.|
234234
|GCArcService |Guest configuration Arc Service |gc_service |Monitors the desired state configuration of the machine.|
235235
|ExtensionService |Guest configuration Extension Service | gc_service |Installs the required extensions targeting the machine.|
236236

237237
* The following environmental variables are created during agent installation.
238238

239239
|Name |Default value |Description |
240240
|-----|--------------|------------|
241-
|IDENTITY_ENDPOINT |http://localhost:40342/metadata/identity/oauth2/token ||
242-
|IMDS_ENDPOINT |http://localhost:40342 ||
241+
|IDENTITY_ENDPOINT |<http://localhost:40342/metadata/identity/oauth2/token> ||
242+
|IMDS_ENDPOINT |<http://localhost:40342> ||
243243

244244
* There are several log files available for troubleshooting. They are described in the following table.
245245

246246
|Log |Description |
247247
|----|------------|
248-
|%ProgramData%\AzureConnectedMachineAgent\Log\himds.log |Records details of the agents (HIMDS) service and interaction with Azure.|
249-
|%ProgramData%\AzureConnectedMachineAgent\Log\azcmagent.log |Contains the output of the azcmagent tool commands, when the verbose (-v) argument is used.|
250-
|%ProgramData%\GuestConfig\gc_agent_logs\gc_agent.log |Records details of the DSC service activity,<br> in particular the connectivity between the HIMDS service and Azure Policy.|
251-
|%ProgramData%\GuestConfig\gc_agent_logs\gc_agent_telemetry.txt |Records details about DSC service telemetry and verbose logging.|
248+
|%ProgramData%\AzureConnectedMachineAgent\Log\himds.log |Records details of the heartbeat and identity agent component.|
249+
|%ProgramData%\AzureConnectedMachineAgent\Log\azcmagent.log |Contains the output of the azcmagent tool commands.|
250+
|%ProgramData%\GuestConfig\arc_policy_logs\ |Records details about the guest configuration (policy) agent component.|
252251
|%ProgramData%\GuestConfig\ext_mgr_logs|Records details about the Extension agent component.|
253252
|%ProgramData%\GuestConfig\extension_logs\<Extension>|Records details from the installed extension.|
254253

255254
* The local security group **Hybrid agent extension applications** is created.
256255

257256
* During uninstall of the agent, the following artifacts are not removed.
258257

259-
* %ProgramData%\AzureConnectedMachineAgent\Log
260-
* %ProgramData%\AzureConnectedMachineAgent and subdirectories
261-
* %ProgramData%\GuestConfig
258+
* %ProgramData%\AzureConnectedMachineAgent\Log
259+
* %ProgramData%\AzureConnectedMachineAgent and subdirectories
260+
* %ProgramData%\GuestConfig
262261

263262
### Linux agent installation details
264263

@@ -270,54 +269,51 @@ After installing the Connected Machine agent for Linux, the following system-wid
270269

271270
|Folder |Description |
272271
|-------|------------|
273-
|/var/opt/azcmagent/ |Default installation path containing the agent support files.|
274-
|/opt/azcmagent/ |
275-
|/opt/GC_Ext | Installation path containing the guest configuration agent files.|
276-
|/opt/DSC/ |
277-
|/var/opt/azcmagent/tokens |Contains the acquired tokens.|
278-
|/var/lib/GuestConfig |Contains the (applied) policies from Azure.|
279-
|/opt/GC_Ext/downloads|Extensions are downloaded from Azure and copied here.|
272+
|/opt/azcmagent/ |azcmagent CLI and instance metadata service executables.|
273+
|/opt/GC_Ext | Extension service executables.|
274+
|/opt/GC_Service/ |Guest configuration (policy) service executables.|
275+
|/var/opt/azcmagent/ |Configuration, log and identity token files for azcmagent CLI and instance metadata service.|
276+
|/var/lib/GuestConfig |Extension package downloads, guest configuration (policy) definition downloads, and logs for the extension and guest configuration services.|
280277

281278
* The following daemons are created on the target machine during installation of the agent.
282279

283280
|Service name |Display name |Process name |Description |
284281
|-------------|-------------|-------------|------------|
285-
|himdsd.service |Azure Connected Machine Agent Service |himds |This service implements the Azure Instance Metadata service (IMDS) to manage the connection to Azure and the connected machine's Azure identity.|
282+
|himdsd.service |Azure Connected Machine Agent Service |himds |This service implements the Hybrid Instance Metadata service (IMDS) to manage the connection to Azure and the connected machine's Azure identity.|
286283
|gcad.service |GC Arc Service |gc_linux_service |Monitors the desired state configuration of the machine. |
287284
|extd.service |Extension Service |gc_linux_service | Installs the required extensions targeting the machine.|
288285

289286
* There are several log files available for troubleshooting. They are described in the following table.
290287

291288
|Log |Description |
292289
|----|------------|
293-
|/var/opt/azcmagent/log/himds.log |Records details of the agents (HIMDS) service and interaction with Azure.|
294-
|/var/opt/azcmagent/log/azcmagent.log |Contains the output of the azcmagent tool commands, when the verbose (-v) argument is used.|
295-
|/opt/logs/dsc.log |Records details of the DSC service activity,<br> in particular the connectivity between the himds service and Azure Policy.|
296-
|/opt/logs/dsc.telemetry.txt |Records details about DSC service telemetry and verbose logging.|
297-
|/var/lib/GuestConfig/ext_mgr_logs |Records details about the Extension agent component.|
298-
|/var/lib/GuestConfig/extension_logs|Records details from the installed extension.|
290+
|/var/opt/azcmagent/log/himds.log |Records details of the heartbeat and identity agent component.|
291+
|/var/opt/azcmagent/log/azcmagent.log |Contains the output of the azcmagent tool commands.|
292+
|/var/lib/GuestConfig/arc_policy_logs |Records details about the guest configuration (policy) agent component.|
293+
|/var/lib/GuestConfig/ext_mgr_logs |Records details about the extension agent component.|
294+
|/var/lib/GuestConfig/extension_logs|Records details from extension install/update/uninstall operations.|
299295

300296
* The following environmental variables are created during agent installation. These variables are set in `/lib/systemd/system.conf.d/azcmagent.conf`.
301297

302298
|Name |Default value |Description |
303299
|-----|--------------|------------|
304-
|IDENTITY_ENDPOINT |http://localhost:40342/metadata/identity/oauth2/token ||
305-
|IMDS_ENDPOINT |http://localhost:40342 ||
300+
|IDENTITY_ENDPOINT |<http://localhost:40342/metadata/identity/oauth2/token> ||
301+
|IMDS_ENDPOINT |<http://localhost:40342> ||
306302

307303
* During uninstall of the agent, the following artifacts are not removed.
308304

309-
* /var/opt/azcmagent
310-
* /opt/logs
305+
* /var/opt/azcmagent
306+
* /var/lib/GuestConfig
311307

312308
### Agent resource governance
313309

314310
Azure Arc-enabled servers Connected Machine agent is designed to manage agent and system resource consumption. The agent approaches resource governance under the following conditions:
315311

316-
- The Guest Configuration agent limits up to 5% of the CPU to evaluate policies.
317-
- The Extension Service agent is limited to use up to 5% of the CPU.
312+
* The Guest Configuration agent is limited to use up to 5% of the CPU to evaluate policies.
313+
* The Extension Service agent is limited to use up to 5% of the CPU to install and manage extensions.
318314

319-
- This only applies to install/uninstall/upgrade operations. Once installed, extensions are responsible for their own resource utilization and the 5% CPU limit does not apply.
320-
- The Log Analytics agent and Azure Monitor Agent are allowed to use up to 60% of the CPU during their install/upgrade/uninstall operations on Red Hat Linux, CentOS, and other enterprise Linux variants. The limit is higher for this combination of extensions and operating systems to accommodate the performance impact of [SELinux](https://www.redhat.com/en/topics/linux/what-is-selinux) on these systems.
315+
* Once installed, each extension is limited to use up to 5% of the CPU while running. For example, if you have 2 extensions installed, they can use a combined total of 10% of the CPU.
316+
* The Log Analytics agent and Azure Monitor Agent are allowed to use up to 60% of the CPU during their install/upgrade/uninstall operations on Red Hat Linux, CentOS, and other enterprise Linux variants. The limit is higher for this combination of extensions and operating systems to accommodate the performance impact of [SELinux](https://www.redhat.com/en/topics/linux/what-is-selinux) on these systems.
321317

322318
## Next steps
323319

173 KB
Loading

0 commit comments

Comments
 (0)