Skip to content

Commit 899c481

Browse files
doc/developer_guide: update doc about installing teuthology
There are 2 more ways to install teuthology. Approach with boostrap script is easier and more convenient while other approach is more elaborate but manual, document both of them. Don't delete the currently documented approach because it lets users install teuthology conveniently in a custom virtual environment. So, keep all three. Signed-off-by: Rishabh Dave <[email protected]>
1 parent 0cd602b commit 899c481

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/dev/developer_guide/running-tests-locally.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,35 @@ Running your first test
5252
The Python tests in Ceph repository can be executed on your local machine
5353
using `vstart_runner.py`_. To do that, you'd need `teuthology`_ installed::
5454

55+
$ git clone https://github.com/ceph/teuthology
56+
$ cd teuthology
57+
$ ./bootstrap install
58+
59+
This will create a virtual environment named ``virtualenv`` in root of the
60+
teuthology repository and install teuthology in it.
61+
62+
You can also install teuthology via ``pip`` if you would like to install it
63+
in a custom virtual environment with clone `teuthology`_ repository using
64+
``git``::
65+
5566
$ virtualenv --python=python3 venv
5667
$ source venv/bin/activate
5768
$ pip install 'setuptools >= 12'
5869
$ pip install teuthology[test]@git+https://github.com/ceph/teuthology
5970
$ deactivate
6071

72+
If for some unforeseen reason above approaches do no work (maybe boostrap
73+
script doesn't work due to a bug or you can't download tethology at the
74+
moment) teuthology can be installed manually manually from copy of
75+
teuthology repo already present on your machine::
76+
77+
$ cd teuthology
78+
$ virtualenv -p python3 venv
79+
$ source venv/bin/activate
80+
$ pip install -r requirements.txt
81+
$ pip install .
82+
$ deactivate
83+
6184
The above steps installs teuthology in a virtual environment. Before running
6285
a test locally, build Ceph successfully from the source (refer
6386
:doc:`/install/build-ceph`) and do::

0 commit comments

Comments
 (0)