mirror of
https://git.proxmox.com/git/pve-storage
synced 2025-11-01 06:00:36 +00:00
plugin api: bump api version and age
Changes for version 11: * Allow declaring storage features via plugin data. * Introduce new_backup_provider() plugin method. * Allow declaring sensitive properties via plugin data. See the api changelog file for details. Signed-off-by: Fiona Ebner <f.ebner@proxmox.com> Tested-by: Wolfgang Bumiller <w.bumiller@proxmox.com> Reviewed-by: Wolfgang Bumiller <w.bumiller@proxmox.com> Link: https://lore.proxmox.com/20250404133204.239783-7-f.ebner@proxmox.com
This commit is contained in:
parent
db5c50c079
commit
e2dc01ac9f
32
ApiChangeLog
32
ApiChangeLog
@ -6,6 +6,38 @@ without breaking anything unaware of it.)
|
|||||||
|
|
||||||
Future changes should be documented in here.
|
Future changes should be documented in here.
|
||||||
|
|
||||||
|
## Version 11:
|
||||||
|
|
||||||
|
* Allow declaring storage features via plugin data
|
||||||
|
|
||||||
|
A new `storage_has_feature()` helper function was added that checks a storage plugin's features.
|
||||||
|
Plugins can indicate support for certain features in their `plugindata`. The first such feature is
|
||||||
|
`backup-provider`, see below for more details. To declare support for this feature, return
|
||||||
|
`features => { 'backup-provider' => 1 }` as part of the plugin data.
|
||||||
|
|
||||||
|
* Introduce new_backup_provider() plugin method
|
||||||
|
|
||||||
|
Proxmox VE now supports a `Backup Provider API` that can be used to implement custom backup
|
||||||
|
solutions tightly integrated in the Proxmox VE stack. See the `PVE::BackupProvider::Plugin::Base`
|
||||||
|
module for detailed documentation. A backup provider also needs to implement an associated storage
|
||||||
|
plugin for user-facing integration in Proxmox VE. Such a plugin needds to opt-in to the
|
||||||
|
`backup-provider` feature (see above) and implement the new_backup_provider() method, returning a
|
||||||
|
blessed reference to the backup provider class. The rest of the plugin methods, e.g. listing
|
||||||
|
content, providing usage information, etc., follow the same API as usual.
|
||||||
|
|
||||||
|
* Allow declaring sensitive properties via plugin data
|
||||||
|
|
||||||
|
A new `sensitive_properties()` helper function was added to get the list of sensitive properties
|
||||||
|
a plugin uses via the plugin's `plugindata`. The sensitive properties are passed separately from
|
||||||
|
other properties to the `on_add_hook()` and `on_update_hook()` methods and should not be written
|
||||||
|
to the storage configuration file directly, but stored in the more restricted
|
||||||
|
`/etc/pve/priv/storage` directory on the Proxmox Cluster File System. For example, to declare that
|
||||||
|
a `ssh-private-key` property used by the plugin is sensitive, return
|
||||||
|
`'sensitive-properties' => { 'ssh-private-key' => 1 }` as part of the plugin data. The list of
|
||||||
|
sensitive properties was hard-coded previously, as `encryption-key`, `keyring`, `master-pubkey`,
|
||||||
|
`password`. For backwards compatibility, this list is still used if a plugin doesn't declare its
|
||||||
|
own sensitive properties.
|
||||||
|
|
||||||
## Version 10:
|
## Version 10:
|
||||||
|
|
||||||
* a new `rename_volume` method has been added
|
* a new `rename_volume` method has been added
|
||||||
|
|||||||
@ -42,11 +42,11 @@ use PVE::Storage::BTRFSPlugin;
|
|||||||
use PVE::Storage::ESXiPlugin;
|
use PVE::Storage::ESXiPlugin;
|
||||||
|
|
||||||
# Storage API version. Increment it on changes in storage API interface.
|
# Storage API version. Increment it on changes in storage API interface.
|
||||||
use constant APIVER => 10;
|
use constant APIVER => 11;
|
||||||
# Age is the number of versions we're backward compatible with.
|
# Age is the number of versions we're backward compatible with.
|
||||||
# This is like having 'current=APIVER' and age='APIAGE' in libtool,
|
# This is like having 'current=APIVER' and age='APIAGE' in libtool,
|
||||||
# see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
|
# see https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html
|
||||||
use constant APIAGE => 1;
|
use constant APIAGE => 2;
|
||||||
|
|
||||||
our $KNOWN_EXPORT_FORMATS = ['raw+size', 'tar+size', 'qcow2+size', 'vmdk+size', 'zfs', 'btrfs'];
|
our $KNOWN_EXPORT_FORMATS = ['raw+size', 'tar+size', 'qcow2+size', 'vmdk+size', 'zfs', 'btrfs'];
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user