From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pve-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 7BEFA1FF15E for <inbox@lore.proxmox.com>; Tue, 25 Mar 2025 09:59:28 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 375AE3D26; Tue, 25 Mar 2025 09:59:22 +0100 (CET) Message-ID: <3c13a721-14c4-41ae-8ad2-b52a2d84bd38@proxmox.com> Date: Tue, 25 Mar 2025 09:59:01 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird From: Fiona Ebner <f.ebner@proxmox.com> To: Prashant Patil <Prashant.Gamepatil@veritas.com>, Proxmox VE development discussion <pve-devel@lists.proxmox.com>, Thomas Lamprecht <t.lamprecht@proxmox.com> References: <PH0PR20MB4520A4201D4560B18A0C830798C82@PH0PR20MB4520.namprd20.prod.outlook.com> <PH0PR20MB45201A18272FF3B7B386D98B98C82@PH0PR20MB4520.namprd20.prod.outlook.com> <2402a2e8-63a5-46c4-9b66-d998f6e421c7@proxmox.com> <mailman.766.1741156631.293.pve-devel@lists.proxmox.com> <c355aa91-fcdf-46d2-9ed7-89c215ae5d01@proxmox.com> <PH0PR20MB4520C688E38C97D5DE5FC25B98DF2@PH0PR20MB4520.namprd20.prod.outlook.com> <51c423c9-786c-4881-8819-83c075c89b36@proxmox.com> <PH0PR20MB4520276B3A7061528854180598DF2@PH0PR20MB4520.namprd20.prod.outlook.com> <PH0PR20MB45209D60E2A2A691D643A3C998DE2@PH0PR20MB4520.namprd20.prod.outlook.com> <9963c93c-29a7-4d20-b282-ec5629d812a8@proxmox.com> <PH0PR20MB4520584B52872E16277A621198A42@PH0PR20MB4520.namprd20.prod.outlook.com> Content-Language: en-US In-Reply-To: <PH0PR20MB4520584B52872E16277A621198A42@PH0PR20MB4520.namprd20.prod.outlook.com> X-SPAM-LEVEL: Spam detection results: 0 AWL -0.167 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 KAM_LOTSOFHASH 0.25 Emails with lots of hash-like gibberish RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pve-devel] About PVE Backup Integration Guide X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/> List-Post: <mailto:pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com> Cc: Anuradha Joshi <Anuradha.Joshi@veritas.com>, Sudhir Subbarao <Sudhir.Subbarao@veritas.com>, Jason Voneberstein <Jason.vonEberstein@veritas.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com> Am 24.03.25 um 06:20 schrieb Prashant Patil: > We would like to do plugin integration POC. So, for that to get started, we would like to know various interfaces of these plugins. Is there any detailed API documentation available for these plugins? Also, do you have any test app code which integrates with the plugins to try out? The cover letter of the patch series [0] mentions: > A backup provider needs to implement a storage plugin as well as a > backup provider plugin. The storage plugin is for integration in > Proxmox VE's front-end, so users can manage the backups via > UI/API/CLI. The backup provider plugin is for interfacing with the > backup provider's backend to integrate backup and restore with that > backend into Proxmox VE. We unfortunately do not have a proper documentation for the storage plugin API yet, some colleagues are currently working on that. But if the storage only needs to support backups, you don't need to implement some of the methods (e.g. for volume snapshots) and don't need much complexity. See the BackupProviderDirExamplePlugin.pm in [1] for a simple example of which methods are important. A second example, that also involves handling secrets (but also not fully complete), is the BorgBackupPlugin.pm in [2]. Of course, the backup mechanism doesn't need to be configurable in your case, you can choose one for VMs and one for LXCs. The backup provider plugin serves as the bridge between Proxmox VE and your backup server/storage. The API for this is documented in the Base.pm plugin in [3] with Perl's POD documentation format. You can read it by running the command: perldoc src/PVE/BackupProvider/Plugin/Base.pm Or some alternative way to view POD documentation. Examples can be found in [1][2] too. If you have questions about specific parts of the API (both storage plugin or backup provider), feel free to ask. There are pre-built packages with the series incorporated available at [0] with SHA256SUM [1]. [0]: http://download.proxmox.com/temp/backup-provider-api-v5/ [1]: > b30ef35447310e4f92e6ed434fce902160a76b64b54432a43696b853e2f073ad libpve-common-perl_8.2.9+backupproviderapiv5_all.deb > e2f3b9d2217bbb0bb75c94a73be1a9b76cda688028234fb529f4a25d1006a4ad libpve-storage-perl_8.3.4+backupproviderapiv5_all.deb > efb4cb6c3928e20a5c297533e44da93f913b474f7dfb27274c822071890b8975 pve-container_5.2.5+backupproviderapiv5_all.deb > 138324eafd889a5e90e69c9b5aedd9df3ed7db09be7305d979bdd5a306e1858f pve-manager_8.3.5+backupproviderapiv5_all.deb > bdb871a0c57347607aec955f771cdb7ad24245cb1c4bf2517fbb78d734228ccd pve-qemu-kvm_9.2.0-2+backupproviderapiv5_amd64.deb > 12eb9034819364d0057b80d827515832589ee0848934b27be4039dbbc78cb060 qemu-server_8.3.9+backupproviderapiv5_amd64.deb > 04ca13927bfd70800c1855022642e6db88b05b711b44877a120a84949d208c2e qemu-server-dbgsym_8.3.9+backupproviderapiv5_amd64.deb Best Regards, Fiona [0]: https://lore.proxmox.com/pve-devel/20250321134852.103871-1-f.ebner@proxmox.com/ [1]: https://lore.proxmox.com/pve-devel/20250321134852.103871-14-f.ebner@proxmox.com/ [2]: https://lore.proxmox.com/pve-devel/20250321134852.103871-15-f.ebner@proxmox.com/ [3]: https://lore.proxmox.com/pve-devel/20250321134852.103871-10-f.ebner@proxmox.com/ _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel