openstack
/
tooz
Code Issues Proposed changes
Coordinate distributed systems.
697 Commits 3 Branches 57 Tags 10 MiB
Python 99.2%
Shell 0.8%
Go to file
Ben Nemec e76235b675 More explicitly document driver connection strings 
If you're not intimately familiar with RFC 1808 it can be a bit tricky to
write tooz connection strings. In addition, some drivers do not document the
options that they recognize in a connection string. This can force a user to
read the driver code in order to figure out how to configure tooz to use said
driver, which should not be the case.

This change more explicitly documents the format of the connection string,
including which parts of an RFC 1808 URI it recognizes, and the options that
can be passed. It also clarifies which parts of the connection string are
optional (possibly because they have defaults) and which must always be
included.

Note that not every possible configuration is documented. For example, the
postgres driver supports multiple methods of configuring the connection host
and port. For consistency, I only documented the one that matches the other
drivers. This should be sufficient to allow a user to write a working
connection string.

This change also wires the etcd3 and etcd3gw drivers into the doc index since
they were missing before.

Change-Id: I66e54433115f27fb54badc2173f8f6044c49aacb
 		2018-12-17 22:37:55 +00:00
doc More explicitly document driver connection strings 2018-12-17 22:37:55 +00:00
examples doc: update heartbeat doc to use start_heart=True 2017-04-27 16:40:57 +02:00
releasenotes Update reno for stable/rocky 2018-07-26 12:43:11 +00:00
tools Migrate to stestr 2018-09-18 00:37:30 +00:00
tooz More explicitly document driver connection strings 2018-12-17 22:37:55 +00:00
.coveragerc Fix coverage tests 2018-09-18 00:37:30 +00:00
.gitignore Migrate to stestr 2018-09-18 00:37:30 +00:00
.gitreview Fix .gitreview after rename/transfer 2014-12-06 19:27:17 +03:00
.stestr.conf Migrate to stestr 2018-09-18 00:37:30 +00:00
.zuul.yaml Use templates for cover 2018-09-18 05:59:21 +00:00
CONTRIBUTING.rst Add CONTRIBUTING.rst 2016-11-18 16:44:36 +08:00
LICENSE First commit of Tooz 2013-12-19 12:18:35 +01:00
README.rst Add release note link in README 2018-06-29 18:13:24 +00:00
bindep.txt Install only needed packages 2016-09-22 10:20:50 +02:00
requirements.txt Unblock tooz gate 2018-12-17 22:36:59 +00:00
run-examples.sh Have examples run in the py27 environment and make them work 2014-09-19 11:57:56 -07:00
run-tests.sh Simplify env list and test running 2017-06-09 18:09:31 +02:00
setup-consul-env.sh Use pifpaf to setup daemons 2016-06-09 10:40:16 +02:00
setup-etcd-env.sh Switch tests to use latest etcd - 3.1.3 2017-03-14 15:17:42 +00:00
setup.cfg Migrate to stestr 2018-09-18 00:37:30 +00:00
setup.py Updated from global requirements 2015-09-17 12:17:45 +00:00
tox.ini Fix coverage tests 2018-09-18 00:37:30 +00:00

README.rst

Tooz

Latest Version

Downloads

The Tooz project aims at centralizing the most common distributed primitives like group membership protocol, lock service and leader election by providing a coordination API helping developers to build distributed applications.

Join us