Michael Johnson bc2e9beb3a Adds a process to generate key flow documentation
Octavia extensively uses TaskFlow flows for orchestration.
To make it easier for developers to understand these flows,
this patch adds a mechanism for generating graphviz representations
of the key Octavia TaskFlow flows.
It also updates our tox docs task to generate this documentation.

This patch depends on a fix to the TaskFlow export_to_dot method.

Added into conf.py as first step of configuration

Closes-Bug: #1561063
Change-Id: I914e1c062b400148565def37ccf618b3d2ea2573
Depends-On: I99f87af0b2bed959fcb43ef611b3186e23bd9549
2016-08-10 21:39:38 +00:00

22 lines
612 B
ReStructuredText

========================
Octavia Controller Flows
========================
Octavia uses OpenStack TaskFlow to orchestrate the actions the Octavia
controller needs to take while managing load balancers.
This document is meant as a reference for the key flows used in the
Octavia controller.
.. toctree::
:maxdepth: 1
flow_diagrams/AmphoraFlows.rst
flow_diagrams/HealthMonitorFlows.rst
flow_diagrams/L7PolicyFlows.rst
flow_diagrams/L7RuleFlows.rst
flow_diagrams/ListenerFlows.rst
flow_diagrams/LoadBalancerFlows.rst
flow_diagrams/MemberFlows.rst
flow_diagrams/PoolFlows.rst