Skip to content

Commit 519b36d

Browse files
committed
Update README.md
1 parent d102b4f commit 519b36d

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
# upvm
2-
Leverage `virt-builder` & `virt-install` to spin up new VMs with ease
1+
# upvm - Leverage virt-builder & virt-install to spin up new VMs with ease
32

4-
### Install
3+
## What?
4+
upvm aims to make it crazy easy to spin up new virtual machines using pre-installed OS-images provided by existing [virt-builder](http://libguestfs.org/virt-builder.1.html) repos. Once an image is cached locally, the process of image creation + and guest instantiation should take less than a minute. Take a look:
55

6-
yum/dnf (RPM) install in RHEL 7.2+ or Fedora 22+:
6+
![upvm screenshot](http://people.redhat.com/rsawhill/upvm-demo1.png)
77

8+
#### Where?
9+
upvm supervises `virt-builder` and `virt-install` commands that connect to your local libvirt daemon. Virtual machine images will be saved (by default) to `/var/lib/upvm` and virtual machines will be started on your system.
10+
11+
#### Why not vagrant? What about RHEV and OpenStack?
12+
upvm might not be for you if:
13+
14+
- you've already invested the time to get vagrant to work for you
15+
- you already have all the images you need in a RHEV environment
16+
- you want to spin up new machines in an OpenStack cloud
17+
18+
## Install
19+
20+
#### yum/dnf (RPM) install in RHEL 7.2+ or Fedora 22+:
821
```
922
command -v dnf && dnf=dnf || dnf=yum
1023
$dnf install http://people.redhat.com/rsawhill/rpms/latest-rsawaroha-release.rpm
@@ -13,27 +26,27 @@ $dnf install upvm
1326
upvm -h
1427
```
1528

16-
Non-rpm install:
17-
29+
#### Non-rpm install:
1830
1. Install libguestfs-tools (`virt-builder` command)
1931
1. Make sure you have the `virsh` and `virt-install` commands as well
2032
1. `git clone https://github.com/ryran/upvm.git`
2133
1. `cd upvm`
2234
1. `sudo ./initial-setup`
2335
1. `./upvm.py -h`
2436

37+
#### Optional extras:
2538
Regardless of install method, you will be missing 2 *HIGHLY-recommended* but *optional* python modules. One provides bash-tab-completion and the other provides config-file support. `upvm` will print warnings about this to stderr but if you want to get them now:
2639

2740
1. If RHEL7, ensure access to [EPEL](https://fedoraproject.org/wiki/EPEL)
2841
1. `pip install argcomplete; activate-global-python-argcomplete`
2942
1. `pip install configargparse`
3043

31-
### Once you have some new VMs ...
32-
44+
## I have some VMs ...
3345
Are you annoyed with always having to open the `virt-manager` GUI to do stuff with you VMs?
46+
3447
- Get [valine](https://github.com/ryran/valine).
3548

36-
### Help page
49+
## Help page
3750

3851
```
3952
$ upvm --help

0 commit comments

Comments
 (0)