[pve-devel] [PATCH docs] docs: document 'dirs' parameter for directory storage
Leo Nunner
l.nunner at proxmox.com
Thu Dec 15 12:21:47 CET 2022
Signed-off-by: Leo Nunner <l.nunner at proxmox.com>
---
pve-storage-cifs.adoc | 4 ++++
pve-storage-dir.adoc | 19 ++++++++++++++-----
pve-storage-nfs.adoc | 4 ++++
3 files changed, 22 insertions(+), 5 deletions(-)
diff --git a/pve-storage-cifs.adoc b/pve-storage-cifs.adoc
index bb4b902..4d93727 100644
--- a/pve-storage-cifs.adoc
+++ b/pve-storage-cifs.adoc
@@ -57,6 +57,10 @@ path::
The local mount point. Optional, defaults to `/mnt/pve/<STORAGE_ID>/`.
+dirs::
+
+Overrides for the default directory layout. Optional.
+
.Configuration Example (`/etc/pve/storage.cfg`)
----
cifs: backup
diff --git a/pve-storage-dir.adoc b/pve-storage-dir.adoc
index 4116fe5..ec1b957 100644
--- a/pve-storage-dir.adoc
+++ b/pve-storage-dir.adoc
@@ -46,9 +46,18 @@ storage backends.
Configuration
~~~~~~~~~~~~~
-This backend supports all common storage properties, and adds an
-additional property called `path` to specify the directory. This
-needs to be an absolute file system path.
+This backend supports all common storage properties, and adds two
+additional properties. The `path` property is used to specify the
+directory. This needs to be an absolute file system path.
+
+The optional `dirs` property allows for the default layout to be
+changed. It consists of a comma-separated list of identifiers in
+the following format:
+
+ vtype:path
+
+Where `vtype` is one of the allowed content types for the storage, and
+`path` is an absolute file system path.
.Configuration Example (`/etc/pve/storage.cfg`)
----
@@ -57,12 +66,12 @@ dir: backup
content backup
prune-backups keep-last=7
max-protected-backups 3
+ dirs backup:/custom/backup/dir
----
The above configuration defines a storage pool called `backup`. That pool can be
used to store up to 7 regular backups (`keep-last=7`) and 3 protected backups
-per VM. The real path for the backup files is `/mnt/backup/dump/...`.
-
+per VM. The real path for the backup files is `/mnt/backup/custom/backup/dir/...`.
File naming conventions
~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/pve-storage-nfs.adoc b/pve-storage-nfs.adoc
index 9a90057..95ee45d 100644
--- a/pve-storage-nfs.adoc
+++ b/pve-storage-nfs.adoc
@@ -40,6 +40,10 @@ path::
The local mount point (defaults to `/mnt/pve/<STORAGE_ID>/`).
+dirs::
+
+Overrides for the default directory layout. Optional.
+
options::
NFS mount options (see `man nfs`).
--
2.30.2
More information about the pve-devel
mailing list