public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: Proxmox Backup Server development discussion
	<pbs-devel@lists.proxmox.com>,
	Christian Ebner <c.ebner@proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox-backup v8 06/45] datastore: allow to get the backend for a datastore
Date: Fri, 18 Jul 2025 09:52:41 +0200	[thread overview]
Message-ID: <e8afbb91-02ce-4c3d-8eb8-09ad441d8d34@proxmox.com> (raw)
In-Reply-To: <20250715125332.954494-16-c.ebner@proxmox.com>

With my feedback addressed:

Reviewed-by: Lukas Wagner <l.wagner@proxmox.com>


On  2025-07-15 14:52, Christian Ebner wrote:
> Implements an enum with variants Filesystem and S3 to distinguish
> between available backends. Filesystem will be used as default, if no
> backend is configured in the datastores configuration. If the
> datastore has an s3 backend configured, the backend method will
> instantiate and s3 client and return it with the S3 variant.
> 
> This allows to instantiate the client once, keeping and reusing the
> same open connection to the api for the lifetime of task or job, e.g.
> in the backup writer/readers runtime environment.
> 
> Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
> ---
> changes since version 7:
> - no changes
> 
>  pbs-datastore/src/datastore.rs | 52 ++++++++++++++++++++++++++++++++--
>  pbs-datastore/src/lib.rs       |  1 +
>  2 files changed, 51 insertions(+), 2 deletions(-)
> 
> diff --git a/pbs-datastore/src/datastore.rs b/pbs-datastore/src/datastore.rs
> index 924d8cf9c..90ab80005 100644
> --- a/pbs-datastore/src/datastore.rs
> +++ b/pbs-datastore/src/datastore.rs
> @@ -12,6 +12,7 @@ use pbs_tools::lru_cache::LruCache;
>  use tracing::{info, warn};
>  
>  use proxmox_human_byte::HumanByte;
> +use proxmox_s3_client::{S3Client, S3ClientConfig, S3ClientOptions, S3ClientSecretsConfig};
>  use proxmox_schema::ApiType;
>  
>  use proxmox_sys::error::SysError;
> @@ -23,8 +24,8 @@ use proxmox_worker_task::WorkerTaskContext;
>  
>  use pbs_api_types::{
>      ArchiveType, Authid, BackupGroupDeleteStats, BackupNamespace, BackupType, ChunkOrder,
> -    DataStoreConfig, DatastoreFSyncLevel, DatastoreTuning, GarbageCollectionStatus,
> -    MaintenanceMode, MaintenanceType, Operation, UPID,
> +    DataStoreConfig, DatastoreBackendConfig, DatastoreBackendType, DatastoreFSyncLevel,
> +    DatastoreTuning, GarbageCollectionStatus, MaintenanceMode, MaintenanceType, Operation, UPID,
>  };
>  use pbs_config::BackupLockGuard;
>  
> @@ -127,6 +128,7 @@ pub struct DataStoreImpl {
>      chunk_order: ChunkOrder,
>      last_digest: Option<[u8; 32]>,
>      sync_level: DatastoreFSyncLevel,
> +    backend_config: DatastoreBackendConfig,
>  }
>  
>  impl DataStoreImpl {
> @@ -141,6 +143,7 @@ impl DataStoreImpl {
>              chunk_order: Default::default(),
>              last_digest: None,
>              sync_level: Default::default(),
> +            backend_config: Default::default(),
>          })
>      }
>  }
> @@ -196,6 +199,12 @@ impl Drop for DataStore {
>      }
>  }
>  
> +#[derive(Clone)]
> +pub enum DatastoreBackend {
> +    Filesystem,
> +    S3(Arc<S3Client>),
> +}
> +

Missing doc comments for this public enum

>  impl DataStore {
>      // This one just panics on everything
>      #[doc(hidden)]
> @@ -206,6 +215,39 @@ impl DataStore {
>          })
>      }
>  
> +    /// Get the backend for this datastore based on it's configuration
> +    pub fn backend(&self) -> Result<DatastoreBackend, Error> {
> +        let backend_type = match self.inner.backend_config.ty.unwrap_or_default() {
> +            DatastoreBackendType::Filesystem => DatastoreBackend::Filesystem,
> +            DatastoreBackendType::S3 => {
> +                let s3_client_id = self
> +                    .inner
> +                    .backend_config
> +                    .client
> +                    .as_ref()
> +                    .ok_or_else(|| format_err!("missing client for s3 backend"))?;
> +                let bucket = self
> +                    .inner
> +                    .backend_config
> +                    .bucket
> +                    .clone()
> +                    .ok_or_else(|| format_err!("missing bucket for s3 backend"))?;
> +
> +                let (config, _config_digest) = pbs_config::s3::config()?;
> +                let (secrets, _secrets_digest) = pbs_config::s3::secrets_config()?;
> +                let config: S3ClientConfig = config.lookup("s3client", s3_client_id)?;
> +                let secrets: S3ClientSecretsConfig = secrets.lookup("s3secrets", s3_client_id)?;

Same thing here with regards to the hard-coded section type names.

> +
> +                let options =
> +                    S3ClientOptions::from_config(config, secrets, bucket, self.name().to_owned());
> +                let s3_client = S3Client::new(options)?;
> +                DatastoreBackend::S3(Arc::new(s3_client))
> +            }
> +        };
> +
> +        Ok(backend_type)
> +    }
> +
>      pub fn lookup_datastore(
>          name: &str,
>          operation: Option<Operation>,
> @@ -383,6 +425,11 @@ impl DataStore {
>                  .parse_property_string(config.tuning.as_deref().unwrap_or(""))?,
>          )?;
>  
> +        let backend_config: DatastoreBackendConfig = serde_json::from_value(
> +            DatastoreBackendConfig::API_SCHEMA
> +                .parse_property_string(config.backend.as_deref().unwrap_or(""))?,
> +        )?;
> +
>          Ok(DataStoreImpl {
>              chunk_store,
>              gc_mutex: Mutex::new(()),
> @@ -391,6 +438,7 @@ impl DataStore {
>              chunk_order: tuning.chunk_order.unwrap_or_default(),
>              last_digest,
>              sync_level: tuning.sync_level.unwrap_or_default(),
> +            backend_config,
>          })
>      }
>  
> diff --git a/pbs-datastore/src/lib.rs b/pbs-datastore/src/lib.rs
> index ffd0d91b2..ca6fdb7d8 100644
> --- a/pbs-datastore/src/lib.rs
> +++ b/pbs-datastore/src/lib.rs
> @@ -204,6 +204,7 @@ pub use store_progress::StoreProgress;
>  mod datastore;
>  pub use datastore::{
>      check_backup_owner, ensure_datastore_is_mounted, get_datastore_mount_status, DataStore,
> +    DatastoreBackend,
>  };
>  
>  mod hierarchy;

-- 
- Lukas



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


  reply	other threads:[~2025-07-18  7:52 UTC|newest]

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