Fix typo in manual and add README file.

[mclu.git] / README

diff --git a/README b/README
index affc5fe..7f7a344 100644 (file)
--- a/README
+++ b/README
@@ -1,99 +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 ansible (on the client only),
-   libvirt and ssh.
-
- - Nothing to install on the nodes except libvirtd and sshd.
-
- - Only designed for small clusters (up to around 10-20 hosts).
-
- - Simple configuration.
-
-Example commands
-----------------------------------------------------------------------
-
-   mclu status                   Display status of the cluster
-   mclu list                     List all virtual machines on the cluster
-   mclu on ham0                  Switch on (wake-on-LAN) node 'ham0'
-   mclu off ham0                 Power off 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
-
-Since the mclu cluster is based on an ansible "hosts group", you can
-also issue ansible commands, eg:
-
-   ansible cluster -u root -a "yum -y update"   Upgrade all nodes in the cluster
-   ansible cluster -m ping                      Ping all nodes
-
-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).
-
- - Add the hosts group (usually called '[cluster]') to /etc/ansible/hosts.
-   You can set $ANSIBLE_HOSTS to change the location of this file.
-
- - Run commands such as:
-
-   ./run status
-   ./run list
-
-To install:
-
- - sudo make install
-
- - Edit the configuration file (/etc/mclu/mclu.conf).
-
- - Add the hosts group (usually called '[cluster]') to /etc/ansible/hosts.
-
- - 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.