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: articles/virtual-machines/extensions/agent-linux.md
+39-39Lines changed: 39 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ ms.date: 03/28/2023
13
13
---
14
14
# Azure Linux Agent overview
15
15
16
-
The Microsoft Azure Linux Agent (waagent) manages Linux and FreeBSD provisioning, along with virtual machine (VM) interaction with the Azure fabric controller. In addition to the Linux agent providing provisioning functionality, Azure provides the option of using `cloud-init` for some Linux operating systems.
16
+
The Microsoft Azure Linux Agent (waagent) manages Linux and FreeBSD provisioning, along with virtual machine (VM) interaction with the Azure fabric controller. In addition to the Linux agent providing provisioning functionality, Azure provides the option of using cloud-init for some Linux operating systems.
17
17
18
18
The Linux agent provides the following functionality for Linux and FreeBSD Azure Virtual Machines deployments. For more information, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent/blob/master/README.md).
19
19
@@ -36,7 +36,7 @@ The Linux agent provides the following functionality for Linux and FreeBSD Azure
36
36
37
37
### Kernel
38
38
39
-
- Configures virtual NUMA (disable for kernel `2.6.37`)
39
+
- Configures virtual NUMA (disabled for kernel `2.6.37`)
40
40
- Consumes Hyper-V entropy for */dev/random*
41
41
- Configures SCSI timeouts for the root device, which can be remote
42
42
@@ -56,17 +56,17 @@ You can find a VM Extension reference implementation on [GitHub](https://github.
56
56
57
57
## Communication
58
58
59
-
The information flow from the platform to the agent occurs through two channels:
59
+
Information flow from the platform to the agent occurs through two channels:
60
60
61
-
- A boot-time attached DVD for VM deployments. This DVD includes an Open Virtualization Format (OVF)-compliant configuration file that includes all provisioning information other than the SSH key pairs.
61
+
- A boot-time attached DVD for VM deployments. This DVD includes an Open Virtualization Format (OVF)-compliant configuration file that contains all provisioning information other than the SSH key pairs.
62
62
- A TCP endpoint that exposes a REST API that's used to get deployment and topology configuration.
63
63
64
64
## Requirements
65
65
66
-
The following systems have been tested and are known to work with the Azure Linux Agent:
66
+
Testing has confirmed that the following systems work with the Azure Linux Agent.
67
67
68
68
> [!NOTE]
69
-
> This list might differ from the [Endorsed Linux distributions on Azure](../linux/endorsed-distros.md).
69
+
> This list might differ from the [endorsed Linux distributions on Azure](../linux/endorsed-distros.md).
70
70
71
71
| Distribution | x64 | ARM64 |
72
72
|:-----|:-----:|:-----:|
@@ -82,13 +82,13 @@ The following systems have been tested and are known to work with the Azure Linu
> RHEL/Oracle Linux 6.10 is the only RHEL/OL 6 version with ELS support available. [The extended maintenance ends on June 30, 2024](https://access.redhat.com/support/policy/updates/errata).
85
+
> RHEL/Oracle Linux 6.10 is the only RHEL/OL 6 version with Extended Lifecycle Support available. [The extended maintenance ends on June 30, 2024](https://access.redhat.com/support/policy/updates/errata).
86
86
87
87
Other supported systems:
88
88
89
89
- FreeBSD 10+ (Azure Linux Agent v2.0.10+)
90
90
91
-
The Linux agent depends on some system packages to function properly:
91
+
The Linux agent depends on these system packages to function properly:
92
92
93
93
- Python 2.6+
94
94
- OpenSSL 1.0+
@@ -164,7 +164,7 @@ HttpProxy.Port=None
164
164
AutoUpdate.Enabled=y
165
165
```
166
166
167
-
Configuration options are of three types: `Boolean`, `String`, or `Integer`. The `Boolean` configuration options can be specified as `y` or `n`. The special keyword `None` might be used for some string type configuration entries.
167
+
Configuration options are of three types: `Boolean`, `String`, or `Integer`. You can specify the `Boolean` configuration options as `y` or `n`. The special keyword `None` might be used for some string type configuration entries.
168
168
169
169
### Provisioning.Enabled
170
170
@@ -185,7 +185,7 @@ Type: Boolean
185
185
Default: n
186
186
```
187
187
188
-
If `y`, the agent erases the root password in the */etc/shadow* file during the provisioning process.
188
+
If the value is `y`, the agent erases the root password in the */etc/shadow* file during the provisioning process.
189
189
190
190
### Provisioning.RegenerateSshHostKeyPair
191
191
@@ -194,7 +194,7 @@ Type: Boolean
194
194
Default: y
195
195
```
196
196
197
-
If `y`, the agent deletes all SSH host key pairs from */etc/ssh/* during the provisioning process, including ECDSA, DSA, and RSA. The agent generates a single fresh key pair.
197
+
If the value is `y`, the agent deletes all SSH host key pairs from */etc/ssh/* during the provisioning process, including ECDSA, DSA, and RSA. The agent generates a single fresh key pair.
198
198
199
199
Configure the encryption type for the fresh key pair by using the `Provisioning.SshHostKeyPairType` entry. Some distributions re-create SSH key pairs for any missing encryption types when the SSH daemon is restarted--for example, after a reboot.
200
200
@@ -205,7 +205,7 @@ Type: String
205
205
Default: rsa
206
206
```
207
207
208
-
This option can be set to an encryption algorithm type that the SSH daemon supports on the VM. The typically supported values are `rsa`, `dsa`, and `ecdsa`. *putty.exe* on Windows doesn't support `ecdsa`. If you intend to use *putty.exe* on Windows to connect to a Linux deployment, use `rsa` or `dsa`.
208
+
You can set this option to an encryption algorithm type that the SSH daemon supports on the VM. The typically supported values are `rsa`, `dsa`, and `ecdsa`. The *putty.exe* file on Windows doesn't support `ecdsa`. If you intend to use *putty.exe* on Windows to connect to a Linux deployment, use `rsa` or `dsa`.
209
209
210
210
### Provisioning.MonitorHostName
211
211
@@ -214,7 +214,7 @@ Type: Boolean
214
214
Default: y
215
215
```
216
216
217
-
If `y`, waagent monitors the Linux VM for a host name change, as returned by the `hostname` command, and automatically updates the networking configuration in the image to reflect the change. In order to push the name change to the DNS servers, networking restarts on the VM. This restart results in brief loss of internet connectivity.
217
+
If the value is `y`, waagent monitors the Linux VM for a host name change, as returned by the `hostname` command, and automatically updates the networking configuration in the image to reflect the change. To push the name change to the DNS servers, networking restarts on the VM. This restart results in brief loss of internet connectivity.
218
218
219
219
### Provisioning.DecodeCustomData
220
220
@@ -223,7 +223,7 @@ Type: Boolean
223
223
Default: n
224
224
```
225
225
226
-
If `y`, waagent decodes `CustomData` from Base64.
226
+
If the value is `y`, waagent decodes `CustomData` from Base64.
227
227
228
228
### Provisioning.ExecuteCustomData
229
229
@@ -232,7 +232,7 @@ Type: Boolean
232
232
Default: n
233
233
```
234
234
235
-
If `y`, waagent runs `CustomData` after provisioning.
235
+
If the value is `y`, waagent runs `CustomData` after provisioning.
236
236
237
237
### Provisioning.AllowResetSysUser
238
238
@@ -241,7 +241,7 @@ Type: Boolean
241
241
Default: n
242
242
```
243
243
244
-
This option allows the password for the system user to be reset. The default is disabled.
244
+
This option allows the password for the system user to be reset. It's disabled by default.
245
245
246
246
### Provisioning.PasswordCryptId
247
247
@@ -250,12 +250,12 @@ Type: String
250
250
Default: 6
251
251
```
252
252
253
-
This option specifies the algorithm used by cryptwhen generating password hash. Valid values are:
253
+
This option specifies the algorithm that `crypt` uses when it's generating a password hash. Valid values are:
254
254
255
-
-1: MD5
256
-
-2a: - Blowfish
257
-
-5: SHA-256
258
-
-6: SHA-512
255
+
-`1`: MD5
256
+
-`2a`: Blowfish
257
+
-`5`: SHA-256
258
+
-`6`: SHA-512
259
259
260
260
### Provisioning.PasswordCryptSaltLength
261
261
@@ -264,7 +264,7 @@ Type: String
264
264
Default: 10
265
265
```
266
266
267
-
This option specifies the length of random salt used when generating password hash.
267
+
This option specifies the length of random salt used in generating a password hash.
268
268
269
269
### ResourceDisk.Format
270
270
@@ -273,7 +273,7 @@ Type: Boolean
273
273
Default: y
274
274
```
275
275
276
-
If `y`, waagent formats and mounts the resource disk provided by the platform, unless the file system type requested by the user in `ResourceDisk.Filesystem` is `ntfs`. The agent makes a single Linux partition (ID 83) available on the disk. This partition isn't formatted if it can be successfully mounted.
276
+
If the value is `y`, waagent formats and mounts the resource disk that the platform provides, unless the file system type that the user requested in `ResourceDisk.Filesystem` is `ntfs`. The agent makes a single Linux partition (ID 83) available on the disk. This partition isn't formatted if it can be successfully mounted.
277
277
278
278
### ResourceDisk.Filesystem
279
279
@@ -291,7 +291,7 @@ Type: String
291
291
Default: /mnt/resource
292
292
```
293
293
294
-
This option specifies the path at which the resource disk is mounted. The resource disk is a *temporary* disk, and might be emptied when the VM is deprovisioned.
294
+
This option specifies the path at which the resource disk is mounted. The resource disk is a *temporary* disk and might be emptied when the VM is deprovisioned.
295
295
296
296
### ResourceDisk.MountOptions
297
297
@@ -300,7 +300,7 @@ Type: String
300
300
Default: None
301
301
```
302
302
303
-
Specifies disk mount options to be passed to the `mount -o` command. This value is a comma-separated list of values, for example, `nodev,nosuid`. For more information, see the mount(8) manual page.
303
+
This option specifies disk mount options to be passed to the `mount -o` command. The value is a comma-separated list of values, for example, `nodev,nosuid`. For more information, see the `mount(8)` manual page.
304
304
305
305
### ResourceDisk.EnableSwap
306
306
@@ -309,7 +309,7 @@ Type: Boolean
309
309
Default: n
310
310
```
311
311
312
-
If set, the agent creates a swap file, */swapfile*, on the resource disk and adds it to the system swap space.
312
+
If you set this option, the agent creates a swap file (*/swapfile*) on the resource disk and adds it to the system swap space.
313
313
314
314
### ResourceDisk.SwapSizeMB
315
315
@@ -318,7 +318,7 @@ Type: Integer
318
318
Default: 0
319
319
```
320
320
321
-
Specifies the size of the swap file in megabytes.
321
+
This option specifies the size of the swap file in megabytes.
322
322
323
323
### Logs.Verbose
324
324
@@ -327,7 +327,7 @@ Type: Boolean
327
327
Default: n
328
328
```
329
329
330
-
If set, log verbosity is boosted. Waagent logs to */var/log/waagent.log* and uses the system `logrotate` functionality to rotate logs.
330
+
If you set this option, log verbosity is boosted. Waagent logs to */var/log/waagent.log* and uses the system `logrotate` functionality to rotate logs.
331
331
332
332
### OS.EnableRDMA
333
333
@@ -336,7 +336,7 @@ Type: Boolean
336
336
Default: n
337
337
```
338
338
339
-
If set, the agent attempts to install and then load an RDMA kernel driver that matches the version of the firmware on the underlying hardware.
339
+
If you set this option, the agent attempts to install and then load an RDMA kernel driver that matches the version of the firmware on the underlying hardware.
340
340
341
341
### OS.RootDeviceScsiTimeout
342
342
@@ -345,7 +345,7 @@ Type: Integer
345
345
Default: 300
346
346
```
347
347
348
-
This setting configures the SCSI timeout in seconds on the OS disk and data drives. If not set, the system defaults are used.
348
+
This option configures the SCSI timeout in seconds on the OS disk and data drives. If it's not set, the system defaults are used.
349
349
350
350
### OS.OpensslPath
351
351
@@ -354,7 +354,7 @@ Type: String
354
354
Default: None
355
355
```
356
356
357
-
This setting can be used to specify an alternate path for the *openssl* binary to use for cryptographic operations.
357
+
You can use this option to specify an alternate path for the *openssl* binary to use for cryptographic operations.
358
358
359
359
### HttpProxy.Host, HttpProxy.Port
360
360
@@ -363,7 +363,7 @@ Type: String
363
363
Default: None
364
364
```
365
365
366
-
If set, the agent uses this proxy server to access the internet.
366
+
If you set this option, the agent uses this proxy server to access the internet.
367
367
368
368
### AutoUpdate.Enabled
369
369
@@ -374,13 +374,13 @@ Default: y
374
374
375
375
Enable or disable autoupdate for goal state processing. The default value is `y`.
376
376
377
-
## Linux guest agent automatic logs collection
377
+
## Automatic log collection in the Azure Linux Guest Agent
378
378
379
-
As of version 2.7+, The Azure Linux guest agent has a feature to automatically collect some logs and upload them. This feature currently requires `systemd`, and uses a new `systemd` slice called `azure-walinuxagent-logcollector.slice` to manage resources while it performs the collection.
379
+
As of version 2.7+, the Azure Linux Guest Agent has a feature to automatically collect some logs and upload them. This feature currently requires `systemd`. It uses a new `systemd` slice called `azure-walinuxagent-logcollector.slice` to manage resources while it performs the collection.
380
380
381
-
The purpose is to facilitate offline analysis. The agent produces a *.zip* file of some diagnostics logs before uploading them to the VM's host. Engineering teams and support professionals can retrieve the file to investigate issues for the VM owner. More technical information on the files collected by the guest agent can be found in the *azurelinuxagent/common/logcollector_manifests.py* file in the [agent's GitHub repository](https://github.com/Azure/WALinuxAgent).
381
+
The purpose is to facilitate offline analysis. The agent produces a *.zip* file of some diagnostics logs before uploading them to the VM's host. Engineering teams and support professionals can retrieve the file to investigate issues for the VM owner. For technical information on the files that the Azure Linux Guest Agent collects, see the *azurelinuxagent/common/logcollector_manifests.py* file in the [agent's GitHub repository](https://github.com/Azure/WALinuxAgent).
382
382
383
-
This option can be disabled by editing */etc/waagent.conf*. Update `Logs.Collect` to `n`.
383
+
You can disable this option by editing */etc/waagent.conf*. Update `Logs.Collect` to `n`.
384
384
385
385
## Ubuntu Cloud Images
386
386
@@ -395,7 +395,7 @@ Ubuntu Cloud Images use [cloud-init](https://launchpad.net/ubuntu/+source/cloud-
395
395
-`ResourceDisk.EnableSwap`
396
396
-`ResourceDisk.SwapSizeMB`
397
397
398
-
- For more information, see the following resources to configure the resource disk mount point and swap space on Ubuntu Cloud Images during provisioning:
398
+
To configure the resource disk mount point and swap space on Ubuntu Cloud Images during provisioning, see the following resources:
0 commit comments