Skip to content

Commit ac3586d

Browse files
Minor edits.
1 parent 53877dc commit ac3586d

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

articles/virtual-machines/extensions/agent-linux.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ ms.date: 03/28/2023
1515

1616
The Microsoft Azure Linux Agent (waagent) manages Linux and FreeBSD provisioning, and virtual machine interaction with the Azure Fabric controller. In addition to the Linux agent providing provisioning functionality, Azure also provides the option of using `cloud-init` for some Linux operating systems.
1717

18-
The Linux agent provides the following functionality for Linux and FreeBSD Azure Virtual Machines deployments:
19-
20-
> [!NOTE]
21-
> For more information, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent/blob/master/README.md).
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).
2219

2320
- Image provisioning
2421

@@ -60,7 +57,7 @@ The Linux agent provides the following functionality for Linux and FreeBSD Azure
6057

6158
The information flow from the platform to the agent occurs by using two channels:
6259

63-
- A boot-time attached DVD for Virtual Machines deployments. This DVD includes an Open Virtualization Format (OVF)-compliant configuration file that includes all provisioning information other than the SSH key pairs.
60+
- A boot-time attached DVD for virtual machines deployments. This DVD includes an Open Virtualization Format (OVF)-compliant configuration file that includes all provisioning information other than the SSH key pairs.
6461
- A TCP endpoint exposing a REST API used to obtain deployment and topology configuration.
6562

6663
## Requirements
@@ -100,7 +97,7 @@ Ensure your virtual machine has access to IP address 168.63.129.16. For more inf
10097

10198
## Installation
10299

103-
The preferred method of installing and upgrading the Azure Linux agent uses an RPM or a DEB package from your distribution's package repository. All the [endorsed distribution providers](../linux/endorsed-distros.md) integrate the Azure Linux agent package into their images and repositories.
100+
The preferred method of installing and upgrading the Azure Linux Agent uses an RPM or a DEB package from your distribution's package repository. All the [endorsed distribution providers](../linux/endorsed-distros.md) integrate the Azure Linux agent package into their images and repositories.
104101

105102
For advanced installation options, such as installing from source or to custom locations or prefixes, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent).
106103

@@ -121,8 +118,8 @@ For advanced installation options, such as installing from source or to custom l
121118
- Cached DHCP client leases
122119
- Resets host name to `localhost.localdomain`
123120

124-
> [!WARNING]
125-
> Deprovisioning doesn't guarantee that the image is cleared of all sensitive information and suitable for redistribution.
121+
> [!WARNING]
122+
> Deprovisioning doesn't guarantee that the image is cleared of all sensitive information and suitable for redistribution.
126123
127124
- `deprovision+user`: Performs everything in `deprovision` (previous) and also deletes the last provisioned user account, obtained from */var/lib/waagent*, and associated data. Use this parameter when you deprovision an image that was previously provisioned on Azure so that it can be captured and reused.
128125
- `version`: Displays the version of waagent.
@@ -169,7 +166,7 @@ Type: Boolean
169166
Default: y
170167
```
171168

172-
This option allows the user to enable or disable the provisioning functionality in the agent. Valid values are `y` or `n`. If provisioning is disabled, SSH host and user keys in the image are preserved and configuration in the Azure provisioning API is ignored.
169+
This option allows the user to enable or disable the provisioning functionality in the agent. Valid values are `y` and `n`. If provisioning is disabled, SSH host and user keys in the image are preserved and configuration in the Azure provisioning API is ignored.
173170

174171
> [!NOTE]
175172
> The `Provisioning.Enabled` parameter defaults to `n` on Ubuntu Cloud Images that use cloud-init for provisioning.
@@ -181,7 +178,7 @@ Type: Boolean
181178
Default: n
182179
```
183180

184-
If set, the agent erases the root password in the */etc/shadow* file during the provisioning process.
181+
If `y`, the agent erases the root password in the */etc/shadow* file during the provisioning process.
185182

186183
### Provisioning.RegenerateSshHostKeyPair
187184

@@ -190,7 +187,7 @@ Type: Boolean
190187
Default: y
191188
```
192189

193-
If set, 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.
190+
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.
194191

195192
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, upon a reboot.
196193

@@ -210,7 +207,7 @@ Type: Boolean
210207
Default: y
211208
```
212209

213-
If set, waagent monitors the Linux virtual machine 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 virtual machine. This restart results in brief loss of internet connectivity.
210+
If `y`, waagent monitors the Linux virtual machine 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 virtual machine. This restart results in brief loss of internet connectivity.
214211

215212
### Provisioning.DecodeCustomData
216213

@@ -219,7 +216,7 @@ Type: Boolean
219216
Default: n
220217
```
221218

222-
If set, waagent decodes `CustomData` from Base64.
219+
If `y`, waagent decodes `CustomData` from Base64.
223220

224221
### Provisioning.ExecuteCustomData
225222

@@ -228,7 +225,7 @@ Type: Boolean
228225
Default: n
229226
```
230227

231-
If set, waagent runs `CustomData` after provisioning.
228+
If `y`, waagent runs `CustomData` after provisioning.
232229

233230
### Provisioning.AllowResetSysUser
234231

@@ -248,10 +245,10 @@ Default: 6
248245

249246
This option specifies the algorithm used by crypt when generating password hash. Valid values are:
250247

251-
- 1 - MD5
252-
- 2a - Blowfish
253-
- 5 - SHA-256
254-
- 6 - SHA-512
248+
- 1: MD5
249+
- 2a: - Blowfish
250+
- 5: SHA-256
251+
- 6: SHA-512
255252

256253
### Provisioning.PasswordCryptSaltLength
257254

@@ -269,7 +266,7 @@ Type: Boolean
269266
Default: y
270267
```
271268

272-
If set, 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.
269+
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.
273270

274271
### ResourceDisk.Filesystem
275272

@@ -368,13 +365,13 @@ Type: Boolean
368365
Default: y
369366
```
370367

371-
Enable or disable autoupdate for goal state processing. The default value is enabled.
368+
Enable or disable autoupdate for goal state processing. The default value is `y`.
372369

373370
## Linux guest agent automatic logs collection
374371

375372
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.
376373

377-
The purpose is to facilitate offline analysis. It 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 virtual machine 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).
374+
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 virtual machine 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).
378375

379376
This option can be disabled by editing */etc/waagent.conf*. Update `Logs.Collect` to `n`.
380377

0 commit comments

Comments
 (0)