[pbs-devel] [PATCH v3 proxmox-backup 32/33] api: datastore/namespace: return backup groups delete stats on remove
Fabian Grünbichler
f.gruenbichler at proxmox.com
Fri Oct 11 11:32:49 CEST 2024
On September 12, 2024 4:33 pm, Christian Ebner wrote:
> Add and expose the backup group delete statistics by adding the
> return type to the corresponding REST API endpoints.
>
> Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
> ---
> changes since version 2:
> - no changes
>
> pbs-datastore/src/datastore.rs | 20 ++++++++++++++------
> src/api2/admin/datastore.rs | 18 ++++++++++--------
> src/api2/admin/namespace.rs | 20 +++++++++++---------
> src/server/pull.rs | 6 ++++--
> 4 files changed, 39 insertions(+), 25 deletions(-)
>
> diff --git a/pbs-datastore/src/datastore.rs b/pbs-datastore/src/datastore.rs
> index c8701d2dd..68c7f2934 100644
> --- a/pbs-datastore/src/datastore.rs
> +++ b/pbs-datastore/src/datastore.rs
> @@ -489,16 +489,22 @@ impl DataStore {
> ///
> /// Does *not* descends into child-namespaces and doesn't remoes the namespace itself either.
> ///
> - /// Returns true if all the groups were removed, and false if some were protected.
> - pub fn remove_namespace_groups(self: &Arc<Self>, ns: &BackupNamespace) -> Result<bool, Error> {
> + /// Returns a tuple with the first item being true if all the groups were removed, and false if some were protected.
> + /// The second item returns the remove statistics.
> + pub fn remove_namespace_groups(
> + self: &Arc<Self>,
> + ns: &BackupNamespace,
> + ) -> Result<(bool, BackupGroupDeleteStats), Error> {
> // FIXME: locking? The single groups/snapshots are already protected, so may not be
> // necessary (depends on what we all allow to do with namespaces)
> log::info!("removing all groups in namespace {}:/{ns}", self.name());
>
> let mut removed_all_groups = true;
> + let mut stats = BackupGroupDeleteStats::default();
>
> for group in self.iter_backup_groups(ns.to_owned())? {
> let delete_stats = group?.destroy()?;
> + stats.add(&delete_stats);
> removed_all_groups = removed_all_groups && delete_stats.all_removed();
> }
>
> @@ -515,7 +521,7 @@ impl DataStore {
> }
> }
>
> - Ok(removed_all_groups)
> + Ok((removed_all_groups, stats))
> }
>
> /// Remove a complete backup namespace optionally including all it's, and child namespaces',
> @@ -527,13 +533,15 @@ impl DataStore {
> self: &Arc<Self>,
> ns: &BackupNamespace,
> delete_groups: bool,
> - ) -> Result<bool, Error> {
> + ) -> Result<(bool, BackupGroupDeleteStats), Error> {
> let store = self.name();
> let mut removed_all_requested = true;
> + let mut stats = BackupGroupDeleteStats::default();
> if delete_groups {
> log::info!("removing whole namespace recursively below {store}:/{ns}",);
> for ns in self.recursive_iter_backup_ns(ns.to_owned())? {
> - let removed_ns_groups = self.remove_namespace_groups(&ns?)?;
> + let (removed_ns_groups, delete_stats) = self.remove_namespace_groups(&ns?)?;
> + stats.add(&delete_stats);
> removed_all_requested = removed_all_requested && removed_ns_groups;
> }
> } else {
> @@ -574,7 +582,7 @@ impl DataStore {
> }
> }
>
> - Ok(removed_all_requested)
> + Ok((removed_all_requested, stats))
> }
>
> /// Remove a complete backup group including all snapshots.
> diff --git a/src/api2/admin/datastore.rs b/src/api2/admin/datastore.rs
> index 0a5af1e76..49ff9abf0 100644
> --- a/src/api2/admin/datastore.rs
> +++ b/src/api2/admin/datastore.rs
> @@ -34,10 +34,10 @@ use pxar::accessor::aio::Accessor;
> use pxar::EntryKind;
>
> use pbs_api_types::{
> - print_ns_and_snapshot, print_store_and_ns, Authid, BackupContent, BackupNamespace, BackupType,
> - Counts, CryptMode, DataStoreConfig, DataStoreListItem, DataStoreStatus,
> - GarbageCollectionJobStatus, GroupListItem, JobScheduleStatus, KeepOptions, Operation,
> - PruneJobOptions, SnapshotListItem, SnapshotVerifyState, BACKUP_ARCHIVE_NAME_SCHEMA,
> + print_ns_and_snapshot, print_store_and_ns, Authid, BackupContent, BackupGroupDeleteStats,
> + BackupNamespace, BackupType, Counts, CryptMode, DataStoreConfig, DataStoreListItem,
> + DataStoreStatus, GarbageCollectionJobStatus, GroupListItem, JobScheduleStatus, KeepOptions,
> + Operation, PruneJobOptions, SnapshotListItem, SnapshotVerifyState, BACKUP_ARCHIVE_NAME_SCHEMA,
> BACKUP_ID_SCHEMA, BACKUP_NAMESPACE_SCHEMA, BACKUP_TIME_SCHEMA, BACKUP_TYPE_SCHEMA,
> DATASTORE_SCHEMA, IGNORE_VERIFIED_BACKUPS_SCHEMA, MAX_NAMESPACE_DEPTH, NS_MAX_DEPTH_SCHEMA,
> PRIV_DATASTORE_AUDIT, PRIV_DATASTORE_BACKUP, PRIV_DATASTORE_MODIFY, PRIV_DATASTORE_PRUNE,
> @@ -269,6 +269,9 @@ pub fn list_groups(
> },
> },
> },
> + returns: {
> + type: BackupGroupDeleteStats,
> + },
> access: {
> permission: &Permission::Anybody,
> description: "Requires on /datastore/{store}[/{namespace}] either DATASTORE_MODIFY for any \
> @@ -281,7 +284,7 @@ pub async fn delete_group(
> ns: Option<BackupNamespace>,
> group: pbs_api_types::BackupGroup,
> rpcenv: &mut dyn RpcEnvironment,
> -) -> Result<Value, Error> {
> +) -> Result<BackupGroupDeleteStats, Error> {
> let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
>
> tokio::task::spawn_blocking(move || {
> @@ -299,10 +302,9 @@ pub async fn delete_group(
>
> let delete_stats = datastore.remove_backup_group(&ns, &group)?;
> if !delete_stats.all_removed() {
> - bail!("group only partially deleted due to protected snapshots");
> + warn!("group only partially deleted due to protected snapshots");
this not only changes the return type (from nothing to something
actionable, which is okay!) but also the behaviour..
right now with this series applied, if I remove a group with protected
snapshots, I get no indication on the UI that it failed to do so, and
the log message only ends up in journal since there is no task context
here..
I think this would at least warrant opt-in for the new behaviour? in any
case, the warning/error could probably be adapted to contain the counts
at least, now that we have them ;)
> }
> -
> - Ok(Value::Null)
> + Ok(delete_stats)
> })
> .await?
> }
> diff --git a/src/api2/admin/namespace.rs b/src/api2/admin/namespace.rs
> index 889dc1a3d..adf665717 100644
> --- a/src/api2/admin/namespace.rs
> +++ b/src/api2/admin/namespace.rs
> @@ -1,13 +1,12 @@
> -use anyhow::{bail, Error};
> -use serde_json::Value;
> +use anyhow::Error;
>
> use pbs_config::CachedUserInfo;
> use proxmox_router::{http_bail, ApiMethod, Permission, Router, RpcEnvironment};
> use proxmox_schema::*;
>
> use pbs_api_types::{
> - Authid, BackupNamespace, NamespaceListItem, Operation, DATASTORE_SCHEMA, NS_MAX_DEPTH_SCHEMA,
> - PROXMOX_SAFE_ID_FORMAT,
> + Authid, BackupGroupDeleteStats, BackupNamespace, NamespaceListItem, Operation,
> + DATASTORE_SCHEMA, NS_MAX_DEPTH_SCHEMA, PROXMOX_SAFE_ID_FORMAT,
> };
>
> use pbs_datastore::DataStore;
> @@ -151,22 +150,25 @@ pub fn delete_namespace(
> delete_groups: bool,
> _info: &ApiMethod,
> rpcenv: &mut dyn RpcEnvironment,
> -) -> Result<Value, Error> {
> +) -> Result<BackupGroupDeleteStats, Error> {
> let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
>
> check_ns_modification_privs(&store, &ns, &auth_id)?;
>
> let datastore = DataStore::lookup_datastore(&store, Some(Operation::Write))?;
>
> - if !datastore.remove_namespace_recursive(&ns, delete_groups)? {
> + let (removed_all, stats) = datastore.remove_namespace_recursive(&ns, delete_groups)?;
> + if !removed_all {
> if delete_groups {
> - bail!("group only partially deleted due to protected snapshots");
> + log::warn!("group only partially deleted due to protected snapshots");
> } else {
> - bail!("only partially deleted due to existing groups but `delete-groups` not true ");
> + log::warn!(
> + "only partially deleted due to existing groups but `delete-groups` not true"
> + );
same here
> }
> }
>
> - Ok(Value::Null)
> + Ok(stats)
> }
>
> pub const ROUTER: Router = Router::new()
> diff --git a/src/server/pull.rs b/src/server/pull.rs
> index 3117f7d2c..d7f5c42ea 100644
> --- a/src/server/pull.rs
> +++ b/src/server/pull.rs
> @@ -645,10 +645,12 @@ fn check_and_remove_ns(params: &PullParameters, local_ns: &BackupNamespace) -> R
> check_ns_modification_privs(params.target.store.name(), local_ns, ¶ms.owner)
> .map_err(|err| format_err!("Removing {local_ns} not allowed - {err}"))?;
>
> - params
> + let (removed_all, _delete_stats) = params
> .target
> .store
> - .remove_namespace_recursive(local_ns, true)
> + .remove_namespace_recursive(local_ns, true)?;
> +
> + Ok(removed_all)
> }
>
> fn check_and_remove_vanished_ns(
> --
> 2.39.2
>
>
>
> _______________________________________________
> pbs-devel mailing list
> pbs-devel at lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
>
>
>
More information about the pbs-devel
mailing list