From a6ce62bad1be696e18fe8a9d19e1ecbf1b2ba938 Mon Sep 17 00:00:00 2001 From: Zack Cerza Date: Thu, 2 Oct 2014 14:27:26 -0600 Subject: [PATCH] Add separate install documentation Signed-off-by: Zack Cerza --- INSTALL.rst | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 INSTALL.rst diff --git a/INSTALL.rst b/INSTALL.rst new file mode 100644 index 0000000000..4bb08c066c --- /dev/null +++ b/INSTALL.rst @@ -0,0 +1,55 @@ +Installation and setup +====================== + +Ubuntu +------ + +For better or worse, ``teuthology`` was originally written with Ubuntu in mind. +Thus, a bootstrap script is provided that will do everything for you assuming +you have ``sudo``:: + + ./bootstrap + +MacOS X +------- + +The ``bootstrap`` script was recently updated to support MacOS X using `homebrew `_:: + + ./bootstrap + +**Note**: Certain features might not work properly on MacOS X. Patches are +encouraged, but it has never been a goal of ours to run a full ``teuthology`` +setup on a Mac. + +Other operating systems +----------------------- + +Patches are welcomed to add ``bootstrap`` support for other operating systems. Until then, manual installs are possible + +First install the non-PyPI dependencies:: + + python-dev python-pip python-virtualenv libevent-dev python-libvirt + +Next, clone its `git repository `__, +create a `virtualenv `__, and +install dependencies:: + + git clone https://github.com/ceph/teuthology/ + cd teuthology + virtualenv ./virtualenv + source virtualenv/bin/activate + pip install --upgrade pip + pip install -r requirements.txt + python setup.py develop + + +Teuthology in PyPI +------------------ + +However if you prefer, you may install ``teuthology`` from `PyPI `__:: + + pip install teuthology + + +**Note**: The version in PyPI can be (*far*) behind the development version. + -- 2.39.5