From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id DC67F1FF56B
	for <inbox@lore.proxmox.com>; Fri, 19 Apr 2024 17:56:20 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id AA2EDE31B;
	Fri, 19 Apr 2024 17:56:19 +0200 (CEST)
From: Hannes Laimer <h.laimer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Fri, 19 Apr 2024 17:55:55 +0200
Message-Id: <20240419155606.112010-13-h.laimer@proxmox.com>
X-Mailer: git-send-email 2.39.2
In-Reply-To: <20240419155606.112010-1-h.laimer@proxmox.com>
References: <20240419155606.112010-1-h.laimer@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.146 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 POISEN_SPAM_PILL          0.1 Meta: its spam
 POISEN_SPAM_PILL_1        0.1 random spam to be learned in bayes
 POISEN_SPAM_PILL_3        0.1 random spam to be learned in bayes
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: [pbs-devel] [PATCH proxmox-backup v8 12/23] docs: add removable
 datastores section
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
 <pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
 <pbs-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>

Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
---
 docs/storage.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/storage.rst b/docs/storage.rst
index 4444c423..4018c959 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -165,6 +165,32 @@ following command creates a new datastore called ``store1`` on
   # proxmox-backup-manager datastore create store1 /backup/disk1/store1
 
 
+Removable Datastores
+^^^^^^^^^^^^^^^^^^^^
+Removable datastores have a ``backing-device`` associadted with them, they can be
+mounted and unmounted. Other than that they behave the same way a normal Datastore
+would.
+
+They can be created on already correctly formatted partitions, as with normal Datastores
+the partitions should be either ``ext4``, ``xfs`` or ``zfs``.
+
+They are mounted automatically when plugged in. It is possible to create a
+removable Datastore on one PBS and use it on mutiple, the device just has to be added
+on all as a removable Datastore. This can be done using the normal `Create Datastore`
+form, by checking **Removable datastore** and selecting the device. If the devcice
+already contains a datastore it'll just be added as a new Datastore to the PBS
+instance and will be mounted whenever plugged in. Unmounting has to be done through
+the UI by clicking "Unmount" on the summary page or using the CLI
+
+.. code-block:: console
+
+  # proxmox-backup-manager datastore unmount store1
+
+both will wait for any running tasks and unmount the device once the last finishes.
+
+All removable datastores will be mounted under ``/mnt/removable_datastore/<UUID>`` and the
+specified path is realative to that.
+
 Managing Datastores
 ^^^^^^^^^^^^^^^^^^^
 
-- 
2.39.2



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