From: Dominik Csapak <d.csapak@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [RFC PATCH guest-common 1/1] add profiles section config plugin
Date: Fri, 3 Nov 2023 12:53:35 +0100 [thread overview]
Message-ID: <20231103115343.4133611-3-d.csapak@proxmox.com> (raw)
In-Reply-To: <20231103115343.4133611-1-d.csapak@proxmox.com>
this is intended to house custom profiles which can be used
on guest creation instead of manually needing to specify every option.
we do special things here:
* we always set 'allow_unknown' to 1, because when using the guest
specific parts in the cli, we cannot depend on the other one, else
we'd get a cyclic dependency, and without that we need to ignore
unknown sections
* we'll prefix the options with the type, so that there is not a
conflict, (e.g. net0 on ct vs net0 on vm has a different format)
but we resolve that transparently on parse and write, so that
the consumer doesn't have to do it themselves
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
src/Makefile | 2 ++
src/PVE/Profiles/Plugin.pm | 72 ++++++++++++++++++++++++++++++++++++++
2 files changed, 74 insertions(+)
create mode 100644 src/PVE/Profiles/Plugin.pm
diff --git a/src/Makefile b/src/Makefile
index cbc40c1..d99645c 100644
--- a/src/Makefile
+++ b/src/Makefile
@@ -17,6 +17,8 @@ install: PVE
install -d ${PERL5DIR}/PVE/Mapping
install -m 0644 PVE/Mapping/PCI.pm ${PERL5DIR}/PVE/Mapping/
install -m 0644 PVE/Mapping/USB.pm ${PERL5DIR}/PVE/Mapping/
+ install -d ${PERL5DIR}/PVE/Profiles
+ install -m 0644 PVE/Profiles/Plugin.pm ${PERL5DIR}/PVE/Profiles/
install -d ${PERL5DIR}/PVE/VZDump
install -m 0644 PVE/VZDump/Plugin.pm ${PERL5DIR}/PVE/VZDump/
install -m 0644 PVE/VZDump/Common.pm ${PERL5DIR}/PVE/VZDump/
diff --git a/src/PVE/Profiles/Plugin.pm b/src/PVE/Profiles/Plugin.pm
new file mode 100644
index 0000000..8ec5054
--- /dev/null
+++ b/src/PVE/Profiles/Plugin.pm
@@ -0,0 +1,72 @@
+package PVE::Profiles::Plugin;
+
+use strict;
+use warnings;
+
+use PVE::Cluster qw(cfs_register_file);
+use PVE::SectionConfig;
+
+use base qw(PVE::SectionConfig);
+
+cfs_register_file ('virtual-guest/profiles.cfg',
+ sub { __PACKAGE__->parse_config(@_); },
+ sub { __PACKAGE__->write_config(@_); });
+
+my $defaultData = {
+ propertyList => {
+ type => { description => 'Profile type.' },
+ id => {
+ type => 'string',
+ description => "The ID of the profile.",
+ format => 'pve-configid',
+ },
+ },
+};
+
+sub private {
+ return $defaultData;
+}
+
+
+# on parse/write we map the configs from {type}_{prop} to {prop}
+# so that the consumers can simply use it but we can
+# have e.g. a ct_net0 and vm_net0
+sub parse_config {
+ my ($class, $filename, $raw, $allow_unknown) = @_;
+
+ # always allow unknown, so that qemu-server/pct-container
+ # can parse the file without loading the other plugin type
+ my $cfg = $class->SUPER::parse_config($filename, $raw, 1);
+ for my $id (keys $cfg->{ids}->%*) {
+ my $entry = $cfg->{ids}->{$id};
+ my $type = $entry->{type};
+ for my $opt (keys $entry->%*) {
+ next if $opt eq 'type';
+ if ($opt =~ m/^${type}_(.*)$/) {
+ my $newopt = $1;
+ $entry->{$newopt} = delete $entry->{$opt};
+ }
+ }
+ }
+
+ return $cfg;
+}
+
+sub write_config {
+ my ($class, $filename, $cfg, $allow_unknown) = @_;
+
+ for my $id (keys $cfg->{ids}->%*) {
+ my $entry = $cfg->{ids}->{$id};
+ my $type = $entry->{type};
+ for my $opt (keys $entry->%*) {
+ next if $opt eq 'type';
+ next if $opt =~ m/^${type}_/; # skip already prefixed options
+ my $newopt = "${type}_${opt}";
+ $entry->{$newopt} = delete $entry->{$opt};
+ }
+ }
+
+ return $class->SUPER::write_config($filename, $cfg, $allow_unknown);
+}
+
+1;
--
2.30.2
next prev parent reply other threads:[~2023-11-03 11:53 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-03 11:53 [pve-devel] [RFC PATCH cluster/guest-common/qemu-server/container/manager] add backend profile support Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH cluster 1/1] add profiles.cfg to cluster fs Dominik Csapak
2023-11-03 11:53 ` Dominik Csapak [this message]
2023-11-06 9:22 ` [pve-devel] [RFC PATCH guest-common 1/1] add profiles section config plugin Fiona Ebner
2023-11-06 9:34 ` Dominik Csapak
2023-11-06 10:12 ` Fiona Ebner
2023-11-06 10:32 ` Fiona Ebner
2023-11-06 10:38 ` Dominik Csapak
2023-11-06 11:38 ` Fiona Ebner
2023-11-03 11:53 ` [pve-devel] [RFC PATCH qemu-server 1/4] meta info: allow additional properties to be given Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH qemu-server 2/4] add the VM profiles plugin Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH qemu-server 3/4] api: add profile option to create vm api call Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH qemu-server 4/4] qm: register and init the profiles plugins Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH container 1/3] add the CT profiles plugin Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH container 2/3] api: add profile option to create ct api call Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH container 3/3] pct: register and init the profiles plugins Dominik Csapak
2023-11-03 11:53 ` [pve-devel] [RFC PATCH manager 1/1] api: add guest profile api endpoint Dominik Csapak
2023-11-04 8:34 ` [pve-devel] [RFC PATCH cluster/guest-common/qemu-server/container/manager] add backend profile support Thomas Lamprecht
2023-11-06 8:17 ` Dominik Csapak
2023-11-06 8:30 ` Dominik Csapak
2023-11-06 8:53 ` Thomas Lamprecht
2023-11-06 9:48 ` Dominik Csapak
2023-11-06 9:21 ` Fiona Ebner
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=20231103115343.4133611-3-d.csapak@proxmox.com \
--to=d.csapak@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