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