update example config

1 files changed, 17 insertions, 34 deletions

diff --git a/dev-tools/example-openslx.config b/dev-tools/example-openslx.config
index 42d30e07..996bde85 100644
--- a/dev-tools/example-openslx.config
+++ b/dev-tools/example-openslx.config
@@ -1,51 +1,34 @@
-# This file contains configuration how the dnbd3 provided read only basic image
-# should be injected and made writable by a local writable layer.
+# The openslx config will be placed in "/etc/openslx" in initramfs and copied
+# to "/opt/openslx/config" in the main rootfs image.
 
-# The openslx config will be placed in "/etc/openslx" in initramfs.
-
-# Location where this config file should be placed in the final booted template
-# system.
-SLX_CONFIGURATION_LOCATION='/opt/openslx/'
 # A comma separated list of dnbd3 server host names or ip addresses where
 # the read only image can be accessed. The first matching ip will be used.
-SLX_DNBD3_SERVERS='132.230.4.201,132.230.4.202,10.0.2.2'
-# dnbd3 image version to use.
-SLX_DNBD3_RID='0'
+SLX_DNBD3_SERVERS='10.1.1.1,10.1.1.2'
+# Path on remote dnbd3 server for basic readonly image.
+SLX_DNBD3_IMAGE='centos/centos-rootfs.qcow2'
+# DNBD3 image revision to use.
+SLX_DNBD3_RID='1'
 # Device name to which the read only image will be connected.
+# You probably don't need to change this, ever.
 SLX_DNBD3_DEVICE='/dev/dnbd0'
-# Path on remote dnbd3 server for basic readonly image.
-SLX_DNBD3_IMAGE='archLinux/archLinux.vmdk'
-# Partition identifier for the system partition, if empty the whole device will
-# be used (no partition assumed).
+# Partition identifier for the system partition within the qcow2 rootfs image
+# If empty the whole device will be used (no partition assumed).
 SLX_SYSTEM_PARTITION_IDENTIFIER='system'
 # Script to run and set the read only device.
 # (e.g. "lvm_scan && read_only_partition=/dev/centos/root")
 SLX_SYSTEM_PARTITION_PREPARATION_SCRIPT=''
-# Device to mount and save the writable binary diff to. If Empty or not found,
-# a ramdisk will be used as fallback.
-SLX_WRITABLE_DEVICE_IDENTIFIER=''
-# Time to wait for the writable device in seconds.
-SLX_WRITABLE_DEVICE_IDENTIFIER_TIMEOUT_IN_SECONDS=10
-# File path for binary difference file. If empty the whole device will be used.
-SLX_WRITABLE_DEVICE_STORAGE_FILE_PATH='storage.img'
-# NOTE: if the filesystem is any other than ext4, then the corresponding
-# filesystem tools have to be added to the initramfs manually. (use the dracut
-# --install parameter)
-SLX_WRITABLE_DEVICE_STORAGE_FILESYSTEM_CREATE_COMMAND='mkfs.ext4'
-SLX_WRITABLE_DEVICE_STORAGE_FILESYSTEM_CHECK_COMMAND='fsck.ext4'
-SLX_WRITABLE_DEVICE_STORAGE_MAXIMUM_FILE_SIZE_IN_MB='1000'
-# Indicates whether existing persistent file should be taken in account.
-SLX_WRITABLE_DEVICE_PERSISTENT='no'
+# Local device (HDD) to use as a scratch space to combine with the DNBD3 image
+# 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.
+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".
 SLX_GENERATE_FSTAB_SCRIPT='
 echo "/dev/mapper/root / btrfs subvol=root 0 0" >> "$NEWROOT/etc/fstab"
 '
-# Upper bound for ram usage for the binary diff. If empty all available ram
-# will be used.
-SLX_RAMDISK_SIZE_IN_KB=''
-# Specifies mount options for the final root location where we want to pivot
-# root in.
+# Specifies mount options for the final root location.
 SLX_MOUNT_ROOT_OPTIONS='-o subvol=root'
 # Path where all the logs should be placed.
 SLX_LOG_FILE_PATH='/var/log/openslx'