Add CUSTOMIZE_DIR to personalize the installation
[ext/instance-debootstrap.git] / README
diff --git a/README b/README
index 271bdd7..99040bc 100644 (file)
--- a/README
+++ b/README
@@ -58,6 +58,9 @@ named 'defaults' in the source distribution for more details):
 - EXTRAPKGS: most OSes will need some extra packages installed to make
   them work nicely under Xen; the example file containts a few
   suggestions
+- CUSTOMIZE_DIR: a directory containing customization script for the instance.
+  (by default $sysconfdir/ganeti/instance-debootstrap.d) See "Customization of
+  the instance" below.
 - GENERATE_CACHE: if 'yes' (the default), the installation process will
   save and reuse a cache file to speed reinstalls (located under
   $localstatedir/cache/ganeti-instance-debootstrap)
@@ -75,6 +78,35 @@ is installed on, not the cluster master. This is indeed not a very good
 model of using this OS but currently the OS interface in ganeti is
 limiting.
 
+Customization of the instance
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If run-parts is in the os create script, and the CUSTOMIZE_DIR (by default
+$sysconfdir/ganeti/instance-debootstrap.d, /etc/ganeti/instance-debootstrap.d
+if you configured the os with --sysconfdir=/etc) directory exists any
+executable whose name matches the run-parts execution rules (quoting
+run-parts(8): the  names  must consist entirely of upper and lower case
+letters, digits, underscores, and hyphens) is executed to allow further
+personalization of the installation. The following environment variables are
+passed, in addition to the ones ganeti passes to the OS scripts:
+
+TARGET: directory in which the filesystem is mounted
+SUITE: suite installed by debootstrap (eg: lenny)
+ARCH: target architecture
+PARTITION_STYLE: style of the disk partitioning (see above)
+EXTRA_PKGS: extra packages installed by debootstrap
+BLOCKDEV: ganeti block device
+FSYSDEV: device in which the filesystem resides (the one mounted in TARGET)
+
+The scripts in CUSTOMIZE_DIR can exit with an error code to signal an error in
+the instance creation, should they fail.
+
+The scripts in CUSTOMIZE_DIR should not start any long-term processes or
+daemons using this directory, otherwise the installation will fail because it
+won't be able to umount the filesystem from the directory, and hand the
+instance back to Ganeti.
+
+
 Caching
 ~~~~~~~