all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Dylan Whyte <d.whyte@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
	Aaron Lauterer <a.lauterer@proxmox.com>
Subject: Re: [pve-devel] [PATCH docs] qm: add guest agent section
Date: Thu, 17 Dec 2020 10:56:56 +0100	[thread overview]
Message-ID: <542274d0-f28f-8bf6-69f1-08d99c6d030a@proxmox.com> (raw)
In-Reply-To: <20201216143834.21446-1-a.lauterer@proxmox.com>

Hi,

Just a few language corrections. I have no problem with the content :)

Dylan

On 12/16/20 3:38 PM, Aaron Lauterer wrote:
> Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
> ---
>
> Additionally to the previous series [0] which changes the phrasing, it
> would be nice to have a dedicated Qemu Guest Agent section in the docs.
>
> This is a first draft. If there is something missing or could be phrased
> / structured in a better way, let me know :)
>
>
> [0] https://lists.proxmox.com/pipermail/pve-devel/2020-December/046502.html
>   qm.adoc | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 52 insertions(+)
>
> diff --git a/qm.adoc b/qm.adoc
> index 5e53e4a..9c121f1 100644
> --- a/qm.adoc
> +++ b/qm.adoc
> @@ -917,6 +917,58 @@ start after those where the parameter is set. Further, this parameter can only
>   be enforced between virtual machines running on the same host, not
>   cluster-wide.
>   
> +
> +[[qm_qemu_agent]]
> +Qemu Guest Agent
> +~~~~~~~~~~~~~~~~
> +
> +The Qemu Guest Agent is a service which is running inside the VM, providing a
s/which is running/which runs/
> +communication channel between the host and the guest. It is used to exchange
> +information and allows the host to issue commands to the guest.
> +
> +For example, the IP addresses in the VM summary panel are fetched via the guest
> +agent. When starting a backup, the guest is told via the guest agent to sync
> +outstanding writes via the 'fs-freeze' and 'fs-thaw' commands. It is possible
> +to add custom hook scripts to react to these commands and tell software like a
I would say "software such as" or "software, for example, ", but that's 
more personal preference.
> +database server to write current data to disk so it is included in the backup.
s/disk so it is/disk, so that it is/
> +
> +Install Guest Agent
> +^^^^^^^^^^^^^^^^^^^
> +
> +For most Linux distributions the guest agent is available. The package is
s/distributions the guest/distributions, the guest/
> +usually named `qemu-guest-agent`.
> +
> +For Windows, it can be installed from the
> +https://fedorapeople.org/groups/virt/virtio-win/direct-downloads/stable-virtio/virtio-win.iso[Fedora
> +VirtIO driver ISO].
> +
> +Enable Guest Agent
> +^^^^^^^^^^^^^^^^^^
> +
> +The guest agent can be enabled in the VMs *Options* panel.
s/in the VMs/from the VM's/
> +A fresh start of the VM is necessary for the changes to take effect.
> +
> +It is possible to enable the 'Run guest-trim'. With this option enabled,
s/enable the 'Run/enable 'Run/ (not 100% sure about this)
> +Proxmox VE will issue a trim command to the guest after the following
> +operations that have the potential to write out zeros to the storage:
> +
> +* moving a disk to another storage
> +* live migrating a VM to another node with local storage
> +
> +On a thin provisioned storages this can help to free up unused space.
s/On a thin provisioned storages this/On thin provisioned storage, this/
> +
> +Troubleshooting
> +^^^^^^^^^^^^^^^
> +
> +.VM does not shut down
> +
> +Make sure the guest agent is installed and running.
> +
> +Once the guest agent is enabled, Proxmox VE will send power commands like
> +'shutdown' via the guest agent.  These commands will be ignored if the guest
> +agent in the VM is not running.
> +
> +
>   [[qm_spice_enhancements]]
>   SPICE Enhancements
>   ~~~~~~~~~~~~~~~~~~




      parent reply	other threads:[~2020-12-17  9:57 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-16 14:38 Aaron Lauterer
2020-12-16 14:38 ` [pve-devel] [PATCH manager] gui: add help button to qm guest agent window Aaron Lauterer
2020-12-17  9:56 ` Dylan Whyte [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=542274d0-f28f-8bf6-69f1-08d99c6d030a@proxmox.com \
    --to=d.whyte@proxmox.com \
    --cc=a.lauterer@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal