Skip to content

Commit d660e3e

Browse files
authored
Update linux-azure-guest-agent-tools-vmassist.md
Edit review per CI 8141
1 parent a2dd400 commit d660e3e

File tree

1 file changed

+16
-23
lines changed

1 file changed

+16
-23
lines changed

support/azure/virtual-machines/linux/linux-azure-guest-agent-tools-vmassist.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ ms.custom: sap:zzzz
1515

1616
## Overview
1717

18-
The Microsoft Azure Linux VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Linux VM Agent has a primary role in enabling and executing Azure virtual machine extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features such as resetting the administrative password of a VM. Without the Azure Linux VM Agent, you can't run VM extensions.
18+
The Microsoft Azure Linux VM Agent is a secure, lightweight process that manages virtual machine (VM) interaction with the Azure fabric controller. The Azure Linux VM Agent has a primary role in enabling and running Azure VM extensions. VM extensions enable post-deployment configuration of VMs, such as installing and configuring software. VM extensions also enable recovery features, such as resetting the administrative password of a VM. Without the Azure Linux VM Agent, you can't run VM extensions.
1919

2020
## Purpose
21-
The Linux version of VM assist is comprised of bash and Python scripts used to detect potential issues with the Guest Agent in a Linux VM in addition to other issues related to the general health of the VM. Output is intended to be viewed in the serial console and provide pointers to solve well-known issues, as well as certain deviations from best practice which can affect VM availability. The intention is for engineers to provide this script to customers via GitHub, but it is possible and acceptable that a customer uses the script on their own and provides data through an SR.
21+
The Linux version of VM assist is composed of bash and Python scripts that are used to detect potential issues that affect the guest agent in a Linux VM. It also examines other issues that are related to the general health of the VM. Output is intended to be viewed in the serial console. It provides pointers to solve well-known issues and certain deviations from best practice that can affect VM availability. The intention is for engineers to provide this script to customers through GitHub. However, it's possible and acceptable that a customer uses the script on their own and provides data through a service request.
2222

23-
Given that the output of this script is designed to be viewed in a worst-case scenario of the Azure serial console, the information displayed is minimal and condensed, with detail provided through online resources accessed via an link provided in that output - [VM assist for Linux](https://aka.ms/vmassistlinux)
23+
Because the output of this script is designed to be viewed in a worst-case scenario of the Azure serial console, the information that's displayed is minimal and condensed. Details are provided through online resources that are accessed through a link that's provided in the output. See [VM assist for Linux](https://aka.ms/vmassistlinux).
2424

25-
VM assist is delivered in two functional scripts - one in bash and one in python3, and an optional 'downloader' script.
25+
VM assist is delivered in two functional scripts (one in bash and one in python3) plus an optional 'downloader' script.
2626

27-
The bash script will perform some basic checks and determine if running the Python script is possible and/or necessary.
27+
The bash script performs some basic checks and determines whether running the Python script is possible or necessary.
2828

2929
## Key features
3030

@@ -42,39 +42,32 @@ The following checks are run in bash today:
4242
4343
### Python analysis
4444

45-
If there are no issues uncovered during the base checks using bash, the Python script is called to perform a deeper analysis:
45+
If no issues are discovered during the base checks by using bash, the Python script is called to perform a deeper analysis that includes the following tasks:
4646

47-
- Find the source (package) for the Guest Agent executable and the Python passed from bash
48-
- Optionally check any service or package statuses, which is currently a proof-of-concept inside the script
47+
- Find the source (package) for the guest agent executable and the Python passed from bash
48+
- Optionally check any service or package statuses (this is currently a proof-of-concept inside the script)
4949
- Only SSH is checked for the PoC
5050
- Provide source information for all checked files and services
5151
- Do configuration checks for the Guest Agent
52-
- Connectivity checks for requirements of the Guest Agent
52+
- Connectivity checks for requirements of the guest agent
5353
- Basic system configuration and status checks (#Guest best practices)
5454

55-
5655
## Prerequisites
5756

58-
- VM needs to be booting to the full OS, i.e. not emergency or maintenance mode.
59-
- root-level access either through sudo or direct login/sudo -i
57+
- The VM must start to the full OS (not emergency or maintenance mode).
58+
- Root-level access must be available through either sudo or direct login/sudo -i
6059

6160
## How to run the tool
6261

63-
The VM assist scripting is run initially from the above documentation. Subsequent runs can be done by running the bash script directly - `vmassist.sh` as root or using `sudo`.
62+
The VM assist scripting is run initially from the documentation. Subsequently, you can run the bash script directly: `vmassist.sh` as root or by using `sudo`.
6463

65-
If you open a support request, please include both of the above files to aid your support representative in helping you.
64+
If you open a support request, please include both of these files to aid the support agent who assists you.
6665

6766
## Known issues
68-
- Do not attempt to run VM assist on appliances - these are not general purpose operating systems, and the Guest Agent may not run at all.
69-
- Distributions outside of PAYG versions of RedHat or SUSE, or any Ubuntu or Mariner/Azure Linux may display false positive warnings about repository names. This will require a more careful reading as the repositories may be official but do not match strict pattern matching as we do not build cases for all distributions.
70-
- Ubuntu 24.04 has a differing architecture of the SSH service, and may flag the service even though it is operating fine.
71-
67+
- Don't try to run VM assist on appliances. Appliances don't run on general purpose operating systems, and the guest agent might not run at all.
68+
- Distributions outside PAYG versions of RedHat or SUSE, or any Ubuntu or Mariner or Azure Linux, might display false positive warnings about repository names. This situation requires a more careful reading because even official repositories might not match strict pattern matching. This condition is true because we don't build cases for all distributions.
69+
- Ubuntu 24.04 has a different architecture of the SSH service. It might flag the service even if the service is operating well.
7270

7371
[!INCLUDE [azure-help-support](~/includes/azure-help-support.md)]
7472

7573
[!INCLUDE [Third-party contact disclaimer](~/includes/third-party-contact-disclaimer.md)]
76-
77-
78-
79-
80-

0 commit comments

Comments
 (0)