openstack
/
octavia
Code Issues Proposed changes

Temporarily disable flow diagraming 

The networkx package changed their dependecy model in version 2.1 and
now uses "pydot" and adds the dependency via setuptools "extras".
Unfortunately they only define an "extra" of "all" which installs packages
we do not need and fail to install.

So until the "extras" are fixed in networkx, we need to disable flow
diagraming.

Change-Id: I4f9082c267dc7da14b81cb551eeb10bbf58c175a
See: https://github.com/networkx/networkx/pull/3080
This commit is contained in:
Michael Johnson 2018-07-22 15:32:13 -07:00
parent af7f5c2896
commit 9ca61f2f4a
2 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -27,8 +27,10 @@ sys.path.insert(0, os.path.abspath('.'))
from tools import create_flow_docs
# Generate our flow diagrams
create_flow_docs.generate(
'tools/flow-list.txt', 'doc/source/contributor/devref/flow_diagrams')
# TODO(johnsom) Re-enable flow diagrams when networkx supports individual
# extras. See https://github.com/networkx/networkx/pull/3080
# create_flow_docs.generate(
# 'tools/flow-list.txt', 'doc/source/contributor/devref/flow_diagrams')
# Generate entity relationship diagram
desc = sadisplay.describe(

20
doc/source/contributor/devref/flows.rst
View File

@ -8,14 +8,18 @@ controller needs to take while managing load balancers.
This document is meant as a reference for the key flows used in the
Octavia controller.
.. note:: Flow diagrams are temporarly disabled due to a dependency issue.
.. 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
.. TODO(johnsom) Re-enable flow diagrams when networkx supports individual
.. extras. See https://github.com/networkx/networkx/pull/3080
.. 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