public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v10 11/46] api: backup: conditionally upload manifest to s3 object store backend
Date: Mon, 21 Jul 2025 18:44:32 +0200	[thread overview]
Message-ID: <20250721164507.1045869-15-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250721164507.1045869-1-c.ebner@proxmox.com>

Reupload the manifest to the S3 object store backend on manifest
updates, if s3 is configured as backend.
This also triggers the initial manifest upload when finishing backup
snapshot in the backup api call handler.
Updates also the locally cached version for fast and efficient
listing of contents without the need to perform expensive (as in
monetary cost and IO latency) requests.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
changes since version 9:
- no changes

 pbs-datastore/Cargo.toml         |  3 +++
 pbs-datastore/src/backup_info.rs | 12 +++++++++++-
 src/api2/admin/datastore.rs      | 14 ++++++++++++--
 src/api2/backup/environment.rs   | 16 ++++++++--------
 src/backup/verify.rs             |  2 +-
 5 files changed, 35 insertions(+), 12 deletions(-)

diff --git a/pbs-datastore/Cargo.toml b/pbs-datastore/Cargo.toml
index c42eff165..7e56dbd31 100644
--- a/pbs-datastore/Cargo.toml
+++ b/pbs-datastore/Cargo.toml
@@ -13,6 +13,7 @@ crc32fast.workspace = true
 endian_trait.workspace = true
 futures.workspace = true
 hex = { workspace = true, features = [ "serde" ] }
+hyper.workspace = true
 libc.workspace = true
 log.workspace = true
 nix.workspace = true
@@ -29,8 +30,10 @@ zstd-safe.workspace = true
 pathpatterns.workspace = true
 pxar.workspace = true
 
+proxmox-async.workspace = true
 proxmox-base64.workspace = true
 proxmox-borrow.workspace = true
+proxmox-http.workspace = true
 proxmox-human-byte.workspace = true
 proxmox-io.workspace = true
 proxmox-lang.workspace=true
diff --git a/pbs-datastore/src/backup_info.rs b/pbs-datastore/src/backup_info.rs
index e3ecd437f..a4bf958cf 100644
--- a/pbs-datastore/src/backup_info.rs
+++ b/pbs-datastore/src/backup_info.rs
@@ -19,7 +19,7 @@ use pbs_api_types::{
 use pbs_config::{open_backup_lockfile, BackupLockGuard};
 
 use crate::manifest::{BackupManifest, MANIFEST_LOCK_NAME};
-use crate::{DataBlob, DataStore};
+use crate::{DataBlob, DataStore, DatastoreBackend};
 
 pub const DATASTORE_LOCKS_DIR: &str = "/run/proxmox-backup/locks";
 const PROTECTED_MARKER_FILENAME: &str = ".protected";
@@ -666,6 +666,7 @@ impl BackupDir {
     /// only use this method - anything else may break locking guarantees.
     pub fn update_manifest(
         &self,
+        backend: &DatastoreBackend,
         update_fn: impl FnOnce(&mut BackupManifest),
     ) -> Result<(), Error> {
         let _guard = self.lock_manifest()?;
@@ -678,6 +679,15 @@ impl BackupDir {
         let blob = DataBlob::encode(manifest.as_bytes(), None, true)?;
         let raw_data = blob.raw_data();
 
+        if let DatastoreBackend::S3(s3_client) = backend {
+            let object_key =
+                super::s3::object_key_from_path(&self.relative_path(), MANIFEST_BLOB_NAME.as_ref())
+                    .context("invalid manifest object key")?;
+            let data = hyper::body::Bytes::copy_from_slice(raw_data);
+            proxmox_async::runtime::block_on(s3_client.upload_replace_with_retry(object_key, data))
+                .context("failed to update manifest on s3 backend")?;
+        }
+
         let mut path = self.full_path();
         path.push(MANIFEST_BLOB_NAME.as_ref());
 
diff --git a/src/api2/admin/datastore.rs b/src/api2/admin/datastore.rs
index e24bc1c1b..1fabda09a 100644
--- a/src/api2/admin/datastore.rs
+++ b/src/api2/admin/datastore.rs
@@ -65,7 +65,7 @@ use pbs_datastore::manifest::BackupManifest;
 use pbs_datastore::prune::compute_prune_info;
 use pbs_datastore::{
     check_backup_owner, ensure_datastore_is_mounted, task_tracking, BackupDir, BackupGroup,
-    DataStore, LocalChunkReader, StoreProgress,
+    DataStore, DatastoreBackend, LocalChunkReader, StoreProgress,
 };
 use pbs_tools::json::required_string_param;
 use proxmox_rest_server::{formatter, WorkerTask};
@@ -2086,6 +2086,16 @@ pub fn set_group_notes(
         &backup_group,
     )?;
 
+    if let DatastoreBackend::S3(s3_client) = datastore.backend()? {
+        let mut path = ns.path();
+        path.push(backup_group.to_string());
+        let object_key = pbs_datastore::s3::object_key_from_path(&path, "notes")
+            .context("invalid owner file object key")?;
+        let data = hyper::body::Bytes::copy_from_slice(notes.as_bytes());
+        let _is_duplicate =
+            proxmox_async::runtime::block_on(s3_client.upload_replace_with_retry(object_key, data))
+                .context("failed to set notes on s3 backend")?;
+    }
     let notes_path = datastore.group_notes_path(&ns, &backup_group);
     replace_file(notes_path, notes.as_bytes(), CreateOptions::new(), false)?;
 
@@ -2188,7 +2198,7 @@ pub fn set_notes(
     let backup_dir = datastore.backup_dir(ns, backup_dir)?;
 
     backup_dir
-        .update_manifest(|manifest| {
+        .update_manifest(&datastore.backend()?, |manifest| {
             manifest.unprotected["notes"] = notes.into();
         })
         .map_err(|err| format_err!("unable to update manifest blob - {}", err))?;
diff --git a/src/api2/backup/environment.rs b/src/api2/backup/environment.rs
index b67145fa6..4a70d7c13 100644
--- a/src/api2/backup/environment.rs
+++ b/src/api2/backup/environment.rs
@@ -646,14 +646,6 @@ impl BackupEnvironment {
             bail!("backup does not contain valid files (file count == 0)");
         }
 
-        // check for valid manifest and store stats
-        let stats = serde_json::to_value(state.backup_stat)?;
-        self.backup_dir
-            .update_manifest(|manifest| {
-                manifest.unprotected["chunk_upload_stats"] = stats;
-            })
-            .map_err(|err| format_err!("unable to update manifest blob - {}", err))?;
-
         if let Some(base) = &self.last_backup {
             let path = base.backup_dir.full_path();
             if !path.exists() {
@@ -664,6 +656,14 @@ impl BackupEnvironment {
             }
         }
 
+        // check for valid manifest and store stats
+        let stats = serde_json::to_value(state.backup_stat)?;
+        self.backup_dir
+            .update_manifest(&self.backend, |manifest| {
+                manifest.unprotected["chunk_upload_stats"] = stats;
+            })
+            .map_err(|err| format_err!("unable to update manifest blob - {err}"))?;
+
         self.datastore.try_ensure_sync_level()?;
 
         // marks the backup as successful
diff --git a/src/backup/verify.rs b/src/backup/verify.rs
index 0b954ae23..9344033d8 100644
--- a/src/backup/verify.rs
+++ b/src/backup/verify.rs
@@ -359,7 +359,7 @@ impl VerifyWorker {
 
         if let Err(err) = {
             let verify_state = serde_json::to_value(verify_state)?;
-            backup_dir.update_manifest(|manifest| {
+            backup_dir.update_manifest(&self.datastore.backend()?, |manifest| {
                 manifest.unprotected["verify_state"] = verify_state;
             })
         } {
-- 
2.47.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2025-07-21 16:45 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-21 16:44 [pbs-devel] [PATCH proxmox{, -backup} v10 00/49] fix #2943: S3 storage backend for datastores Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox v10 1/3] pbs-api-types: extend datastore config by backend config enum Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox v10 2/3] pbs-api-types: maintenance: add new maintenance mode S3 refresh Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox v10 3/3] s3 client: Add missing S3 object key max length check Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 01/46] datastore: add helpers for path/digest to s3 object key conversion Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 02/46] config: introduce s3 object store client configuration Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 03/46] api: config: implement endpoints to manipulate and list s3 configs Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 04/46] api: datastore: check s3 backend bucket access on datastore create Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 05/46] api/cli: add endpoint and command to check s3 client connection Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 06/46] datastore: allow to get the backend for a datastore Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 07/46] api: backup: store datastore backend in runtime environment Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 08/46] api: backup: conditionally upload chunks to s3 object store backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 09/46] api: backup: conditionally upload blobs " Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 10/46] api: backup: conditionally upload indices " Christian Ebner
2025-07-21 16:44 ` Christian Ebner [this message]
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 12/46] api: datastore: conditionally upload client log to s3 backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 13/46] sync: pull: conditionally upload content " Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 14/46] api: reader: fetch chunks based on datastore backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 15/46] datastore: local chunk reader: read chunks based on backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 16/46] verify worker: add datastore backed to verify worker Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 17/46] verify: implement chunk verification for stores with s3 backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 18/46] datastore: create namespace marker in " Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 19/46] datastore: create/delete protected marker file on s3 storage backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 20/46] datastore: prune groups/snapshots from s3 object store backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 21/46] datastore: get and set owner for s3 " Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 22/46] datastore: implement garbage collection for s3 backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 23/46] ui: add datastore type selector and reorganize component layout Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 24/46] ui: add s3 client edit window for configuration create/edit Christian Ebner
2025-07-21 20:14   ` Thomas Lamprecht
2025-07-22  6:24     ` Christian Ebner
2025-07-22  7:00       ` Thomas Lamprecht
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 25/46] ui: add s3 client view for configuration Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 26/46] ui: expose the s3 client view in the navigation tree Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 27/46] ui: add s3 client selector and bucket field for s3 backend setup Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 28/46] tools: lru cache: add removed callback for evicted cache nodes Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 29/46] tools: async lru cache: implement insert, remove and contains methods Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 30/46] datastore: add local datastore cache for network attached storages Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 31/46] api: backup: use local datastore cache on s3 backend chunk upload Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 32/46] api: reader: use local datastore cache on s3 backend chunk fetching Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 33/46] datastore: local chunk reader: get cached chunk from local cache store Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 34/46] backup writer: refactor parameters into backup writer options struct Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 35/46] api: backup: add no-cache flag to bypass local datastore cache Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 36/46] api/datastore: implement refresh endpoint for stores with s3 backend Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 37/46] cli: add dedicated subcommand for datastore s3 refresh Christian Ebner
2025-07-21 16:44 ` [pbs-devel] [PATCH proxmox-backup v10 38/46] ui: render s3 refresh as valid maintenance type and task description Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 39/46] ui: expose s3 refresh button for datastores backed by object store Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 40/46] datastore: conditionally upload atime marker chunk to s3 backend Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 41/46] bin: implement client subcommands for s3 configuration manipulation Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 42/46] bin: expose reuse-datastore flag for proxmox-backup-manager Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 43/46] datastore: mark store as in-use by setting marker on s3 backend Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 44/46] datastore: run s3-refresh when reusing a datastore with " Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 45/46] api/ui: add flag to allow overwriting in-use marker for " Christian Ebner
2025-07-21 16:45 ` [pbs-devel] [PATCH proxmox-backup v10 46/46] docs: Add section describing how to setup s3 backed datastore Christian Ebner
2025-07-22  8:14 ` [pbs-devel] [PATCH proxmox{, -backup} v10 00/49] fix #2943: S3 storage backend for datastores Hannes Laimer
2025-07-22  9:29 ` Lukas Wagner
2025-07-22 10:13 ` [pbs-devel] superseded: " Christian 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=20250721164507.1045869-15-c.ebner@proxmox.com \
    --to=c.ebner@proxmox.com \
    --cc=pbs-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal