Skip to content

Commit

Permalink
align installation doc with other tendr projects
Browse files Browse the repository at this point in the history
  • Loading branch information
mbukatov authored and r0h4n committed Nov 9, 2016
1 parent 18b2f4a commit 1bb3cf0
Showing 1 changed file with 36 additions and 8 deletions.
44 changes: 36 additions & 8 deletions doc/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,43 @@ Environment
Installation
============

Since there is no stable release yet, the only option is to install the project
from the source.

1. Install http://github.com/tendrl/bridge_common
2. Install http://github.com/tendrl/ceph_bridge
At the command line::
Development version from the source
-----------------------------------

1. Install http://github.com/tendrl/bridge_common from the source code::

$ git clone https://github.com/Tendrl/bridge_common.git
$ cd bridge_common
$ mkvirtualenv ceph_bridge
$ pip install .

2. Install ceph bridge itself::

$ git clone https://github.com/Tendrl/ceph_bridge.git
$ cd ceph_bridge
$ workon ceph_bridge
$ pip install .

Note that we use virtualenvwrapper_ here to activate ``ceph_bridge`` `python
virtual enviroment`_. This way, we install *ceph bridge* into the same virtual
enviroment which we have created during installation of *bridge common*.

.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
.. _`python virtual enviroment`: https://virtualenv.pypa.io/en/stable/

3. Create config file::

$ python setup.py install
$ cp etc/tendrl/tendrl.conf.sample /etc/tendrl/tendrl.conf

4. Edit /etc/tendrl/tendrl.conf as required
5. mkdir /var/log/tendrl
6. Run
$ tendrl-ceph-bridge
4. Edit ``/etc/tendrl/tendrl.conf`` as required

5. Create log dir::

$ mkdir /var/log/tendrl

6. Run::

$ tendrl-ceph-bridge

0 comments on commit 1bb3cf0

Please sign in to comment.