[pbs-devel] [PATCH proxmox-backup v10 14/26] docs: add removable datastores section

[Max Carrara]

On Thu Apr 25, 2024 at 8:53 AM CEST, Hannes Laimer wrote:
> Signed-off-by: Hannes Laimer <h.laimer at proxmox.com>
> ---
>  docs/storage.rst | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>
> diff --git a/docs/storage.rst b/docs/storage.rst
> index 4444c423..0a2f8f8a 100644
> --- a/docs/storage.rst
> +++ b/docs/storage.rst
> @@ -165,6 +165,35 @@ 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`` associated 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, which, as with normal
> +datastores, should be either ``ext4`` or ``xfs``.  It is also possible to create them
> +on completely unused disks through "Admnistartion" > "Disks / Storage" > "Directory",

Typo here and wrong name here - should be:
  "Administration" > "Storage / Disks"

> +using this method the disk will be partitioned and formatted automatically for the datastore.
> +
> +They are mounted automatically when plugged in. It is possible to create a
> +removable datastore on one PBS and use it on multiple, 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**, selecting the device and setting the correct path.
> +If the device already contains a datastore at the specified path 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 to finish and unmount the device.
> +
> +All removable datastores are mounted under /mnt/datastore/<name>, and the specified path
> +refers to the path on the device.
> +
> +
>  Managing Datastores
>  ^^^^^^^^^^^^^^^^^^^
>