Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanbirkner/quaidan
Quaidan is a python wrapper for mod_proxy_balancer's balancer manager.
https://github.com/stefanbirkner/quaidan
Last synced: about 1 month ago
JSON representation
Quaidan is a python wrapper for mod_proxy_balancer's balancer manager.
- Host: GitHub
- URL: https://github.com/stefanbirkner/quaidan
- Owner: stefanbirkner
- License: mit
- Created: 2014-08-23T20:03:57.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-28T00:12:56.000Z (almost 9 years ago)
- Last Synced: 2024-09-14T03:02:52.252Z (2 months ago)
- Language: Python
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quaidan
=======
[](https://travis-ci.org/stefanbirkner/quaidan)
Quaidan is a python wrapper for
[mod_proxy_balancer](http://httpd.apache.org/docs/2.4/mod/mod_proxy_balancer.html)'s
balancer manager.
Quaidan currently has two features:
* Provide the current state of the load balancer.
* Update cluster members.
Installation
------------
This package is published on [PyPi](https://pypi.python.org/pypi/quaidan/). You can use [pip](https://pip.pypa.io/en/latest/) to install it.
pip install quaidan
Usage
-----
The starting point for all interactions is a `BalancerManager` object.
It is created by specifying the balancer manager's URL.
```python
from quaidan import BalancerManager
balancer_manager = BalancerManager('http://127.0.0.1/balancer-manager')
```
This `BalancerManager` can be used to read the current state of the load
balancer. The following snippet prints alle infos that are available
from the balancer manager page.
```python
status = balancer_manager.get_status()
print('clusters:')
for cluster in status.clusters:
print(' -')
print(' name: ' + cluster.name)
print(' members:')
for member in cluster.members:
print(' -')
print(' worker_url: "' + member.worker_url + '"')
print(' route: "' + str(member.route) + '"')
print(' route_redirect: "' + str(member.route_redirect) + '"')
print(' load_factor: ' + str(member.load_factor))
print(' lb_set: ' + str(member.lb_set))
print(' ignore_errors: ' + str(member.ignore_errors))
print(' draining_mode: ' + str(member.draining_mode))
print(' enabled: ' + str(member.enabled))
print(' hot_standby: ' + str(member.hot_standby))
print(' elected: ' + str(member.elected))
print(' busy: ' + str(member.busy))
print(' load: ' + str(member.load))
print(' transferred: ' + member.transferred)
print(' read: ' + member.read)
```
The `BalancerManager` is used for updating members, too. Please import
the `UpdateMember`command first.
```python
from quaidan.command import UpdateMember
```
Now create an `UpdateMember` command from a `Member` tuple.
```python
status = balancer_manager.get_status()
cluster = status.clusters[0]
update_member = UpdateMember(cluster.name, cluster.members[0])
```
Update the attributes that should be changed and send the command to
the balancer manager.
```python
update_member.route = 'dummy route'
update_member.route_redirect = 'dummy route redirect'
update_member.load_factor = 1
update_member.lb_set = 1
update_member.ignore_errors = True
update_member.drainig_mode = True
update_member.enabled = True
update_member.hot_standby = True
balancer_manager.send_command(update_member)
```
Contributing
------------
If you have a feature request, found a bug or want to ask a question
about Quaidan then please feel free to
* [write an issue.](https://github.com/stefanbirkner/quaidan/issues/new)
* create a pull request. (See [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html))
* [write a mail to [email protected]](mailto:[email protected])
Development Guide
-----------------
Please write a test for every change you make. Run all tests and
[Pylint](http://www.pylint.org/)
python setup.py lint test
in order to ensure that you didn't break an existing feature and your
code complies with the Pylint standards.
For this you need Pylint and a running Apache with a
`mod_proxy_balancer`. The file `setup_apache.sh` can be used to set up
a well configured Apache server if you're using Ubuntu Linux.
I strongly encourage you to use [Vagrant](http://www.vagrantup.com/).
Qaidan provides a `Vagrantfile` that sets up a virtual machine with
all prerequisites. You need three commands only to start the virtual
machine and execute Quaidan's test suite.
vagrant up
vagrant ssh
python setup.py lint test
Release Guide
-------------
* Ensure that the version is set in `setup.py` and `quaidan/__init.py__`.
* Create a release tag: `git tag quaidan-x.x.x -m "Release x.x.x"`.
* Push the tag to GitHub: `git push --tags`.
* Upload to PyPI: `python setup.py sdist upload -r pypi`.
* Create a release on GitHub.
See also
--------
* [Apache Cluster Manager](https://code.google.com/p/apache-cluster-manager/)
* [Sam Gleske's balancer-manager.py](https://github.com/samrocketman/drexel-university/blob/master/appserver-scripts/balancer-manager.py)
* [Source code of mod_proxy_balancer](http://svn.apache.org/viewvc/httpd/httpd/trunk/modules/proxy/mod_proxy_balancer.c)