Welcome to MCVirt’s documentation!¶
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.
- KVM virtualisation.
- Clustering with optional DRBD support.
MCVirt is implemented in Python, using the libvirt virtualisation library.
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¶
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 for other dependencies and system 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 for information on creating new users.
Configure the volume group that MCVirt will use to store virtual machine data:
$ mcvirt node --set-vm-vg <Volume Group>
See the configuration guide for further node configuration steps.
Create a VM:
$ mcvirt create --cpu-count 1 --memory 512 --disk-size 8000 test-vm
See the create/remove VMs, cluster, permissions and modifying VMs guides for further administrative instructions.
Start the VM:
$ mcvirt start test-vm
See the controlling VMs guide 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.
For information on developing on MCVirt, see the development documentation.
See the guide index for a full list of manuals
For more information, please feel free to contact us
API Documentation¶
Contents:
- mcvirt package
- Subpackages
- mcvirt.agent package
- mcvirt.auth package
- mcvirt.client package
- mcvirt.cluster package
- mcvirt.iso package
- mcvirt.node package
- mcvirt.parser_modules package
- Subpackages
- Submodules
- mcvirt.parser_modules.clear_method_lock_parser module
- mcvirt.parser_modules.cluster_parser module
- mcvirt.parser_modules.drbd_parser module
- mcvirt.parser_modules.group_parser module
- mcvirt.parser_modules.iso_parser module
- mcvirt.parser_modules.network_parser module
- mcvirt.parser_modules.node_parser module
- mcvirt.parser_modules.permission_parser module
- mcvirt.parser_modules.resync_parser module
- mcvirt.parser_modules.storage_parser module
- mcvirt.parser_modules.user_parser module
- mcvirt.parser_modules.verify_parser module
- mcvirt.parser_modules.watchdog_parser module
- Module contents
- mcvirt.rpc package
- Submodules
- mcvirt.rpc.certificate_generator module
- mcvirt.rpc.certificate_generator_factory module
- mcvirt.rpc.constants module
- mcvirt.rpc.daemon_lock module
- mcvirt.rpc.expose_method module
- mcvirt.rpc.lock module
- mcvirt.rpc.name_server module
- mcvirt.rpc.pyro_object module
- mcvirt.rpc.rpc_daemon module
- mcvirt.rpc.ssl_socket module
- Module contents
- mcvirt.storage package
- mcvirt.test package
- mcvirt.thread package
- mcvirt.virtual_machine package
- Subpackages
- Submodules
- mcvirt.virtual_machine.agent_connection module
- mcvirt.virtual_machine.disk_drive module
- mcvirt.virtual_machine.factory module
- mcvirt.virtual_machine.usb_device module
- mcvirt.virtual_machine.virtual_machine module
- mcvirt.virtual_machine.virtual_machine_config module
- Module contents
- Submodules
- mcvirt.argument_validator module
- mcvirt.bash-complete module
- mcvirt.build_man module
- mcvirt.config_file module
- mcvirt.constants module
- mcvirt.exceptions module
- mcvirt.libvirt_connector module
- mcvirt.logger module
- mcvirt.mcvirt-drbd module
- mcvirt.mcvirt_config module
- mcvirt.parser module
- mcvirt.syslogger module
- mcvirt.system module
- mcvirt.utils module
- mcvirt.version module
- Module contents
- Subpackages