Updates to README.
authorMartin Schwenke <martin@meltin.net>
Wed, 13 May 2009 23:34:20 +0000 (09:34 +1000)
committerMartin Schwenke <martin@meltin.net>
Wed, 13 May 2009 23:35:56 +0000 (09:35 +1000)
Better advice on libvirt configuration and constructing a autocluster
configuration file.

Signed-off-by: Martin Schwenke <martin@meltin.net>
README

diff --git a/README b/README
index c566aee0c12e1aec7a221926d22eab896867cbb2..47379c241ad31c5b1d28b84f631f5661a29bfcc0 100644 (file)
--- a/README
+++ b/README
@@ -49,7 +49,7 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
 
       nbd-client is in the nbd package.
 
-    - Ubuntu
+    * Ubuntu
 
       Useful packages ship with Ubuntu 8.10 (Intrepid Ibex) and later.
 
@@ -73,12 +73,26 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
 
         http://sourceforge.net/projects/nbd/
 
+    You will need to add the autocluster directory to your PATH.
+
     You will need to configure the right kvm networking setup. The
     files in host_setup/etc/libvirt/qemu/networks/ should help. This
     command will install the right networks for kvm:
 
        rsync -av --delete host_setup/etc/libvirt/qemu/networks/ /etc/libvirt/qemu/networks/
 
+    After this you might need to reload libvirt:
+
+      /etc/init.d/libvirt reload
+
+    or similar.
+
+    You might also need to set:
+
+      VIRSH_DEFAULT_CONNECT_URI=qemu:///system
+
+    in your environment so that virsh does KVM/QEMU things by default.
+
  2) You need a caching web proxy on your local network. If you don't
     have one, then install a squid proxy on your host. See
     host_setup/etc/squid/squid.conf for a sample config suitable for a
@@ -183,11 +197,17 @@ CONFIGURATION
   - all the items listed under "configuration options:" are the
   equivalents of the settings for config files.
 
-* Run "autocluster --dump > config.foo" (or similar) to create a
-  config file containing the default values for all options that you
-  can set.  You can then delete all options for which you wish to keep
-  the default values and then modify the remaining ones, resulting in
-  a relatively small config file.
+* Run "autocluster --dump > config.defaults" (or similar) to create a
+  file containing the default values for all options that you can set.
+  I don't recommend that you use this as a configuration file but it
+  can be handy as a reference.
+
+  I recommend that you aim for the smallest possible configuration
+  file.  Perhaps start with:
+
+    FIRSTIP=<whatever>
+
+  and move on from there.
 
 * Use the --with-release option on the command-line or the
   with_release function in a configuration file to get default values
@@ -203,6 +223,10 @@ CONFIGURATION
 
     with_release "SoFS-1.5.3"
 
+  So the smallest possible config file would have something like this
+  as the first line and would then set FIRSTIP.  Add other options as
+  you need them.
+
   The release definitions are stored in releases/*.release.  The
   available releases are listed in the output of "autocluster --help".