X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;ds=sidebyside;f=README;h=7f7a3440d55398534abbd894aebd653b5c1ceee5;hb=cb034760e5b05e80ef3e26ed632223e3a00966d3;hp=f9feeb18847950393ecccc1c3d8b064fb46efe3f;hpb=50fd3ff80dbb76b1cf02e791cf8b3747ddaeeb7b;p=mclu.git diff --git a/README b/README index f9feeb1..7f7a344 100644 --- a/README +++ b/README @@ -1,87 +1,3 @@ -mclu (mini cluster) is a virtualization cluster manager. +Probably the simplest, smallest possible implementation of a cloud. -The key features: - - - Entirely command line driven. - - - No required dependencies except libvirt and ssh. - - - Only designed for tiny clusters (up to around 10 hosts). - - - Nothing to install on the nodes except libvirtd and sshd. - - - Single, simple configuration file. - -Example commands ----------------------------------------------------------------------- - - mclu status Display status of the cluster - mclu list List all virtual machines on the cluster - mclu wake ham0 Wake up node 'ham0' in the cluster - mclu shutdown ham0 Shut down node 'ham0' in the cluster - mclu start ham0:vm Start vm on node 'ham0' - mclu stop ham0:* Stop all VMs on node 'ham0' - mclu migrate *:* ham2: Live migrate all VMs to 'ham2' - mclu build ham3:vm fedora-20 Build and run a new Fedora 20 VM on node 'ham3' - mclu console ham3:fedora-20 Show me the serial console of a VM - mclu viewer ham3:fedora-20 Show me the graphical console of a VM - mclu info Print general configuration information - mclu --help Print help on all commands - -Configuration notes ----------------------------------------------------------------------- - -See `CONFIGURATION'. - -Dependencies ----------------------------------------------------------------------- - -To get a full list of the required and optional dependencies, look at: - - - configure.ac - - mclu.spec.in - -Building it ----------------------------------------------------------------------- - -If building straight from git, then do: - - autoreconf -i - -To build: - - ./configure --prefix /usr --sysconfdir /etc - make - -To run without installing: - - - Edit the configuration file (mclu.conf). - - - Run commands such as: - - ./run status - ./run list - -To install: - - - sudo make install - - - Edit the configuration file (/etc/mclu/mclu.conf). - - - Run commands such as: - - mclu status - mclu list - -Developer information ----------------------------------------------------------------------- - -The license is GPLv2+. - -The git repo is: - - http://git.annexia.org/?p=mclu.git;a=summary - -There is no mclu mailing list. Send patches to the virt-tools mailing list: - - http://www.redhat.com/mailman/listinfo/virt-tools-list +See mclu.pod for all documentation.