Skip to content

Commit

Permalink
added readme for new installation method
Browse files Browse the repository at this point in the history
  • Loading branch information
mcclymont committed May 1, 2014
1 parent 62da4cb commit 4a8bd8c
Showing 1 changed file with 30 additions and 37 deletions.
67 changes: 30 additions & 37 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,33 @@ ovm-ctl - OrionVM Command Line API Bindings


To run, you will require the following:
python
python-simplejson

To install from the ready-to-install tarball:
Copy the usr directory into your root directory:
[user@host]$ cp -r usr /

You can now use ovm-ctl:
[user@host]$ ovm-ctl
and access its man page:
[user@host]$ man 1 ovm-ctl

To install from the git repository:
Change directory into the "packages" directory.
Run the "genpackage" script.
If you do not wish to build the deb,
you can edit the script and comment out
the offending sections "Writing DEBIAN metadata" and "Making debian package".
Once the script has run, you can change directory to the new version directory,
and from there follow the instructions above for the tarball.

Alternately, a fully manual install:
- Move all the files to an install location of your choosing, such as /usr/share/ovm-ctl
- Move "ovm-ctl" to a folder in your PATH, such as /usr/bin
- Optionally, run "python gendocs.py > /usr/share/man/man1/ovm-ctl.1" to generate a man page.

Alternately, a debian package is avilable.

OrionVM offers full support for ovm-ctl on our debian-lenny and ubuntu-lucid images,
and limited support for other debian and ubuntu versions.
CentOS is not supported at this time.

Debian package available here:
https://github.com/orionvm/ovm-ctl/blob/master/package/ovm-ctl-latest.deb?raw=true

Ready-to-install tar.gz:
https://github.com/orionvm/ovm-ctl/blob/master/package/ovm-ctl-latest.tar.gz?raw=true
python2

To install, you will require the following:
python-setuptools


Install:
1. sudo python setup.py install

This will install the python bindings, and also the start script (ovm-ctl) will be in your path

ovm-ctl can be called as is and used interactively, or it can be called with arguments like e.g.
ovm-ctl show vms


The webbindings can be used like this

## example.py ##
from ovm_ctl.webbindings import apibindings as ovm

api = ovm('user@example.com', 'password!')
vms = api.vm_pool()

for vm in vms:
print "%(hostname)s\t%(ram)d" % vm

################


OrionVM offers full support for ovm-ctl with regards to HVM based images

0 comments on commit 4a8bd8c

Please sign in to comment.