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

Added few more details for installation guidelines #31

Merged
merged 4 commits into from
Nov 8, 2016
Merged

Added few more details for installation guidelines #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3019b8
Added few more details for installation guidelines
Oct 18, 2016
6474c93
Incorporated review comments
Oct 21, 2016
617dd47
Corrected a typo issue
Oct 27, 2016
0f85e7f
Corrected travis errors
Nov 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 32 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,16 +10,40 @@ 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/gluster_bridge
Development version from the source
-----------------------------------

At the command line::
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 bridge_common
$ pip install .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we just simply add a reference to these steps in bridge common instead of having to put the steps here again

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Earlier it was like that. But better user refers one and has the setup ready. so its OK I feel. Still if everybody feels strongly to refer from common, can be done :)


2. Install gluster_bridge itself::
$ git clone https://github.com/shtripat/gluster_bridge.git
$ cd gluster_bridge
$ workon gluster_bridge
$ pip install .

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

.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/
Copy link
Contributor

@anmolbabu anmolbabu Nov 4, 2016 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked this note as it is informative.At-least I was not aware of this before reviewing this and was struggling to get this kind of thing working for my monitoring related stuff. Thanks ...

.. _`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-gluster-bridge
4. Edit ``/etc/tendrl/tendrl.conf`` as required
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a reference to sample conf file here if it exists or add one and refer it here so that things like the conf file format and also the neessary fields of conf file can be easily known

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its small change so should be ok I feel.


5. Create log dir::

$ mkdir /var/log/tendrl

6. Run::
$ tendrl-gluster-bridge
6 changes: 4 additions & 2 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ def extract_requirements(filename):
license="LGPL-2.1+",
zip_safe=False,
install_requires=install_requires,
entry_points={'console_scripts': [
'tendrl-gluster-bridge = tendrl.gluster_bridge.manager.manager:main'
entry_points={
'console_scripts': [
'tendrl-gluster-bridge = '
'tendrl.gluster_bridge.manager.manager:main'
]
}
)
8 changes: 7 additions & 1 deletion tendrl/gluster_bridge/log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,11 @@ def setup_logging():
handler.setFormatter(logging.Formatter(FORMAT))
root.addHandler(handler)
root.setLevel(
logging.getLevelName(config.get('gluster_bridge', 'log_level')))
logging.getLevelName(
config.get(
'gluster_bridge',
'log_level'
)
)
)
logging.getLogger(__name__).info("Logging setup complete!")