Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

align installation doc with other tendr projects #15

Merged
merged 2 commits into from
Nov 9, 2016
Merged

align installation doc with other tendr projects #15

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6910af3
align installation doc with other tendr projects
mbukatov Oct 13, 2016
6b69524
Merge branch 'master' into align_install_doc
r0h4n Nov 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions doc/source/installation.rst
View file
Open in desktop
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