public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Hannes Laimer <h.laimer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v5 06/22] api2: admin: add (un)mount endpoint for removable datastores
Date: Wed, 17 Apr 2024 14:23:46 +0200	[thread overview]
Message-ID: <20240417122402.51956-7-h.laimer@proxmox.com> (raw)
In-Reply-To: <20240417122402.51956-1-h.laimer@proxmox.com>

Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
---
 pbs-api-types/src/maintenance.rs |   4 +
 src/api2/admin/datastore.rs      | 167 +++++++++++++++++++++++++++++--
 2 files changed, 163 insertions(+), 8 deletions(-)

diff --git a/pbs-api-types/src/maintenance.rs b/pbs-api-types/src/maintenance.rs
index a605cc17..56d6bcb5 100644
--- a/pbs-api-types/src/maintenance.rs
+++ b/pbs-api-types/src/maintenance.rs
@@ -77,6 +77,10 @@ pub struct MaintenanceMode {
 }
 
 impl MaintenanceMode {
+    pub fn new(ty: MaintenanceType, message: Option<String>) -> Self {
+        Self { ty, message }
+    }
+
     /// Used for deciding whether the datastore is cleared from the internal cache after the last
     /// task finishes, so all open files are closed.
     pub fn is_offline(&self) -> bool {
diff --git a/src/api2/admin/datastore.rs b/src/api2/admin/datastore.rs
index 35628c59..b11d1cdd 100644
--- a/src/api2/admin/datastore.rs
+++ b/src/api2/admin/datastore.rs
@@ -26,20 +26,20 @@ use proxmox_sortable_macro::sortable;
 use proxmox_sys::fs::{
     file_read_firstline, file_read_optional_string, replace_file, CreateOptions,
 };
-use proxmox_sys::{task_log, task_warn};
+use proxmox_sys::{task_log, task_warn, WorkerTaskContext};
 
 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, DataStoreListItem, DataStoreStatus, GarbageCollectionStatus, GroupListItem,
-    KeepOptions, Operation, PruneJobOptions, RRDMode, RRDTimeFrame, 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, PRIV_DATASTORE_READ, PRIV_DATASTORE_VERIFY,
-    UPID_SCHEMA, VERIFICATION_OUTDATED_AFTER_SCHEMA,
+    Counts, CryptMode, DataStoreConfig, DataStoreListItem, DataStoreStatus,
+    GarbageCollectionStatus, GroupListItem, KeepOptions, Operation, PruneJobOptions, RRDMode,
+    RRDTimeFrame, 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,
+    PRIV_DATASTORE_READ, PRIV_DATASTORE_VERIFY, UPID_SCHEMA, VERIFICATION_OUTDATED_AFTER_SCHEMA,
 };
 use pbs_client::pxar::{create_tar, create_zip};
 use pbs_config::CachedUserInfo;
@@ -2278,6 +2278,155 @@ pub async fn set_backup_owner(
     .await?
 }
 
+pub fn do_mount_device(
+    datastore: DataStoreConfig,
+    worker: Option<&dyn WorkerTaskContext>,
+) -> Result<(), Error> {
+    if let Some(uuid) = datastore.backing_device.as_ref() {
+        if pbs_datastore::is_datastore_available(&datastore) {
+            bail!("device '{uuid}' is already mounted");
+        }
+        let mount_point_path = std::path::Path::new(&datastore.path);
+        if let Some(worker) = worker {
+            task_log!(
+                worker,
+                "mounting '{uuid}' for store {} to '{}'",
+                datastore.name,
+                datastore.path
+            );
+        }
+        crate::tools::disks::mount_by_uuid(uuid, mount_point_path)?;
+
+        Ok(())
+    } else {
+        Err(format_err!(
+            "Datastore '{}' cannot be mounted because it is not removable.",
+            datastore.name
+        ))
+    }
+}
+
+#[api(
+    protected: true,
+    input: {
+        properties: {
+            store: {
+                schema: DATASTORE_SCHEMA,
+            },
+        }
+    },
+    returns: {
+        schema: UPID_SCHEMA,
+    },
+    access: {
+        permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT, false),
+    },
+)]
+/// Mount removable datastore.
+pub fn mount(store: String, rpcenv: &mut dyn RpcEnvironment) -> Result<Value, Error> {
+    let (section_config, _digest) = pbs_config::datastore::config()?;
+    let datastore: DataStoreConfig = section_config.lookup("datastore", &store)?;
+
+    if datastore.backing_device.is_none() {
+        bail!("datastore '{store}' is not removable");
+    }
+
+    let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
+    let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI;
+
+    let upid = WorkerTask::new_thread(
+        "mount-device",
+        Some(store),
+        auth_id.to_string(),
+        to_stdout,
+        move |worker| do_mount_device(datastore, Some(&worker)),
+    )?;
+
+    Ok(json!(upid))
+}
+
+fn do_unmount_device(
+    datastore: DataStoreConfig,
+    worker: Option<&dyn WorkerTaskContext>,
+) -> Result<(), Error> {
+    let mut active_operations = task_tracking::get_active_operations(&datastore.name)?;
+    let mut counter = 0;
+    while active_operations.read + active_operations.write > 0 {
+        if counter == 0 {
+            if let Some(worker) = worker {
+                if worker.abort_requested() {
+                    bail!("aborted, due to user request");
+                }
+                task_log!(
+                    worker,
+                    "cannot unmount yet, still {} read and {} write operations active",
+                    active_operations.read,
+                    active_operations.write
+                );
+            }
+            counter = 5000;
+        }
+        counter -= 1;
+        std::thread::sleep(std::time::Duration::from_millis(1));
+        active_operations = task_tracking::get_active_operations(&datastore.name)?;
+    }
+    crate::tools::disks::unmount_by_mountpoint(&datastore.path)?;
+
+    Ok(())
+}
+
+#[api(
+    protected: true,
+    input: {
+        properties: {
+            store: { schema: DATASTORE_SCHEMA },
+        },
+    },
+    returns: {
+        schema: UPID_SCHEMA,
+    },
+    access: {
+        permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY, true),
+    }
+)]
+/// Unmount a removable device that is associated with the datastore
+pub async fn unmount(
+    store: String,
+    rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Value, Error> {
+    let _lock = pbs_config::datastore::lock_config()?;
+    let (section_config, _digest) = pbs_config::datastore::config()?;
+    let datastore: DataStoreConfig = section_config.lookup("datastore", &store)?;
+
+    if datastore.backing_device.is_none() {
+        bail!("datastore '{}' is not removable", &store);
+    }
+    drop(_lock);
+
+    let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
+    let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI;
+
+    if let Ok(proxy_pid) = proxmox_rest_server::read_pid(pbs_buildcfg::PROXMOX_BACKUP_PROXY_PID_FN)
+    {
+        let sock = proxmox_rest_server::ctrl_sock_from_pid(proxy_pid);
+        let _ = proxmox_rest_server::send_raw_command(
+            sock,
+            &format!("{{\"command\":\"update-datastore-cache\",\"args\":\"{store}\"}}\n"),
+        )
+        .await;
+    }
+
+    let upid = WorkerTask::new_thread(
+        "unmount-device",
+        Some(store),
+        auth_id.to_string(),
+        to_stdout,
+        move |worker| do_unmount_device(datastore, Some(&worker)),
+    )?;
+
+    Ok(json!(upid))
+}
+
 #[sortable]
 const DATASTORE_INFO_SUBDIRS: SubdirMap = &[
     (
@@ -2316,6 +2465,7 @@ const DATASTORE_INFO_SUBDIRS: SubdirMap = &[
             .get(&API_METHOD_LIST_GROUPS)
             .delete(&API_METHOD_DELETE_GROUP),
     ),
+    ("mount", &Router::new().post(&API_METHOD_MOUNT)),
     (
         "namespace",
         // FIXME: move into datastore:: sub-module?!
@@ -2350,6 +2500,7 @@ const DATASTORE_INFO_SUBDIRS: SubdirMap = &[
             .delete(&API_METHOD_DELETE_SNAPSHOT),
     ),
     ("status", &Router::new().get(&API_METHOD_STATUS)),
+    ("unmount", &Router::new().post(&API_METHOD_UNMOUNT)),
     (
         "upload-backup-log",
         &Router::new().upload(&API_METHOD_UPLOAD_BACKUP_LOG),
-- 
2.39.2



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


  parent reply	other threads:[~2024-04-17 12:24 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-17 12:23 [pbs-devel] [PATCH proxmox-backup v5 00/22] add " Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 01/22] tools: add disks utility functions Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 02/22] datastore: add cache entry flag for droping it after last task Hannes Laimer
2024-04-18  5:12   ` Thomas Lamprecht
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 03/22] pbs-api-types: add backing-device to DataStoreConfig Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 04/22] disks: add UUID to partition info Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 05/22] add helper for checking if a removable datastore is available Hannes Laimer
2024-04-17 12:23 ` Hannes Laimer [this message]
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 07/22] api2: removable datastore creation Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 08/22] api2: disks list: add only-unused flag Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 09/22] pbs-api-types: use SchemaDeserializer for maintenance mode Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 10/22] pbs-api-types: add removable/is-available flag to DataStoreListItem Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 11/22] bin: manager: add (un)mount command Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 12/22] add auto-mounting for removable datastores Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 13/22] datastore: handle deletion of removable datastore properly Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 14/22] docs: add removable datastores section Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 15/22] ui: add partition selector form Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 16/22] ui: add removable datastore creation support Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 17/22] ui: add (un)mount button to summary Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 18/22] ui: display removable datastores in list Hannes Laimer
2024-04-17 12:23 ` [pbs-devel] [PATCH proxmox-backup v5 19/22] ui: utils: render unplugged datastores correctly Hannes Laimer
2024-04-17 12:24 ` [pbs-devel] [PATCH proxmox-backup v5 20/22] ui: utils: make parseMaintenanceMode more robust Hannes Laimer
2024-04-17 12:24 ` [pbs-devel] [PATCH proxmox-backup v5 21/22] ui: add datastore status mask for unplugged removable datastores Hannes Laimer
2024-04-17 12:24 ` [pbs-devel] [PATCH proxmox-backup v5 22/22] ui: maintenance: fix disable msg field if no type is selected Hannes Laimer

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=20240417122402.51956-7-h.laimer@proxmox.com \
    --to=h.laimer@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