update example config with partition stuff

1 files changed, 25 insertions, 2 deletions

diff --git a/dev-tools/example-openslx.config b/dev-tools/example-openslx.config
index 996bde85..a7b2d160 100644
--- a/dev-tools/example-openslx.config
+++ b/dev-tools/example-openslx.config
@@ -21,7 +21,30 @@ SLX_SYSTEM_PARTITION_PREPARATION_SCRIPT=''
 # to make it writable via device mapper. This can be an MBR type (e.g. 44) or
 # a GPT label. If empty, a RAMdisk will be used as a fallback.
 SLX_WRITABLE_DEVICE_IDENTIFIER='44'
-# Size of the RAMdisk to use as a scratch fallback.
+# This is a kind of partition table for the scratch device.
+# A line is composed of:
+#       <type>         <name> <size> <crypt>
+#
+# * Type can be 'thin-snapshot', 'thin-volume', 'snapshot' or 'linear'.
+# * Name is just a name of the device mapper device created.
+# * Size are precalculated on the writable device found, so percentages
+# are calculated on the total device size. Lower and upper bounds can
+# be set, these will be attributed in a first-come-first-serve manner
+# (with respect to line order).
+# * Crypt would encrypt the device mapper device with a temporary key. 
+# 0 to disable (default), 1 to enable. Currently does not support persistent
+# keys.
+# Example of a more advanced partition config:
+#		thin-snapshot   root    10G    1
+#		thin-volume     tmp     20G    0
+#		linear          data0   5-10G  1
+#		linear          data1   1-50%  1
+# There needs to be at least one snapshot device configured, if none are set
+# it will default to use the *entire* writable device as a thin-snapshot:
+SLX_WRITABLE_DEVICE_PARTITION_TABLE='
+	thin-snapshot     root    100%
+'
+# Size in MB of the RAMdisk to use as a scratch fallback.
 SLX_RAMDISK_SIZE_IN_MB=''
 # If empty we will end up in an empty fstab file. If you want to reuse the
 # original fstab (from the template system) provide a dummy script like "true".
@@ -30,5 +53,5 @@ echo "/dev/mapper/root / btrfs subvol=root 0 0" >> "$NEWROOT/etc/fstab"
 '
 # Specifies mount options for the final root location.
 SLX_MOUNT_ROOT_OPTIONS='-o subvol=root'
-# Path where all the logs should be placed.
+# Path where all the logs should be placed. Deprecated (kind of).
 SLX_LOG_FILE_PATH='/var/log/openslx'