]> git-server-git.apps.pok.os.sepia.ceph.com Git - teuthology.git/commitdiff
Add separate install documentation
authorZack Cerza <zack.cerza@inktank.com>
Thu, 2 Oct 2014 20:27:26 +0000 (14:27 -0600)
committerZack Cerza <zack.cerza@inktank.com>
Fri, 24 Oct 2014 22:01:17 +0000 (16:01 -0600)
Signed-off-by: Zack Cerza <zack.cerza@inktank.com>
INSTALL.rst [new file with mode: 0644]

diff --git a/INSTALL.rst b/INSTALL.rst
new file mode 100644 (file)
index 0000000..4bb08c0
--- /dev/null
@@ -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 <http://brew.sh/>`_::
+
+    ./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 <https://github.com/ceph/teuthology/>`__,
+create a `virtualenv <http://virtualenv.readthedocs.org/en/latest/>`__, 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 <http://pypi.python.org>`__::
+
+    pip install teuthology
+
+
+**Note**: The version in PyPI can be (*far*) behind the development version.
+