From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 2817C999E7 for ; Tue, 14 Nov 2023 13:41:39 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 07B281F881 for ; Tue, 14 Nov 2023 13:41:09 +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 ; Tue, 14 Nov 2023 13:41:07 +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 B392F42919 for ; Tue, 14 Nov 2023 13:41:07 +0100 (CET) Message-ID: Date: Tue, 14 Nov 2023 13:41:06 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Beta Content-Language: en-GB, de-AT To: Proxmox VE development discussion , Dominik Csapak References: <20231114103545.2878054-1-d.csapak@proxmox.com> <20231114103545.2878054-3-d.csapak@proxmox.com> From: Thomas Lamprecht Autocrypt: addr=t.lamprecht@proxmox.com; keydata= xsFNBFsLjcYBEACsaQP6uTtw/xHTUCKF4VD4/Wfg7gGn47+OfCKJQAD+Oyb3HSBkjclopC5J uXsB1vVOfqVYE6PO8FlD2L5nxgT3SWkc6Ka634G/yGDU3ZC3C/7NcDVKhSBI5E0ww4Qj8s9w OQRloemb5LOBkJNEUshkWRTHHOmk6QqFB/qBPW2COpAx6oyxVUvBCgm/1S0dAZ9gfkvpqFSD 90B5j3bL6i9FIv3YGUCgz6Ue3f7u+HsEAew6TMtlt90XV3vT4M2IOuECG/pXwTy7NtmHaBQ7 UJBcwSOpDEweNob50+9B4KbnVn1ydx+K6UnEcGDvUWBkREccvuExvupYYYQ5dIhRFf3fkS4+ wMlyAFh8PQUgauod+vqs45FJaSgTqIALSBsEHKEs6IoTXtnnpbhu3p6XBin4hunwoBFiyYt6 YHLAM1yLfCyX510DFzX/Ze2hLqatqzY5Wa7NIXqYYelz7tXiuCLHP84+sV6JtEkeSUCuOiUY virj6nT/nJK8m0BzdR6FgGtNxp7RVXFRz/+mwijJVLpFsyG1i0Hmv2zTn3h2nyGK/I6yhFNt dX69y5hbo6LAsRjLUvZeHXpTU4TrpN/WiCjJblbj5um5eEr4yhcwhVmG102puTtuCECsDucZ jpKpUqzXlpLbzG/dp9dXFH3MivvfuaHrg3MtjXY1i+/Oxyp5iwARAQABzTNUaG9tYXMgTGFt cHJlY2h0IChBdXRoLTQpIDx0LmxhbXByZWNodEBwcm94bW94LmNvbT7CwY4EEwEIADgWIQQO R4qbEl/pah9K6VrTZCM6gDZWBgUCWwuNxgIbAwULCQgHAgYVCAkKCwIEFgIDAQIeAQIXgAAK CRDTZCM6gDZWBm/jD/4+6JB2s67eaqoP6x9VGaXNGJPCscwzLuxDTCG90G9FYu29VcXtubH/ bPwsyBbNUQpqTm/s4XboU2qpS5ykCuTjqavrcP33tdkYfGcItj2xMipJ1i3TWvpikQVsX42R G64wovLs/dvpTYphRZkg5DwhgTmy3mRkmofFCTa+//MOcNOORltemp984tWjpR3bUJETNWpF sKGZHa3N4kCNxb7A+VMsJZ/1gN3jbQbQG7GkJtnHlWkw9rKCYqBtWrnrHa4UAvSa9M/XCIAB FThFGqZI1ojdVlv5gd6b/nWxfOPrLlSxbUo5FZ1i/ycj7/24nznW1V4ykG9iUld4uYUY86bB UGSjew1KYp9FmvKiwEoB+zxNnuEQfS7/Bj1X9nxizgweiHIyFsRqgogTvLh403QMSGNSoArk tqkorf1U+VhEncIn4H3KksJF0njZKfilrieOO7Vuot1xKr9QnYrZzJ7m7ZxJ/JfKGaRHXkE1 feMmrvZD1AtdUATZkoeQtTOpMu4r6IQRfSdwm/CkppZXfDe50DJxAMDWwfK2rr2bVkNg/yZI tKLBS0YgRTIynkvv0h8d9dIjiicw3RMeYXyqOnSWVva2r+tl+JBaenr8YTQw0zARrhC0mttu cIZGnVEvQuDwib57QLqMjQaC1gazKHvhA15H5MNxUhwm229UmdH3KM7BTQRbC43GARAAyTkR D6KRJ9Xa2fVMh+6f186q0M3ni+5tsaVhUiykxjsPgkuWXWW9MbLpYXkzX6h/RIEKlo2BGA95 QwG5+Ya2Bo3g7FGJHAkXY6loq7DgMp5/TVQ8phsSv3WxPTJLCBq6vNBamp5hda4cfXFUymsy HsJy4dtgkrPQ/bnsdFDCRUuhJHopnAzKHN8APXpKU6xV5e3GE4LwFsDhNHfH/m9+2yO/trcD txSFpyftbK2gaMERHgA8SKkzRhiwRTt9w5idOfpJVkYRsgvuSGZ0pcD4kLCOIFrer5xXudk6 NgJc36XkFRMnwqrL/bB4k6Pi2u5leyqcXSLyBgeHsZJxg6Lcr2LZ35+8RQGPOw9C0ItmRjtY ZpGKPlSxjxA1WHT2YlF9CEt3nx7c4C3thHHtqBra6BGPyW8rvtq4zRqZRLPmZ0kt/kiMPhTM 8wZAlObbATVrUMcZ/uNjRv2vU9O5aTAD9E5r1B0dlqKgxyoImUWB0JgpILADaT3VybDd3C8X s6Jt8MytUP+1cEWt9VKo4vY4Jh5vwrJUDLJvzpN+TsYCZPNVj18+jf9uGRaoK6W++DdMAr5l gQiwsNgf9372dbMI7pt2gnT5/YdG+ZHnIIlXC6OUonA1Ro/Itg90Q7iQySnKKkqqnWVc+qO9 GJbzcGykxD6EQtCSlurt3/5IXTA7t6sAEQEAAcLBdgQYAQgAIBYhBA5HipsSX+lqH0rpWtNk IzqANlYGBQJbC43GAhsMAAoJENNkIzqANlYGD1sP/ikKgHgcspEKqDED9gQrTBvipH85si0j /Jwu/tBtnYjLgKLh2cjv1JkgYYjb3DyZa1pLsIv6rGnPX9bH9IN03nqirC/Q1Y1lnbNTynPk IflgvsJjoTNZjgu1wUdQlBgL/JhUp1sIYID11jZphgzfDgp/E6ve/8xE2HMAnf4zAfJaKgD0 F+fL1DlcdYUditAiYEuN40Ns/abKs8I1MYx7Yglu3RzJfBzV4t86DAR+OvuF9v188WrFwXCS RSf4DmJ8tntyNej+DVGUnmKHupLQJO7uqCKB/1HLlMKc5G3GLoGqJliHjUHUAXNzinlpE2Vj C78pxpwxRNg2ilE3AhPoAXrY5qED5PLE9sLnmQ9AzRcMMJUXjTNEDxEYbF55SdGBHHOAcZtA kEQKub86e+GHA+Z8oXQSGeSGOkqHi7zfgW1UexddTvaRwE6AyZ6FxTApm8wq8NT2cryWPWTF BDSGB3ujWHMM8ERRYJPcBSjTvt0GcEqnd+OSGgxTkGOdufn51oz82zfpVo1t+J/FNz6MRMcg 8nEC+uKvgzH1nujxJ5pRCBOquFZaGn/p71Yr0oVitkttLKblFsqwa+10Lt6HBxm+2+VLp4Ja 0WZNncZciz3V3cuArpan/ZhhyiWYV5FD0pOXPCJIx7WS9PTtxiv0AOS4ScWEUmBxyhFeOpYa DrEx In-Reply-To: <20231114103545.2878054-3-d.csapak@proxmox.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.067 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [plugin.pm, common.pm, usb.pm, pci.pm] Subject: Re: [pve-devel] [PATCH guest-common v2 1/1] add profiles section config plugin X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 14 Nov 2023 12:41:39 -0000 Am 14/11/2023 um 11:35 schrieb Dominik Csapak: > 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 pack the type and id in the global options, so that when using > it with a seperated section config they get included in the > create/updateSchema > > Signed-off-by: Dominik Csapak > --- > src/Makefile | 2 ++ > src/PVE/Profiles/Plugin.pm | 74 ++++++++++++++++++++++++++++++++++++++ > 2 files changed, 76 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..6ea2b5f > --- /dev/null > +++ b/src/PVE/Profiles/Plugin.pm > @@ -0,0 +1,74 @@ > +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, extra space before opening parenthesis. > + sub { __PACKAGE__->parse_config(@_); }, > + sub { __PACKAGE__->write_config(@_); }); let's use some more modern indentation here 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 => "Description.", I mean, yes, but a sentence is still nice: description => "Use this to add a short comment about a profile.", > + type => 'string', > + optional => 1, > + maxLength => 4096, would start out with a bit less, as this is rendered in grids and the like and doesn't needs to hold that many information than e.g., node or guest instances might have. > + }, > + }, > + options => { > + type => {}, > + id => {}, > + 'profile-description' => { optional => 1 }, > + }, > +}; > + > +sub private { > + return $defaultData; > +} > + > +sub parse_config { > + my ($class, $filename, $raw, $allow_unknown) = @_; > + > + # always allow unknown, so that qemu-server/pct-container to make it slightly easier to understand it'd IMO help to: s/unknown/unknown section types/ > + # 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 get_guest_ready_config { This is rather covoluted name for what happens, wouldn't naming this `load_profile` be clear enough? Or are there future changes, or overrides in child-implementations that warrant this name (even then we probably find something better) > + my ($id, $type) = @_; Otherwise I'd use at least the following variable names to clarify what $id's we're talking about, because from the method name I initially thought those are vmid's (was cleared up quickly when continue reading the code, but IMO still not ideal as is) my ($profile_id, $profile_type) = @_; > + > + my $cfg = PVE::Cluster::cfs_read_file($CFG_PATH); > + > + my $profile = $cfg->{ids}->{$id}; > + die "no such profile '$id'\n" if !defined $profile; > + die "wrong type '$profile->{type}'\n" if $profile->{type} ne $type; > + > + delete $profile->{type}; > + delete $profile->{'profile-description'}; > + > + return $profile; > +} > + > +1;