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 1/2] s3 client: api types: extend client config by optional quirks
Date: Mon, 28 Jul 2025 12:01:51 +0200	[thread overview]
Message-ID: <20250728100154.556438-2-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250728100154.556438-1-c.ebner@proxmox.com>

Add optional provider specific quirks to the client configuration,
allowing to set a variant of the client to follow some custom
implementation variants.

Add backblaze as first variant, as it does not accept the
`If-None-Match` header in put object requests.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 proxmox-s3-client/examples/s3_client.rs |  1 +
 proxmox-s3-client/src/api_types.rs      | 18 +++++++++++++++++-
 proxmox-s3-client/src/client.rs         |  3 +++
 3 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/proxmox-s3-client/examples/s3_client.rs b/proxmox-s3-client/examples/s3_client.rs
index 1cbb3939..25df9609 100644
--- a/proxmox-s3-client/examples/s3_client.rs
+++ b/proxmox-s3-client/examples/s3_client.rs
@@ -38,6 +38,7 @@ async fn run() -> Result<(), anyhow::Error> {
         // `openssl s_client -connect testbucket.s3.pve-c1.local:7480 < /dev/null | openssl x509 -fingerprint -sha256 -noout`
         fingerprint: Some("<s3-api-fingerprint>".to_string()),
         put_rate_limit: None,
+        quirks: None,
     };
 
     // Creating a client instance and connect to api endpoint
diff --git a/proxmox-s3-client/src/api_types.rs b/proxmox-s3-client/src/api_types.rs
index eff15f37..59fda383 100644
--- a/proxmox-s3-client/src/api_types.rs
+++ b/proxmox-s3-client/src/api_types.rs
@@ -5,7 +5,7 @@ use serde::{Deserialize, Serialize};
 use proxmox_schema::api_types::{
     CERT_FINGERPRINT_SHA256_SCHEMA, DNS_LABEL_STR, IPRE_STR, SAFE_ID_FORMAT,
 };
-use proxmox_schema::{api, const_regex, ApiStringFormat, Schema, StringSchema, Updater};
+use proxmox_schema::{api, const_regex, ApiStringFormat, EnumEntry, Schema, StringSchema, Updater};
 
 #[rustfmt::skip]
 /// Regex to match S3 endpoint full qualified domain names, including template patterns for bucket
@@ -80,6 +80,15 @@ pub const S3_BUCKET_NAME_SCHEMA: Schema = StringSchema::new("Bucket name for S3
     .max_length(63)
     .schema();
 
+/// Provider specific feature implementation quirks
+pub const S3_PROVIDER_QUIRKS_SCHEMA: Schema =
+    StringSchema::new("Provider specific feature implementation quirks.")
+        .format(&ApiStringFormat::Enum(&[EnumEntry::new(
+            "backblaze",
+            "Backblaze",
+        )]))
+        .schema();
+
 #[api(
     properties: {
         endpoint: {
@@ -109,6 +118,10 @@ pub const S3_BUCKET_NAME_SCHEMA: Schema = StringSchema::new("Bucket name for S3
             type: u64,
             optional: true,
         },
+        quirks: {
+            schema: S3_PROVIDER_QUIRKS_SCHEMA,
+            optional: true,
+        },
     },
 )]
 #[derive(Serialize, Deserialize, Updater, Clone, PartialEq)]
@@ -134,6 +147,9 @@ pub struct S3ClientConfig {
     /// Rate limit for put requests given as #reqest/s.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub put_rate_limit: Option<u64>,
+    /// Provider specific feature implementation quirks
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub quirks: Option<String>,
 }
 
 impl S3ClientConfig {
diff --git a/proxmox-s3-client/src/client.rs b/proxmox-s3-client/src/client.rs
index 3a981bf4..bbe363da 100644
--- a/proxmox-s3-client/src/client.rs
+++ b/proxmox-s3-client/src/client.rs
@@ -69,6 +69,8 @@ pub struct S3ClientOptions {
     pub fingerprint: Option<String>,
     /// Rate limit for put requests given as #reqest/s.
     pub put_rate_limit: Option<u64>,
+    /// Provider specific feature implementation quirks
+    pub quirks: Option<String>,
 }
 
 impl S3ClientOptions {
@@ -90,6 +92,7 @@ impl S3ClientOptions {
             access_key: config.access_key,
             secret_key,
             put_rate_limit: config.put_rate_limit,
+            quirks: config.quirks,
         }
     }
 }
-- 
2.47.2



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


  reply	other threads:[~2025-07-28 10:00 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-28 10:01 [pbs-devel] [PATCH proxmox{, -backup} 0/4] s3: extend config by quirks, implement backblaze B2 specific quirk Christian Ebner
2025-07-28 10:01 ` Christian Ebner [this message]
2025-07-28 10:01 ` [pbs-devel] [PATCH proxmox 2/2] s3 client: skip setting `If-None-Match` header for Backblaze B2 Christian Ebner
2025-07-28 10:01 ` [pbs-devel] [PATCH proxmox-backup 1/2] api: s3 config: allow to update or delete endpoint quirks Christian Ebner
2025-07-28 10:01 ` [pbs-devel] [PATCH proxmox-backup 2/2] ui: s3 endpoint: add provider specific quirk selector Christian Ebner
2025-07-29  6:36 ` [pbs-devel] [PATCH proxmox{, -backup} 0/4] s3: extend config by quirks, implement backblaze B2 specific quirk Christian Ebner
2025-07-29  8:19 ` [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=20250728100154.556438-2-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