all lists on 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 v6 01/37] datastore: add helpers for path/digest to s3 object key conversion
Date: Tue,  8 Jul 2025 19:00:38 +0200	[thread overview]
Message-ID: <20250708170114.1556057-11-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250708170114.1556057-1-c.ebner@proxmox.com>

Adds helper methods to generate the s3 object keys given a relative
path and filename for datastore contents or digest in case of chunk
files.

Regular datastore contents are stored by grouping them with a content
prefix in the object key. In order to keep the object key length
small, given the max limit of 1024 bytes {0], `.cnt` is used as
content prefix. Chunks on the other hand are prefixed by `.chunks`,
same as on regular datastores.

The prefix allows for selective listing of either contents or chunks
by providing the prefix to the respective api calls.

[0] https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 Cargo.toml               |  1 +
 pbs-datastore/Cargo.toml |  1 +
 pbs-datastore/src/lib.rs |  1 +
 pbs-datastore/src/s3.rs  | 49 ++++++++++++++++++++++++++++++++++++++++
 4 files changed, 52 insertions(+)
 create mode 100644 pbs-datastore/src/s3.rs

diff --git a/Cargo.toml b/Cargo.toml
index 4b1671ea6..d2fbbb2b7 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -77,6 +77,7 @@ proxmox-rest-server = { version = "1", features = [ "templates" ] }
 proxmox-router = { version = "3.2.2", default-features = false }
 proxmox-rrd = "1"
 proxmox-rrd-api-types = "1.0.2"
+proxmox-s3-client = "1.0.0"
 # everything but pbs-config and pbs-client use "api-macro"
 proxmox-schema = "4"
 proxmox-section-config = "3"
diff --git a/pbs-datastore/Cargo.toml b/pbs-datastore/Cargo.toml
index 56f6e9094..c42eff165 100644
--- a/pbs-datastore/Cargo.toml
+++ b/pbs-datastore/Cargo.toml
@@ -34,6 +34,7 @@ proxmox-borrow.workspace = true
 proxmox-human-byte.workspace = true
 proxmox-io.workspace = true
 proxmox-lang.workspace=true
+proxmox-s3-client = { workspace = true, features = [ "impl" ] }
 proxmox-schema = { workspace = true, features = [ "api-macro" ] }
 proxmox-serde = { workspace = true, features = [ "serde_json" ] }
 proxmox-sys.workspace = true
diff --git a/pbs-datastore/src/lib.rs b/pbs-datastore/src/lib.rs
index 5014b6c09..ffd0d91b2 100644
--- a/pbs-datastore/src/lib.rs
+++ b/pbs-datastore/src/lib.rs
@@ -182,6 +182,7 @@ pub mod manifest;
 pub mod paperkey;
 pub mod prune;
 pub mod read_chunk;
+pub mod s3;
 pub mod store_progress;
 pub mod task_tracking;
 
diff --git a/pbs-datastore/src/s3.rs b/pbs-datastore/src/s3.rs
new file mode 100644
index 000000000..82843ee26
--- /dev/null
+++ b/pbs-datastore/src/s3.rs
@@ -0,0 +1,49 @@
+use std::path::{Path, PathBuf};
+
+use anyhow::{bail, format_err, Error};
+
+use proxmox_s3_client::S3ObjectKey;
+
+/// Object key prefix to group regular datastore contents (not chunks)
+pub const S3_CONTENT_PREFIX: &str = ".cnt";
+
+/// Generate a relative object key with content prefix from given path and filename
+pub fn object_key_from_path(path: &Path, filename: &str) -> Result<S3ObjectKey, Error> {
+    // Force the use of relative paths, otherwise this would loose the content prefix
+    if path.is_absolute() {
+        bail!("cannot generate object key from absolute path");
+    }
+    if filename.contains('/') {
+        bail!("invalid filename containing slashes");
+    }
+    let mut object_path = PathBuf::from(S3_CONTENT_PREFIX);
+    object_path.push(path);
+    object_path.push(filename);
+
+    let object_key_str = object_path
+        .to_str()
+        .ok_or_else(|| format_err!("unexpected object key path"))?;
+    Ok(S3ObjectKey::from(object_key_str))
+}
+
+/// Generate a relative object key with chunk prefix from given digest
+pub fn object_key_from_digest(digest: &[u8; 32]) -> Result<S3ObjectKey, Error> {
+    let object_key = hex::encode(digest);
+    let digest_prefix = &object_key[..4];
+    let object_key_string = format!(".chunks/{digest_prefix}/{object_key}");
+    Ok(S3ObjectKey::from(object_key_string.as_str()))
+}
+
+/// Generate a relative object key with chunk prefix from given digest, extended by suffix
+pub fn object_key_from_digest_with_suffix(
+    digest: &[u8; 32],
+    suffix: &str,
+) -> Result<S3ObjectKey, Error> {
+    if suffix.contains('/') {
+        bail!("invalid suffix containing slashes");
+    }
+    let object_key = hex::encode(digest);
+    let digest_prefix = &object_key[..4];
+    let object_key_string = format!(".chunks/{digest_prefix}/{object_key}{suffix}");
+    Ok(S3ObjectKey::from(object_key_string.as_str()))
+}
-- 
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-08 17:01 UTC|newest]

Thread overview: 56+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-08 17:00 [pbs-devel] [PATCH proxmox{, -backup} v6 00/46] fix #2943: S3 storage backend for datastores Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 1/9] s3 client: add crate for AWS s3 compatible object store client Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 2/9] s3 client: implement AWS signature v4 request authentication Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 3/9] s3 client: add dedicated type for s3 object keys Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 4/9] s3 client: add type for last modified timestamp in responses Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 5/9] s3 client: add helper to parse http date headers Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 6/9] s3 client: implement methods to operate on s3 objects in bucket Christian Ebner
2025-07-09 10:04   ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 7/9] s3 client: add example usage for basic operations Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 8/9] pbs-api-types: extend datastore config by backend config enum Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox v6 9/9] pbs-api-types: maintenance: add new maintenance mode S3 refresh Christian Ebner
2025-07-08 17:00 ` Christian Ebner [this message]
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 02/37] config: introduce s3 object store client configuration Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 03/37] api: config: implement endpoints to manipulate and list s3 configs Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 04/37] api: datastore: check s3 backend bucket access on datastore create Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 05/37] api/cli: add endpoint and command to check s3 client connection Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 06/37] datastore: allow to get the backend for a datastore Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 07/37] api: backup: store datastore backend in runtime environment Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 08/37] api: backup: conditionally upload chunks to s3 object store backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 09/37] api: backup: conditionally upload blobs " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 10/37] api: backup: conditionally upload indices " Christian Ebner
2025-07-09  7:55   ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 11/37] api: backup: conditionally upload manifest " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 12/37] sync: pull: conditionally upload content to s3 backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 13/37] api: reader: fetch chunks based on datastore backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 14/37] datastore: local chunk reader: read chunks based on backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 15/37] verify worker: add datastore backed to verify worker Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 16/37] verify: implement chunk verification for stores with s3 backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 17/37] datastore: create namespace marker in " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 18/37] datastore: create/delete protected marker file on s3 storage backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 19/37] datastore: prune groups/snapshots from s3 object store backend Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 20/37] datastore: get and set owner for s3 " Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 21/37] datastore: implement garbage collection for s3 backend Christian Ebner
2025-07-10  6:59   ` Thomas Lamprecht
2025-07-10  7:36     ` Christian Ebner
2025-07-10  9:47     ` Christian Ebner
2025-07-10 11:15       ` Christian Ebner
2025-07-08 17:00 ` [pbs-devel] [PATCH proxmox-backup v6 22/37] ui: add datastore type selector and reorganize component layout Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 23/37] ui: add s3 client edit window for configuration create/edit Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 24/37] ui: add s3 client view for configuration Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 25/37] ui: expose the s3 client view in the navigation tree Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 26/37] ui: add s3 client selector and bucket field for s3 backend setup Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 27/37] tools: lru cache: add removed callback for evicted cache nodes Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 28/37] tools: async lru cache: implement insert, remove and contains methods Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 29/37] datastore: add local datastore cache for network attached storages Christian Ebner
2025-07-10 10:05   ` Thomas Lamprecht
2025-07-10 10:30     ` Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 30/37] api: backup: use local datastore cache on s3 backend chunk upload Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 31/37] api: reader: use local datastore cache on s3 backend chunk fetching Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 32/37] datastore: local chunk reader: get cached chunk from local cache store Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 33/37] api: backup: add no-cache flag to bypass local datastore cache Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 34/37] api/datastore: implement refresh endpoint for stores with s3 backend Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 35/37] cli: add dedicated subcommand for datastore s3 refresh Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 36/37] ui: render s3 refresh as valid maintenance type and task description Christian Ebner
2025-07-08 17:01 ` [pbs-devel] [PATCH proxmox-backup v6 37/37] ui: expose s3 refresh button for datastores backed by object store Christian Ebner
2025-07-10 17:09 ` [pbs-devel] superseded: [PATCH proxmox{, -backup} v6 00/46] fix #2943: S3 storage backend for datastores 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=20250708170114.1556057-11-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal