Update README to be more distribution-centric.

Describe where to find packages for kvm, libvirt, qemu-nbd and
nbd-client for RHEL/CentOS, Fedora Core and Ubuntu.  Defer to web
sites for kvm and libvirt for source-based installs.

Gratuitous whitespace and spelling cleanups.

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

1 files changed, 73 insertions, 39 deletions

diff --git a/README b/README
index 377ab60..99393d9 100644
--- a/README
+++ b/README
@@ -11,22 +11,60 @@ Or to update it, run "git pull" in the autocluster directory
 To setup a virtual cluster for SoFS with autocluster follow these steps:
 
 
- 1) download and install the latest kvm-userspace and kvm tools 
-    from http://kvm.qumranet.com/kvmwiki/Code
+ 1) Install kvm, libvirt, qemu-nbd and nbd-client.
 
-    You need a x86_64 Linux box to run this on. I use a Ubuntu Hardy
-    system. It also needs plenty of memory - at least 3G to run a SoFS
-    cluster.
+    For various distros:
 
-    You may also find you need a newer version of libvirt. If you get
-    an error when running create_base.sh about not handling a device
-    named 'sda' then you need a newer libvirt. Get it like this:
+    * RHEL/CentOS
 
-       git clone git://git.et.redhat.com/libvirt.git
+      For RHEL5/CentOS5, useful packages for both kvm and libvirt can
+      be found here:
 
-    When building it, you probably want to configure it like this:
+        http://www.lfarkas.org/linux/packages/centos/5/x86_64/
 
-       ./configure --without-xen --prefix=/usr
+      You will need to install a matching kmod-kvm package to get the
+      kernel module.
+
+      qemu-nbd is in the kvm package.
+
+      Unless you can find an RPM for nbd-client then you need to
+      download source from:
+ 
+        http://sourceforge.net/projects/nbd/
+
+      and build it.
+
+    * Fedora Core
+
+      Useful packages ship with Fedora Core 10 (Cambridge) and later.
+
+      qemu-nbd is in the kvm package.
+
+      nbd-client is in the nbd package.
+
+    - Ubuntu
+
+      Useful packages ship with Ubuntu 8.10 (Intrepid Ibex) and later.
+
+      qemu-ndb is in the kvm package but is called kvm-nbd, so you
+      need to set the QEMU_NBD configuration variable.
+
+      nbd-client is in the nbd-client package.
+
+    For other distributions you'll have to backport distro sources or
+    compile from upstream source as described below.
+
+    * For KVM see the "Downloads" and "Code" sections at:
+
+        http://www.linux-kvm.org/
+
+    * For libvirt see:
+
+        http://libvirt.org/
+
+    * As mentioned about, nbd can be found at:
+
+        http://sourceforge.net/projects/nbd/
 
     You will need to configure the right kvm networking setup. The
     files in host_setup/etc/libvirt/qemu/networks/ should help. This
@@ -34,7 +72,7 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
 
        rsync -av --delete host_setup/etc/libvirt/qemu/networks/ /etc/libvirt/qemu/networks/
 
- 2) You need a cacheing web proxy on your local network. If you don't
+ 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
     virtual cluster. Make sure it caches large objects and has plenty
@@ -43,22 +81,18 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
 
     To test your squid setup, run a command like this:
 
-      http_proxy=http://10.0.0.1:3128/ wget http://9.155.61.11/mediasets/SoFS-daily/
+      http_proxy=http://10.0.0.1:3128/ wget <some-url>
 
-
- 3) setup a DNS server on your host. See host_setup/etc/bind/ for a
+ 3) Setup a DNS server on your host. See host_setup/etc/bind/ for a
     sample config that is suitable. It needs to redirect DNS queries
     for your SOFS virtual domain to your windows domain controller
 
+ 4) Download a RHEL install ISO.
 
- 4) download a RHEL-5.2 install ISO. You can get it from the install
-    server in Mainz. See the FSCC wiki page on autocluster for
-    details.
-
- 5) create a 'config' file in the autocluster directory.  See the
+ 5) Create a 'config' file in the autocluster directory.  See the
     "CONFIGURATION" section below for more details.
 
- 6) use "./autocluster create base" to create the base install image.
+ 6) Use "./autocluster create base" to create the base install image.
     The install will take about 10 to 15 minutes and you will see the
     packages installing in your terminal
 
@@ -67,7 +101,7 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
     https://9.155.61.11 with a web browser)
 
 
- 7) when that has finished I recommend you mark that base image
+ 7) When that has finished I recommend you mark that base image
     immutable like this:
 
       chattr +i /virtual/SoFS-1.5-base.img
@@ -77,7 +111,7 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
     it changes your cluster will become corrupt
 
 
- 8) now run "./autocluster create cluster" specifying a cluster
+ 8) Now run "./autocluster create cluster" specifying a cluster
     name. For example:
 
       ./autocluster create cluster c1
@@ -85,41 +119,41 @@ To setup a virtual cluster for SoFS with autocluster follow these steps:
     That will create your cluster nodes and the TSM server node
 
 
- 9) now boot your cluster nodes like this:
+ 9) Now boot your cluster nodes like this:
 
-       ./vircmd start c1
+      ./vircmd start c1
 
-   The most useful vircmd commands are:
+    The most useful vircmd commands are:
  
-       start    : boot a node
-       shutdown : graceful shutdown of a node
-       destroy  : power off a node immediately
+      start    : boot a node
+      shutdown : graceful shutdown of a node
+      destroy  : power off a node immediately
 
 
- 10) you can watch boot progress like this:
+ 10) You can watch boot progress like this:
 
        tail -f /var/log/kvm/serial.c1*
 
-    All the nodes have serial consoles, making it easier to capture
-    kernel panic messages and watch the nodes via ssh
+     All the nodes have serial consoles, making it easier to capture
+     kernel panic messages and watch the nodes via ssh
 
 
- 11) now you can ssh into your nodes. You may like to look at the
+ 11) Now you can ssh into your nodes. You may like to look at the
      small set of scripts in /root/scripts on the nodes for
      some scripts. In particular:
 
-      setup_tsm_server.sh:  run this on the TSM node to setup the TSM server
-      setup_tsm_client.sh:  run this on the GPFS nodes to setup HSM
-      mknsd.sh           :  this sets up the local shared disks as GPFS NSDs
-      setup_gpfs.sh      :  this sets GPFS, creates a filesystem etc,
-                            byppassing the SoFS GUI. Useful for quick tests.
+       setup_tsm_server.sh:  run this on the TSM node to setup the TSM server
+       setup_tsm_client.sh:  run this on the GPFS nodes to setup HSM
+       mknsd.sh           :  this sets up the local shared disks as GPFS NSDs
+       setup_gpfs.sh      :  this sets GPFS, creates a filesystem etc,
+                             byppassing the SoFS GUI. Useful for quick tests.
 
 
  12) If using the SoFS GUI, then you may want to lower the memory it
      uses so that it fits easily on the first node. Just edit this
      file on the first node:
 
-          /opt/IBM/sofs/conf/overrides/sofs.javaopt
+       /opt/IBM/sofs/conf/overrides/sofs.javaopt
 
 
  13) For automating the SoFS GUI, you may wish to install the iMacros