ceph/doc/mon
Joao Eduardo Luis 504c6ce957 doc: Add Paxos call chain to doc/mon/
Signed-off-by: Joao Eduardo Luis <joao.luis@inktank.com>
2012-05-29 18:34:27 -07:00
..
README.txt doc: Add Paxos call chain to doc/mon/ 2012-05-29 18:34:27 -07:00
paxos-call-chain.dot doc: Add Paxos call chain to doc/mon/ 2012-05-29 18:34:27 -07:00

README.txt

paxos-call-chain.dot describes to some detail the call chain involved in the
Paxos algorithm, paying special consideration to the messages involved.

This information is not easily obtainable by Doxygen, as it does not follow
the call chain when messages are involved, since it becomes an async workflow.

To obtain the graph one should run

  dot -T<format> paxos-call-chain.dot -o paxos-call-chain.<format>

e.g.,

  dot -Tps paxos-call-chain.dot -o paxos-call-chain.ps

or

  dot -Tpng paxos-call-chain.dot -o paxos-call-chain.png

It should do the trick.

Also, for future reference, we consider that:
  - boxed nodes refer to the Leader;
  - elliptical nodes refer to the Peon;
  - diamond shaped nodes refer to state changes;
  - dotted lines illustrate a message being sent from the Leader to the Peon,
  or vice-versa.