From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v2 pve-docs 2/3] Add hookscript section to container documentation
Date: Thu, 6 Oct 2022 14:44:44 +0200 [thread overview]
Message-ID: <20221006124447.120701-6-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20221006124447.120701-1-s.hanreich@proxmox.com>
Since it has been missing so far, I extended the documentation to
contain information about container hookscripts. I added some additional
notes for how to use the pre/post-migrate scripts properly.
Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
pct.adoc | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/pct.adoc b/pct.adoc
index ebae3e9..57f2206 100644
--- a/pct.adoc
+++ b/pct.adoc
@@ -1260,3 +1260,26 @@ Configuration file for the container '<CTID>'.
include::pve-copyright.adoc[]
endif::manvolnum[]
+
+Hookscripts
+-----------
+
+You can add a hook script to CTs with the config property `hookscript`.
+
+----
+# pct set 100 --hookscript local:snippets/hookscript.pl
+----
+
+It will be called during various phases of the guests lifetime.
+For an example and documentation see the example script under
+`/usr/share/pve-docs/examples/guest-example-hookscript.pl`.
+
+pre/post-migrate
+~~~~~~~~~~~~~~~~
+Those hooks run before/after a CT migrates from one host to another. This
+hook is a bit special, since it gets executed on the source node as well as the
+target node. In order for this hookscript to function properly, the configured
+script file needs to be available on both nodes. If it is a local script, this
+means storing it on both server under the same path. The preferred option
+would be storing the hookscript on a shared storage, so it is accessible from
+both nodes.
--
2.30.2
next prev parent reply other threads:[~2022-10-06 12:45 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-06 12:44 [pve-devel] [PATCH v2 pve-container/qemu-server/pve-docs/pve-guest-common 0/8] Add pre/post-migrate hooks Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 pve-guest-common 1/1] Add run_params to exec_hookscript function Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 pve-container 1/2] add pct mtunnel command to the CLI Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 pve-container 2/2] add migration hooks to container migration process Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 pve-docs 1/3] Add pre/post-migrate events to hookscript example Stefan Hanreich
2022-10-06 12:44 ` Stefan Hanreich [this message]
2022-10-06 12:44 ` [pve-devel] [PATCH v2 pve-docs 3/3] Add pre/post-migrate section to VM hookscript documentation Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 qemu-server 1/2] add migrate-hook and query-migrate-hook commands to CLI Stefan Hanreich
2022-10-06 12:44 ` [pve-devel] [PATCH v2 qemu-server 2/2] add migration hooks to VM migration process Stefan Hanreich
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=20221006124447.120701-6-s.hanreich@proxmox.com \
--to=s.hanreich@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox