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 add the 'profile-description' to the options of all registered plugins (so we don't have to do it manually) * we always call 'init(property_isolation => 1)' of the SectionConfig so we cannot forget that Signed-off-by: Dominik Csapak <d.csa...@proxmox.com> --- src/Makefile | 2 + src/PVE/Profiles/Plugin.pm | 83 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 85 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..717383b --- /dev/null +++ b/src/PVE/Profiles/Plugin.pm @@ -0,0 +1,83 @@ +package PVE::Profiles::Plugin; + +use strict; +use warnings; + +use PVE::Cluster qw(cfs_register_file); +use PVE::SectionConfig; + +use base qw(PVE::SectionConfig); + +my $CFG_PATH = 'virtual-guest/profiles.cfg'; + +cfs_register_file( + $CFG_PATH, + 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', + }, + 'profile-description' => { + description => "Use this to add a short comment about a profile.", + type => 'string', + optional => 1, + maxLength => 128, + }, + }, +}; + +sub private { + return $defaultData; +} + +sub parse_config { + my ($class, $filename, $raw, $allow_unknown) = @_; + + # always allow unknown section types, so that qemu-server/pct-container + # can parse the file without loading the other plugin type + return $class->SUPER::parse_config($filename, $raw, 1); +} + +sub write_config { + my ($class, $filename, $cfg, $allow_unknown) = @_; + + return $class->SUPER::write_config($filename, $cfg, 1); +} + +# gets, checks and prepares the guest config +# throws an error if it does not exist or the type is wrong +sub load_profile { + my ($profile_id, $profile_type) = @_; + + my $cfg = PVE::Cluster::cfs_read_file($CFG_PATH); + + my $profile = $cfg->{ids}->{$profile_id}; + die "no such profile '$profile_id'\n" if !defined $profile; + die "wrong type '$profile->{type}'\n" if $profile->{type} ne $profile_type; + + delete $profile->{type}; + delete $profile->{'profile-description'}; + + return $profile; +} + +# override so we can add the profile description to all sub classes +sub init { + my ($class) = @_; + + $class->SUPER::init(property_isolation => 1); + + my $pdata = $class->private(); + for my $type (keys $pdata->{plugins}->%*) { + $pdata->{options}->{$type}->{'profile-description'} = { optional => 1 }; + } +} + +1; -- 2.30.2 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel