From d1a1d6714c79c245ece611b6f48137a654e4a827 Mon Sep 17 00:00:00 2001 From: Thomas Hipp Date: Sun, 4 Feb 2024 19:59:23 +0100 Subject: [PATCH] doc/reference: Add `security.shared` config key Signed-off-by: Thomas Hipp --- doc/reference/storage_btrfs.md | 1 + doc/reference/storage_ceph.md | 1 + doc/reference/storage_cephfs.md | 1 + doc/reference/storage_dir.md | 1 + doc/reference/storage_lvm.md | 1 + doc/reference/storage_zfs.md | 1 + 6 files changed, 6 insertions(+) diff --git a/doc/reference/storage_btrfs.md b/doc/reference/storage_btrfs.md index bc9d977ef79..2734a155905 100644 --- a/doc/reference/storage_btrfs.md +++ b/doc/reference/storage_btrfs.md @@ -72,6 +72,7 @@ Key | Type | Default | Descr Key | Type | Condition | Default | Description :-- | :--- | :-------- | :------ | :---------- +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume `size` | string | appropriate driver | same as `volume.size` | Size/quota of the storage volume diff --git a/doc/reference/storage_ceph.md b/doc/reference/storage_ceph.md index 5958da7ffcb..84fa6e53b71 100644 --- a/doc/reference/storage_ceph.md +++ b/doc/reference/storage_ceph.md @@ -100,6 +100,7 @@ Key | Type | Condition | Default :-- | :--- | :-------- | :------ | :---------- `block.filesystem` | string | block-based volume with content type `filesystem` | same as `volume.block.filesystem` | {{block_filesystem}} `block.mount_options` | string | block-based volume with content type `filesystem` | same as `volume.block.mount_options` | Mount options for block-backed file system volumes +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume `size` | string | | same as `volume.size` | Size/quota of the storage volume diff --git a/doc/reference/storage_cephfs.md b/doc/reference/storage_cephfs.md index 4dc5bec1a1e..87960d11e7a 100644 --- a/doc/reference/storage_cephfs.md +++ b/doc/reference/storage_cephfs.md @@ -77,6 +77,7 @@ Key | Type | Default Key | Type | Condition | Default | Description :-- | :--- | :-------- | :------ | :---------- +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume `size` | string | appropriate driver | same as `volume.size` | Size/quota of the storage volume diff --git a/doc/reference/storage_dir.md b/doc/reference/storage_dir.md index 875dcb87920..f4b79c54035 100644 --- a/doc/reference/storage_dir.md +++ b/doc/reference/storage_dir.md @@ -37,6 +37,7 @@ Key | Type | Default Key | Type | Condition | Default | Description :-- | :--- | :-------- | :------ | :---------- +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume `size` | string | appropriate driver | same as `volume.size` | Size/quota of the storage volume diff --git a/doc/reference/storage_lvm.md b/doc/reference/storage_lvm.md index 69b2dc0146e..5fd40442df9 100644 --- a/doc/reference/storage_lvm.md +++ b/doc/reference/storage_lvm.md @@ -67,6 +67,7 @@ Key | Type | Condition `lvm.stripes.size` | string | | same as `volume.lvm.stripes.size` | Size of stripes to use (at least 4096 bytes and multiple of 512 bytes) `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `size` | string | | same as `volume.size` | Size/quota of the storage volume `snapshots.expiry` | string | custom volume | same as `volume.snapshots.expiry` | {{snapshot_expiry_format}} `snapshots.pattern` | string | custom volume | same as `volume.snapshots.pattern` or `snap%d` | {{snapshot_pattern_format}} [^*] diff --git a/doc/reference/storage_zfs.md b/doc/reference/storage_zfs.md index 2fa75cabb80..543247725b1 100644 --- a/doc/reference/storage_zfs.md +++ b/doc/reference/storage_zfs.md @@ -109,6 +109,7 @@ Key | Type | Condition | Default :-- | :--- | :-------- | :------ | :---------- `block.filesystem` | string | block-based volume with content type `filesystem` (`zfs.block_mode` enabled) | same as `volume.block.filesystem` | {{block_filesystem}} `block.mount_options` | string | block-based volume with content type `filesystem` (`zfs.block_mode` enabled) | same as `volume.block.mount_options` | Mount options for block-backed file system volumes +`security.shared` | bool | custom block volume | same as `volume.security.shared` or `false` | Enable sharing the volume across multiple instances `security.shifted` | bool | custom volume | same as `volume.security.shifted` or `false` | {{enable_ID_shifting}} `security.unmapped` | bool | custom volume | same as `volume.security.unmapped` or `false` | Disable ID mapping for the volume `size` | string | | same as `volume.size` | Size/quota of the storage volume