rearrange existing documentation to fit the new standard layout
Change-Id: If03b33fc1393c3a04d7d155b31e8377dc9e09360
This commit is contained in:
parent
38bcf7bbdb
commit
2ca15fedbe
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../ChangeLog
|
|
|
@ -6,28 +6,14 @@ The Tooz project aims at centralizing the most common distributed primitives
|
||||||
like group membership protocol, lock service and leader election by providing
|
like group membership protocol, lock service and leader election by providing
|
||||||
a coordination API helping developers to build distributed applications. [#f1]_
|
a coordination API helping developers to build distributed applications. [#f1]_
|
||||||
|
|
||||||
Contents
|
|
||||||
========
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:maxdepth: 2
|
||||||
|
|
||||||
install
|
install/index
|
||||||
drivers
|
user/index
|
||||||
compatibility
|
reference/index
|
||||||
tutorial/index
|
|
||||||
developers
|
|
||||||
|
|
||||||
Release Notes
|
.. rubric:: Indices and tables
|
||||||
=============
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
history
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
* :ref:`modindex`
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
==========
|
================
|
||||||
Developers
|
Module Reference
|
||||||
==========
|
================
|
||||||
|
|
||||||
Interfaces
|
Interfaces
|
||||||
----------
|
----------
|
|
@ -0,0 +1 @@
|
||||||
|
.. include:: ../../../ChangeLog
|
|
@ -0,0 +1,15 @@
|
||||||
|
==================
|
||||||
|
User Documentation
|
||||||
|
==================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
tutorial/index
|
||||||
|
drivers
|
||||||
|
compatibility
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
history
|
|
@ -17,7 +17,7 @@ If a driver does not support a feature, it will raise a
|
||||||
This example program loads a basic coordinator using the ZooKeeper based
|
This example program loads a basic coordinator using the ZooKeeper based
|
||||||
driver.
|
driver.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/coordinator.py
|
.. literalinclude:: ../../../../examples/coordinator.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
The second argument passed to the coordinator must be a unique identifier
|
The second argument passed to the coordinator must be a unique identifier
|
||||||
|
@ -33,7 +33,7 @@ other program participating in the coordination. Unless you want to call it
|
||||||
manually, you can use tooz builtin heartbeat manager by passing the
|
manually, you can use tooz builtin heartbeat manager by passing the
|
||||||
`start_heart` argument.
|
`start_heart` argument.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/coordinator_heartbeat.py
|
.. literalinclude:: ../../../../examples/coordinator_heartbeat.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
heartbeat at different moment or intervals.
|
heartbeat at different moment or intervals.
|
|
@ -10,7 +10,7 @@ group membership. Once a group is created, any coordinator can join the
|
||||||
group and become a member of it. Any coordinator can be notified when a
|
group and become a member of it. Any coordinator can be notified when a
|
||||||
members joins or leaves the group.
|
members joins or leaves the group.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/group_membership.py
|
.. literalinclude:: ../../../../examples/group_membership.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
Note that all the operation are asynchronous. That means you cannot be sure
|
Note that all the operation are asynchronous. That means you cannot be sure
|
||||||
|
@ -29,7 +29,7 @@ changes. That's useful to run callback functions whenever something happens
|
||||||
in that group.
|
in that group.
|
||||||
|
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/group_membership_watch.py
|
.. literalinclude:: ../../../../examples/group_membership_watch.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
Using :meth:`tooz.coordination.CoordinationDriver.watch_join_group` and
|
Using :meth:`tooz.coordination.CoordinationDriver.watch_join_group` and
|
|
@ -6,5 +6,5 @@ Tooz provides a consistent hash ring implementation. It can be used to map
|
||||||
objects (represented via binary keys) to one or several nodes. When the node
|
objects (represented via binary keys) to one or several nodes. When the node
|
||||||
list changes, the rebalancing of objects across the ring is kept minimal.
|
list changes, the rebalancing of objects across the ring is kept minimal.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/hashring.py
|
.. literalinclude:: ../../../../examples/hashring.py
|
||||||
:language: python
|
:language: python
|
|
@ -7,7 +7,7 @@ in a group. Only members that are running for the election can be elected.
|
||||||
As soon as one of leader steps down or dies, a new member that was running
|
As soon as one of leader steps down or dies, a new member that was running
|
||||||
for the election will be elected.
|
for the election will be elected.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/leader_election.py
|
.. literalinclude:: ../../../../examples/leader_election.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
The method
|
The method
|
|
@ -5,7 +5,7 @@
|
||||||
Tooz provides distributed locks. A lock is identified by a name, and a lock can
|
Tooz provides distributed locks. A lock is identified by a name, and a lock can
|
||||||
only be acquired by one coordinator at a time.
|
only be acquired by one coordinator at a time.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/lock.py
|
.. literalinclude:: ../../../../examples/lock.py
|
||||||
:language: python
|
:language: python
|
||||||
|
|
||||||
The method :meth:`tooz.coordination.CoordinationDriver.get_lock` allows
|
The method :meth:`tooz.coordination.CoordinationDriver.get_lock` allows
|
|
@ -7,5 +7,5 @@ implementation. It can be used to map Python objects to one or several nodes.
|
||||||
The partitioner object automatically keeps track of nodes joining and leaving
|
The partitioner object automatically keeps track of nodes joining and leaving
|
||||||
the group, so the rebalancing is managed.
|
the group, so the rebalancing is managed.
|
||||||
|
|
||||||
.. literalinclude:: ../../../examples/partitioner.py
|
.. literalinclude:: ../../../../examples/partitioner.py
|
||||||
:language: python
|
:language: python
|
Loading…
Reference in New Issue