From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <d.whyte@proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 7456E61565 for <pve-devel@lists.proxmox.com>; Thu, 17 Dec 2020 10:57:30 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 62969242E1 for <pve-devel@lists.proxmox.com>; Thu, 17 Dec 2020 10:57:00 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id A1832242D2 for <pve-devel@lists.proxmox.com>; Thu, 17 Dec 2020 10:56:58 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 69E354525C for <pve-devel@lists.proxmox.com>; Thu, 17 Dec 2020 10:56:58 +0100 (CET) To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>, Aaron Lauterer <a.lauterer@proxmox.com> References: <20201216143834.21446-1-a.lauterer@proxmox.com> From: Dylan Whyte <d.whyte@proxmox.com> Message-ID: <542274d0-f28f-8bf6-69f1-08d99c6d030a@proxmox.com> Date: Thu, 17 Dec 2020 10:56:56 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.5.1 MIME-Version: 1.0 In-Reply-To: <20201216143834.21446-1-a.lauterer@proxmox.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US X-SPAM-LEVEL: Spam detection results: 0 AWL 0.021 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment NICE_REPLY_A -0.001 Looks like a legit reply (A) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [proxmox.com, fedorapeople.org] Subject: Re: [pve-devel] [PATCH docs] qm: add guest agent section X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/> List-Post: <mailto:pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> X-List-Received-Date: Thu, 17 Dec 2020 09:57:30 -0000 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 > ~~~~~~~~~~~~~~~~~~