openstack
/
tooz
Code Issues Proposed changes

Ensure etcd is in developer and driver docs 

Change-Id: I2da690a7ea93646e38d86f90168571abaab69067
This commit is contained in:
Joshua Harlow 2016-05-12 22:32:30 -07:00
parent 38cd610a03
commit 601fb264c5
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/developers.rst
View File

@ -9,7 +9,7 @@ Interfaces
:members: :members:
Etcd Etcd
~~~ ~~~~
.. autoclass:: tooz.drivers.etcd.EtcdDriver .. autoclass:: tooz.drivers.etcd.EtcdDriver
:members: :members:

16
doc/source/drivers.rst
View File

@ -183,11 +183,27 @@ Considerations
- Does **not** work when MySQL replicates from one server to another (locks - Does **not** work when MySQL replicates from one server to another (locks
are local to the server that they were created from). are local to the server that they were created from).
Etcd
----
**Driver:** :py:class:`tooz.drivers.etcd.EtcdDriver`
**Characteristics:** :py:attr:`tooz.drivers.etcd.EtcdDriver.CHARACTERISTICS`
**Entrypoint name:** ``etcd``
**Summary:**
The etcd driver is a driver providing only distributed locks (for now)
and is based on the `etcd server`_ supported key/value storage and
associated primitives.
Characteristics Characteristics
--------------- ---------------
.. autoclass:: tooz.coordination.Characteristics .. autoclass:: tooz.coordination.Characteristics
.. _etcd server: https://coreos.com/etcd/
.. _advisory locks: http://www.postgresql.org/docs/8.2/interactive/\ .. _advisory locks: http://www.postgresql.org/docs/8.2/interactive/\
explicit-locking.html#ADVISORY-LOCKS explicit-locking.html#ADVISORY-LOCKS
.. _get_lock: http://dev.mysql.com/doc/refman/5.5/en/\ .. _get_lock: http://dev.mysql.com/doc/refman/5.5/en/\