====== MCVirt - Managed Consistent Virtualisation

MCVirt (em-see-vert) - Command line virtual machine management utility.

Description

MCVirt is a utility for managing virtual machines, supporting the following technologies:

Ubuntu 14.04 LTS <http://www.ubuntu.com/download/server>_.
KVM virtualisation <http://www.linux-kvm.org/page/Main_Page>_.
Clustering with optional DRBD <http://drbd.linbit.com/>_ support.

MCVirt is implemented in Python, using the libvirt virtualisation library <http://libvirt.org>_.

MASTER BRANCH WARNING

The master branch generally continues the current development of an upcoming release.

Use the releases to obtain the latest stable release

Getting started

Installation

MCVirt must currently be built from source into a deb package, using the build script. The package and dependencies can then be installed::

$ ./build.sh $ sudo dpkg -i mcvirt_*_all.deb $ sudo apt-get -f install

See the installation guide <Documentation/Installation.rst>_ for other dependencies and system configuration.

Configuration

Start the MCVirt nameserver and daemon by running::

$ sudo service mcvirt-ns start $ sudo service mcvirtd start

Most commands require a username and password to the MCVirt daemon. During installation a superuser is created with username mjc and password pass - see permissions <Documentation/Permissions.rst>_ for information on creating new users.

Configure the volume group that MCVirt will use to store virtual machine data::

$ mcvirt node --set-vm-vg

See the configuration guide <Documentation/Configuration.rst>_ for further node configuration steps.

Usage

Create a VM::

$ mcvirt create --cpu-count 1 --memory 512 --disk-size 8000 test-vm

See the create/remove VMs <Documentation/CreateRemoveVMs.rst>, cluster <Documentation/Cluster.rst>, permissions <Documentation/Permissions.rst> and modifying VMs <Documentation/ModifyingVMs.rst> guides for further administrative instructions.

Start the VM::

$ mcvirt start test-vm

See the controlling VMs guide <Documentation/ControllingVMs.rst>_ for further user instructions.

Note: Username and password can be provided on the command line with the --username and --password options to instead of typing them in after every command.

Development

For information on developing on MCVirt, see the development documentation <Documentation/Development.rst>_.

Further information

See the guide index <Documentation/MCVirt.rst>_ for a full list of manuals

For more information, please feel free to contact us <https://www.itdev.co.uk/Contact/>_

LICENSE

MCVirt is licensed under GPL v2. For more information, please see LICENSE <LICENSE>_

ITDevLtd / MCVirt

readme