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 v7 04/38] api: datastore: check s3 backend bucket access on datastore create
Date: Thu, 10 Jul 2025 19:06:54 +0200	[thread overview]
Message-ID: <20250710170728.102829-14-c.ebner@proxmox.com> (raw)
In-Reply-To: <20250710170728.102829-1-c.ebner@proxmox.com>

Check if the configured S3 object store backend can be reached and
the provided secrets have the permissions to access the bucket.

Perform the check before creating the chunk store, so it is not left
behind if the bucket cannot be reached.

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

 Cargo.toml                   |  2 +-
 src/api2/config/datastore.rs | 48 ++++++++++++++++++++++++++++++++----
 2 files changed, 44 insertions(+), 6 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index c7a77060e..a5954635a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -77,7 +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"
+proxmox-s3-client = { version = "1.0.0", features = [ "impl" ] }
 # everything but pbs-config and pbs-client use "api-macro"
 proxmox-schema = "4"
 proxmox-section-config = "3"
diff --git a/src/api2/config/datastore.rs b/src/api2/config/datastore.rs
index b133be707..0fb822c79 100644
--- a/src/api2/config/datastore.rs
+++ b/src/api2/config/datastore.rs
@@ -1,21 +1,22 @@
 use std::path::{Path, PathBuf};
 
 use ::serde::{Deserialize, Serialize};
-use anyhow::{bail, Context, Error};
+use anyhow::{bail, format_err, Context, Error};
 use hex::FromHex;
 use serde_json::Value;
 use tracing::{info, warn};
 
 use proxmox_router::{http_bail, Permission, Router, RpcEnvironment, RpcEnvironmentType};
+use proxmox_s3_client::{S3Client, S3ClientConfig, S3ClientOptions, S3ClientSecretsConfig};
 use proxmox_schema::{api, param_bail, ApiType};
 use proxmox_section_config::SectionConfigData;
 use proxmox_uuid::Uuid;
 
 use pbs_api_types::{
-    Authid, DataStoreConfig, DataStoreConfigUpdater, DatastoreNotify, DatastoreTuning, KeepOptions,
-    MaintenanceMode, PruneJobConfig, PruneJobOptions, DATASTORE_SCHEMA, PRIV_DATASTORE_ALLOCATE,
-    PRIV_DATASTORE_AUDIT, PRIV_DATASTORE_MODIFY, PRIV_SYS_MODIFY, PROXMOX_CONFIG_DIGEST_SCHEMA,
-    UPID_SCHEMA,
+    Authid, DataStoreConfig, DataStoreConfigUpdater, DatastoreBackendConfig, DatastoreBackendType,
+    DatastoreNotify, DatastoreTuning, KeepOptions, MaintenanceMode, PruneJobConfig,
+    PruneJobOptions, DATASTORE_SCHEMA, PRIV_DATASTORE_ALLOCATE, PRIV_DATASTORE_AUDIT,
+    PRIV_DATASTORE_MODIFY, PRIV_SYS_MODIFY, PROXMOX_CONFIG_DIGEST_SCHEMA, UPID_SCHEMA,
 };
 use pbs_config::BackupLockGuard;
 use pbs_datastore::chunk_store::ChunkStore;
@@ -116,6 +117,43 @@ pub(crate) fn do_create_datastore(
             .parse_property_string(datastore.tuning.as_deref().unwrap_or(""))?,
     )?;
 
+    if let Some(ref backend_config) = datastore.backend {
+        let backend_config: DatastoreBackendConfig = backend_config.parse()?;
+        match backend_config.ty.unwrap_or_default() {
+            DatastoreBackendType::Filesystem => (),
+            DatastoreBackendType::S3 => {
+                let s3_client_id = backend_config
+                    .client
+                    .as_ref()
+                    .ok_or_else(|| format_err!("missing required client"))?;
+                let bucket = backend_config
+                    .bucket
+                    .clone()
+                    .ok_or_else(|| format_err!("missing required bucket"))?;
+                let (config, _config_digest) =
+                    pbs_config::s3::config().context("failed to get s3 config")?;
+                let (secrets, _secrets_digest) =
+                    pbs_config::s3::secrets_config().context("failed to get s3 secrets")?;
+                let config: S3ClientConfig = config
+                    .lookup("s3client", s3_client_id)
+                    .with_context(|| format!("no '{s3_client_id}' in config"))?;
+                let secrets: S3ClientSecretsConfig = secrets
+                    .lookup("s3secrets", s3_client_id)
+                    .with_context(|| format!("no '{s3_client_id}' in secrets"))?;
+                let options = S3ClientOptions::from_config(
+                    config,
+                    secrets,
+                    bucket,
+                    datastore.name.to_owned(),
+                );
+                let s3_client = S3Client::new(options).context("failed to create s3 client")?;
+                // Fine to block since this runs in worker task
+                proxmox_async::runtime::block_on(s3_client.head_bucket())
+                    .context("failed to access bucket")?;
+            }
+        }
+    }
+
     let unmount_guard = if datastore.backing_device.is_some() {
         do_mount_device(datastore.clone())?;
         UnmountGuard::new(Some(path.clone()))
-- 
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-10 17:08 UTC|newest]

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