[pve-devel] [PATCH docs] storage: more documentation for content-dirs

Leo Nunner l.nunner at proxmox.com
Wed Jun 7 15:32:16 CEST 2023


give an overview over vtypes and also document the option for
cephfs.

Signed-off-by: Leo Nunner <l.nunner at proxmox.com>
---
 pve-storage-cephfs.adoc |  4 ++++
 pve-storage-dir.adoc    | 20 ++++++++++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/pve-storage-cephfs.adoc b/pve-storage-cephfs.adoc
index c10976b..6873660 100644
--- a/pve-storage-cephfs.adoc
+++ b/pve-storage-cephfs.adoc
@@ -57,6 +57,10 @@ fuse::
 Access CephFS through FUSE, instead of the kernel client. Optional, defaults
 to `0`.
 
+content-dirs::
+
+Overrides for the default directory layout. Optional.
+
 .Configuration example for an external Ceph cluster (`/etc/pve/storage.cfg`)
 ----
 cephfs: cephfs-external
diff --git a/pve-storage-dir.adoc b/pve-storage-dir.adoc
index 3367394..61dddeb 100644
--- a/pve-storage-dir.adoc
+++ b/pve-storage-dir.adoc
@@ -59,6 +59,26 @@ in the following format:
 Where `vtype` is one of the allowed content types for the storage, and
 `path` is a path relative to the mountpoint of the storage.
 
+.Overrides
+[width="100%",cols="d,m,m",options="header"]
+|===========================================================
+|Content type        |vtype     | Example
+|VM images           |`images`  | images=sub/dir
+|ISO images          |`iso`     | iso=sub/dir
+|Container templates |`vztmpl`  | vztmpl=sub/dir
+|Backup files        |`backup`  | backup=sub/dir
+|Snippets            |`sinppet` | snippet=sub/dir
+|===========================================================
+
+So an override for VM images would look like `images=dir/path`, an
+override for ISO images like `iso=dir/path` etc. They can also be
+combined in a list:
+
+----
+content-dirs images=dir/path,iso=dir/path
+----
+
+
 .Configuration Example (`/etc/pve/storage.cfg`)
 ----
 dir: backup
-- 
2.30.2






More information about the pve-devel mailing list