Skip to content

Commit

Permalink
Merge pull request ceph#57749 from zdover23/wip-doc-2024-05-29-backpo…
Browse files Browse the repository at this point in the history
…rt-57732-to-squid

squid: doc/developer_guide: update doc about installing teuthology

Reviewed-by: Anthony D'Atri <[email protected]>
  • Loading branch information
zdover23 authored May 28, 2024
2 parents 880ac5e + 60698c0 commit 49fa162
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions doc/dev/developer_guide/running-tests-locally.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,35 @@ Running your first test
The Python tests in Ceph repository can be executed on your local machine
using `vstart_runner.py`_. To do that, you'd need `teuthology`_ installed::

$ git clone https://github.com/ceph/teuthology
$ cd teuthology
$ ./bootstrap install

This will create a virtual environment named ``virtualenv`` in root of the
teuthology repository and install teuthology in it.

You can also install teuthology via ``pip`` if you would like to install it
in a custom virtual environment with clone `teuthology`_ repository using
``git``::

$ virtualenv --python=python3 venv
$ source venv/bin/activate
$ pip install 'setuptools >= 12'
$ pip install teuthology[test]@git+https://github.com/ceph/teuthology
$ deactivate

If for some unforeseen reason above approaches do no work (maybe boostrap
script doesn't work due to a bug or you can't download tethology at the
moment) teuthology can be installed manually manually from copy of
teuthology repo already present on your machine::

$ cd teuthology
$ virtualenv -p python3 venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ pip install .
$ deactivate

The above steps installs teuthology in a virtual environment. Before running
a test locally, build Ceph successfully from the source (refer
:doc:`/install/build-ceph`) and do::
Expand Down

0 comments on commit 49fa162

Please sign in to comment.