README

   1 mclu (mini cluster) is a virtualization cluster manager.
   2
   3 The key features:
   4
   5  - Entirely command line driven.
   6
   7  - No required dependencies except libvirt and ssh.
   8
   9  - Only designed for tiny clusters (up to around 10 hosts).
  10
  11  - Nothing to install on the nodes except libvirtd and sshd.
  12
  13  - Single, simple configuration file.
  14
  15 Example commands
  16 ----------------------------------------------------------------------
  17
  18    mclu status                   Display status of the cluster
  19    mclu list                     List all virtual machines on the cluster
  20    mclu on ham0                  Switch on (wake-on-LAN) node 'ham0'
  21    mclu off ham0                 Power off node 'ham0' in the cluster
  22    mclu start ham0:vm            Start vm on node 'ham0'
  23    mclu stop ham0:*              Stop all VMs on node 'ham0'
  24    mclu migrate *:* ham2:        Live migrate all VMs to 'ham2'
  25    mclu build ham3:vm fedora-20  Build and run a new Fedora 20 VM on node 'ham3'
  26    mclu console ham3:fedora-20   Show me the serial console of a VM
  27    mclu viewer ham3:fedora-20    Show me the graphical console of a VM
  28    mclu info                     Print general configuration information
  29    mclu --help                   Print help on all commands
  30
  31 Configuration notes
  32 ----------------------------------------------------------------------
  33
  34 See `CONFIGURATION'.
  35
  36 Dependencies
  37 ----------------------------------------------------------------------
  38
  39 To get a full list of the required and optional dependencies, look at:
  40
  41  - configure.ac
  42  - mclu.spec.in
  43
  44 Building it
  45 ----------------------------------------------------------------------
  46
  47 If building straight from git, then do:
  48
  49   autoreconf -i
  50
  51 To build:
  52
  53   ./configure --prefix /usr --sysconfdir /etc
  54   make
  55
  56 To run without installing:
  57
  58  - Edit the configuration file (mclu.conf).
  59
  60  - Run commands such as:
  61
  62    ./run status
  63    ./run list
  64
  65 To install:
  66
  67  - sudo make install
  68
  69  - Edit the configuration file (/etc/mclu/mclu.conf).
  70
  71  - Run commands such as:
  72
  73    mclu status
  74    mclu list
  75
  76 Developer information
  77 ----------------------------------------------------------------------
  78
  79 The license is GPLv2+.
  80
  81 The git repo is:
  82
  83   http://git.annexia.org/?p=mclu.git;a=summary
  84
  85 There is no mclu mailing list.  Send patches to the virt-tools mailing list:
  86
  87   http://www.redhat.com/mailman/listinfo/virt-tools-list