Skip to content

Commit f13bb99

Browse files
committed
edit pass: virtual-machines-extensions
1 parent b98d2a6 commit f13bb99

File tree

2 files changed

+86
-83
lines changed

2 files changed

+86
-83
lines changed

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

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Azure Linux VM Agent overview
3-
description: Learn how to install and configure Azure Linux Agent (waagent) to manage your virtual machine's interaction with the Azure Fabric controller.
2+
title: Azure Linux Agent overview
3+
description: Learn how to install and configure the Azure Linux Agent (waagent) to manage your virtual machine's interaction with the Azure fabric controller.
44
ms.topic: article
55
ms.service: virtual-machines
66
ms.subservice: extensions
@@ -11,10 +11,9 @@ ms.collection: linux
1111
ms.date: 03/28/2023
1212

1313
---
14-
# Understanding and using the Azure Linux Agent
15-
16-
The Microsoft Azure Linux Agent (waagent) manages Linux and FreeBSD provisioning, and virtual machine (VM) 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.
14+
# Azure Linux Agent overview
1715

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.
1817

1918
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).
2019

@@ -25,8 +24,8 @@ The Linux agent provides the following functionality for Linux and FreeBSD Azure
2524
- Deploys SSH public keys and key pairs
2625
- Sets the host name
2726
- Publishes the host name to the platform DNS
28-
- Reports SSH host key fingerprint to the platform
29-
- Manages resource disk
27+
- Reports SSH host key fingerprints to the platform
28+
- Manages the resource disk
3029
- Formats and mounts the resource disk
3130
- Configures swap space
3231

@@ -37,29 +36,30 @@ The Linux agent provides the following functionality for Linux and FreeBSD Azure
3736

3837
### Kernel
3938

40-
- Configures virtual NUMA (disable for kernel <`2.6.37`)
39+
- Configures virtual NUMA (disable for kernel `2.6.37`)
4140
- Consumes Hyper-V entropy for */dev/random*
4241
- Configures SCSI timeouts for the root device, which can be remote
4342

4443
### Diagnostics
4544

46-
- Console redirection to the serial port
45+
- Provides console redirection to the serial port
4746

4847
### System Center Virtual Machine Manager deployments
4948

50-
- Detects and bootstraps the Virtual Machine Manager agent for Linux when running in a System Center Virtual Machine Manager 2012 R2 environment
49+
- Detects and bootstraps the Virtual Machine Manager agent for Linux when it's running in a System Center Virtual Machine Manager 2012 R2 environment
5150

5251
### VM Extension
5352

54-
- Injects component authored by Microsoft and partners into Linux VMs to enable software and configuration automation
55-
- VM Extension reference implementation on [https://github.com/Azure/azure-linux-extensions](https://github.com/Azure/azure-linux-extensions)
53+
- Injects components authored by Microsoft and partners into Linux VMs to enable software and configuration automation
54+
55+
You can find a VM Extension reference implementation on [GitHub](https://github.com/Azure/azure-linux-extensions).
5656

5757
## Communication
5858

59-
The information flow from the platform to the agent occurs by using two channels:
59+
The information flow from the platform to the agent occurs through two channels:
6060

6161
- 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.
62-
- A TCP endpoint exposing a REST API used to obtain deployment and topology configuration.
62+
- A TCP endpoint that exposes a REST API that's used to get deployment and topology configuration.
6363

6464
## Requirements
6565

@@ -74,8 +74,8 @@ The following systems have been tested and are known to work with the Azure Linu
7474
| CentOS | 7.x+, 8.x+ | 7.x+ |
7575
| Debian | 10+ | 11.x+ |
7676
| Flatcar Linux | 3374.2.x+ | 3374.2.x+ |
77-
| openSUSE | 12.3+ | **Not Supported** |
78-
| Oracle Linux | 6.4+, 7.x+, 8.x+ | **Not Supported** |
77+
| openSUSE | 12.3+ | *Not supported* |
78+
| Oracle Linux | 6.4+, 7.x+, 8.x+ | *Not supported* |
7979
| Red Hat Enterprise Linux | 6.7+, 7.x+, 8.x+ | 8.6+, 9.0+ |
8080
| Rocky Linux | 9.x+ | 9.x+ |
8181
| SLES | 12.x+, 15.x+ | 15.x SP4+ |
@@ -84,11 +84,11 @@ The following systems have been tested and are known to work with the Azure Linu
8484
> [!IMPORTANT]
8585
> 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).
8686
87-
Other Supported Systems:
87+
Other supported systems:
8888

8989
- FreeBSD 10+ (Azure Linux Agent v2.0.10+)
9090

91-
The Linux agent depends on some system packages in order to function properly:
91+
The Linux agent depends on some system packages to function properly:
9292

9393
- Python 2.6+
9494
- OpenSSL 1.0+
@@ -97,45 +97,46 @@ The Linux agent depends on some system packages in order to function properly:
9797
- Password tools: chpasswd, sudo
9898
- Text processing tools: sed, grep
9999
- Network tools: ip-route
100-
- Kernel support for mounting UDF file systems.
100+
- Kernel support for mounting UDF file systems
101101

102-
Ensure your VM has access to IP address 168.63.129.16. For more information, see [What is IP address 168.63.129.16](../../virtual-network/what-is-ip-address-168-63-129-16.md).
102+
Ensure that your VM has access to IP address 168.63.129.16. For more information, see [What is IP address 168.63.129.16?](../../virtual-network/what-is-ip-address-168-63-129-16.md).
103103

104104
## Installation
105105

106-
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.
106+
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.
107107

108-
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).
108+
For advanced installation options, such as installing from a source or to custom locations or prefixes, see [Microsoft Azure Linux Agent](https://github.com/Azure/WALinuxAgent).
109109

110110
## Command-line options
111111

112112
### Flags
113113

114-
- `verbose`: Increase verbosity of specified command
115-
- `force`: Skip interactive confirmation for some commands
114+
- `verbose`: Increases verbosity of the specified command.
115+
- `force`: Skips interactive confirmation for some commands.
116116

117117
### Commands
118118

119-
- `help`: Lists the supported commands and flags
120-
- `deprovision`: Attempt to clean the system and make it suitable for reprovisioning. The operation deletes:
121-
- All SSH host keys, if `Provisioning.RegenerateSshHostKeyPair` is `y` in the configuration file
122-
- Nameserver configuration in */etc/resolv.conf*
123-
- Root password from */etc/shadow*, if `Provisioning.DeleteRootPassword` is `y` in the configuration file
124-
- Cached DHCP client leases
125-
- Resets host name to `localhost.localdomain`
119+
- `help`: Lists the supported commands and flags.
120+
- `deprovision`: Attempts to clean the system and make it suitable for reprovisioning. The operation deletes:
121+
- All SSH host keys, if `Provisioning.RegenerateSshHostKeyPair` is `y` in the configuration file.
122+
- `Nameserver` configuration in */etc/resolv.conf*.
123+
- The root password from */etc/shadow*, if `Provisioning.DeleteRootPassword` is `y` in the configuration file.
124+
- Cached DHCP client leases.
125+
126+
The client resets the host name to `localhost.localdomain`.
126127

127128
> [!WARNING]
128129
> Deprovisioning doesn't guarantee that the image is cleared of all sensitive information and suitable for redistribution.
129130
130-
- `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.
131+
- `deprovision+user`: Performs everything in `deprovision` (previous) and 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.
131132
- `version`: Displays the version of waagent.
132133
- `serialconsole`: Configures GRUB to mark ttyS0, the first serial port, as the boot console. This option ensures that kernel boot logs are sent to the serial port and made available for debugging.
133-
- `daemon`: Run waagent as a daemon to manage interaction with the platform. This argument is specified to waagent in the waagent *init* script.
134-
- `start`: Run waagent as a background process.
134+
- `daemon`: Runs waagent as a daemon to manage interaction with the platform. This argument is specified to waagent in the waagent *init* script.
135+
- `start`: Runs waagent as a background process.
135136

136137
## Configuration
137138

138-
The */etc/waagent.conf* configuration file controls the actions of waagent. This example is a sample configuration file:
139+
The */etc/waagent.conf* configuration file controls the actions of waagent. Here's an example of a configuration file:
139140

140141
```config
141142
Provisioning.Enabled=y
@@ -195,7 +196,7 @@ Default: y
195196

196197
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.
197198

198-
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.
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.
199200

200201
### Provisioning.SshHostKeyPairType
201202

0 commit comments

Comments
 (0)