From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <s.hanreich@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))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 5F00F96250
 for <pve-devel@lists.proxmox.com>; Mon, 23 Jan 2023 17:08:05 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id 296DC2A1D0
 for <pve-devel@lists.proxmox.com>; Mon, 23 Jan 2023 17:07:35 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS
 for <pve-devel@lists.proxmox.com>; Mon, 23 Jan 2023 17:07:33 +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 6E29044086
 for <pve-devel@lists.proxmox.com>; Mon, 23 Jan 2023 17:07:33 +0100 (CET)
Message-ID: <0256b6e0-d641-fbe8-c12e-df5a9c95e89e@proxmox.com>
Date: Mon, 23 Jan 2023 17:07:32 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.6.0
Content-Language: en-US
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
References: <20230123155847.598536-1-s.hanreich@proxmox.com>
From: Stefan Hanreich <s.hanreich@proxmox.com>
In-Reply-To: <20230123155847.598536-1-s.hanreich@proxmox.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL 1.049 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 NICE_REPLY_A           -1.149 Looks like a legit reply (A)
 RCVD_IN_DNSWL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to DNSWL was
 blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block
 for more information.
 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. [guest-example-hookscript.pl, abstractconfig.pm]
Subject: Re: [pve-devel] [PATCH-SERIES guest-common/docs v3] add
 pre/post/failed snapshot hooks
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: Mon, 23 Jan 2023 16:08:05 -0000



On 1/23/23 16:58, Stefan Hanreich wrote:
> This patch series introduces the pre/post/failed-snapshot hooks that run before/
> after a snapshot is taken, or after failing to take a snapshot.
> 
> I used the new example script from pve-docs as template for my test hookscripts.
> 
> What I tested:
> * Normal snapshotting, without VM state, without hookscript
>    * snapshot works, no hooks executed
> * Normal snapshotting, with VM state, without hookscript
>    * snapshot works, no hooks executed
> * Normal snapshotting, without VM state, with hookscript
>    * snapshot works, pre/post hooks work
> * Normal snapshotting, with VM state, with hookscript
>    * snapshot works, pre/post hooks work
> * Taking snapshot with existing name, with hookscript
>    * fails, no hookscripts get executed
> * Failed at wrong storage config, with hookscript
>    * pre/failed get executed, lock gets released
> * Failed at taking RAM Snapshot (simulated with monkey-patched die), with hookscript
>    * pre/failed get executed, lock gets released
> * pre/post hookscript that detaches/attaches unsnapshottable disk (without --skiplock)
>    * snapshotting fails, attach/detach fails, pre/failed get executed, lock released
> * pre/post hookscript that detaches/attaches unsnapshottable disk (with --skiplock)
>    * snapshotting works, attach/detach works, pre/post get executed
>    * restoring works, detached disk is detached after restoring
> * pre-snapshot hookscript exits with code > 0
>    * pre/failed-snapshot get executed, snapshot fails, lock gets released
> * post-snapshot hookscript exits with code > 0
>    * pre/post/failed-snapshot get executed, snapshot fails, lock gets released
> * Taking snapshot of template
>    * fails, no hookscripts get executed
> * execute commands in VM in pre/post via qm guest exec
>    * snapshot succeeds, commands get executed, pre/post executed
> 
> Changes from v2 (thanks fabian!):
> * added guards, so cfs_update() only gets called when necessary
> * added PVE_SNAPSHOT_PHASE envvar to failed-snapshot as indicator
>    when the failure occured
> 
> Changes from v1:
> * added failed-snapshot hook that runs after a failed snapshot
>    * this enables users to revert any changes made in pre-snapshot hooks
>    in case of errors
> * running cfs_update() after every hookscript invocation
> * adjusted the call sites of exec_hookscript()
>    * particularly interesting for pre-snapshot since some checks now run
>    before the hook runs
> * VM/CT config is now locked during hookscript execution
> 
> Thanks to Fiona and Fabian for their valuable input/help!
> 
> pve-guest-common:
> 

flipped this heading with pve-docs

> Stefan Hanreich (1):
>    examples: add pre/post/failed-snapshot hooks to example hookscript
> 
>   examples/guest-example-hookscript.pl | 26 ++++++++++++++++++++++++++
>   1 file changed, 26 insertions(+)
> 
> 
> pve-docs:

^ see above

> 
> Stefan Hanreich (1):
>    partial fix #2530: snapshots: add pre/post/failed-snapshot hooks
> 
>   src/PVE/AbstractConfig.pm | 76 +++++++++++++++++++++++++++++++++++----
>   1 file changed, 70 insertions(+), 6 deletions(-)
>