diff --git a/README.md b/README.md index db07b4a..7e64e0c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # KVM tools -This repository contain scripts for managing KVM hypervisors used with DRBD and LVM. +This repository contains scripts for managing +[KVM](https://www.linux-kvm.org/page/Main_Page) hypervisors using +[DRBD](http://drbd.org/) and +[LVM](https://en.wikipedia.org/wiki/Logical_Volume_Manager_%28Linux%29). It contains the following scripts. -- add-vm: create DBRD volumes and virtual machines. +- add-vm: create DRBD volumes and virtual machines. - vm-migrate: migrate a DRBD based virtual machine - kvmstats: gives informations about defined virtual machines. -## Install +## Installation Copy the scripts to /usr/local/sbin: @@ -17,16 +20,18 @@ install -m 0755 add-vm /usr/local/sbin/add-vm install -m 0755 kvmstats /usr/local/sbin/kvmstats ~~~ -Edit configuration in /etc/evolinux/add-vm.cnf: +Edit the configuration in /etc/evolinux/add-vm.cnf: ~~~ masterKVMIP=192.168.0.X slaveKVMIP=192.168.0.Y ~~~ -Script add-vm assume you have two LVM Volume Group named "ssd" and "hdd". +Script add-vm assumes you have two LVM Volume Groups named "ssd" +and "hdd". -You can override this by adding a Bash array in /etc/evolinux/add-vm.cnf, eg: +You can override this by adding a bash(1) array in +/etc/evolinux/add-vm.cnf, eg: ~~~ disks=("VG1" "VG2") @@ -34,7 +39,8 @@ disks=("VG1" "VG2") ## Dry-run mode -You can use the dry-run mode by setting doDryRun var in config file: +You can use the dry-run mode by setting the doDryRun variable in +/etc/evolinux/add-vm.cnf:: ~~~ doDryRun=true @@ -44,4 +50,5 @@ doDryRun=true ## License -This project is an [Evolix](https://evolix.com) project and is licensed under GPLv3, see the [LICENSE](LICENSE) file for details. +This is an [Evolix](https://evolix.com) project and is licensed +under the GPLv3, see the [LICENSE](LICENSE) file for details.