From eeaaf95c9475f806a95a85b5f57664d296c71dba Mon Sep 17 00:00:00 2001
From: torben
Date: Thu, 24 Mar 2016 17:42:23 +0100
Subject: Improve openslx config file.

---
 dev-tools/example-openslx.config | 41 ++++++++++++++++++++++++++++++++--------
 1 file changed, 33 insertions(+), 8 deletions(-)

(limited to 'dev-tools/example-openslx.config')

diff --git a/dev-tools/example-openslx.config b/dev-tools/example-openslx.config
index 47d37c43..57197eec 100644
--- a/dev-tools/example-openslx.config
+++ b/dev-tools/example-openslx.config
@@ -1,25 +1,50 @@
+# 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.
+
+# Location where this config file should be placed in 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 should be provided. 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'
+# Device name where the read only image should be injected.
 SLX_DNBD3_DEVICE='/dev/dnbd0'
+# Path on remote dnbd3 server for basic readonly image.
 SLX_DNBD3_IMAGE='archLinux/archLinux.vmdk'
-# If empty the whole device is used
+# Partition identifier for the system partition, 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 difference fill in. Empty means
+# no writable device should be injected and ram will be used as fallback.
 SLX_WRITABLE_DEVICE_IDENTIFIER=''
-SLX_WRITABLE_DEVICE_IDENTIFIER_TIMEOUT=''
-SLX_WRITABLE_DEVICE_STORAGE_FILE='storage.img'
+# Time to wait for the writable device in seconds.
+SLX_WRITABLE_DEVICE_IDENTIFIER_TIMEOUT_IN_SECONDS=10
+# File path for binary difference file.
+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_FILSYSTEM_CREATE_COMMAND='mkfs.ext4'
-SLX_WRITABLE_DEVICE_STORAGE_FILSYSTEM_CHECK_COMMAND='fsck.ext4'
-SLX_WRITABLE_DEVICE_STORAGE_FILE_MAX_SIZE_MB='1000'
+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'
 # 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"
 '
-# if empty will use all available ram
-SLX_RAMDISK_SIZE=''
+# Upper bound for ram using. 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.
 SLX_MOUNT_ROOT_OPTIONS='-o subvol=root'
+# Path where all the logs should be placed.
+SLX_LOG_FILE_PATH='/var/log/openslx'
-- 
cgit v1.2.3-55-g7522