Fix dragonflow doc format

Running 'tox -edocs' finally shows success.

Change-Id: I8bcbd17daa3faea91e82493329d3d2576210b3cc
This commit is contained in:
Li Ma 2017-02-09 12:05:25 +08:00
parent 6c4c47d76d
commit e226398d54
3 changed files with 67 additions and 65 deletions

View File

@ -62,6 +62,8 @@ Specs
services_status
vm_live_migration
nb_api_refactor
support_check_chassis_alive
traceroute
Templates
---------

View File

@ -75,7 +75,9 @@ NB Data Model Impact
--------------------
A service table will be added in Dragonflow NB database, which contains following
information regarding each service
information regarding each service.
::
+------+-------------------+--------------------------------------------------+
| S.No | field | Description |
@ -86,72 +88,72 @@ information regarding each service
+------+-------------------+--------------------------------------------------+
| 3. | binary | Name of the service |
+------+-------------------+--------------------------------------------------+
| 4. | disabled | Represent whether explicitly disabled or not |
| 4. | disabled | Represent whether explicitly disabled or not |
+------+-------------------+--------------------------------------------------+
| 5. | disabled_reason | Reason given when disabling the service |
+------+-------------------+--------------------------------------------------+
| 6. | last_seen_up | Last time stamp reported by the service |
+------+-------------------+--------------------------------------------------+
Plan is to store information on following bassis, if possible
Plan is to store information on following bassis, if possible.
{
"binary1": {
"chassis1":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
"chassis2":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
-
-
-
},
"binary2": {
"chassis1":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
"chassis2":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
-
-
-
},
-
-
-
}
::
{
"binary1": {
"chassis1":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
"chassis2":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
-
-
-
},
"binary2": {
"chassis1":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
"chassis2":
{
"id": UUID,
"chassis": hostname,
"binary": service_name,
"disabled": True/False,
"disabled_reason": reason,
"last_seen_up": timestamp,
"report_count": count(int)"
},
-
-
-
},
-
-
-
}
The assumption for the above data management is, there can be only one instance of
a service on a node that has to be registered.
@ -170,7 +172,9 @@ Dragonflow controller should silently ignore all the updates on the new table.
Dragonflow DB CLI Impact
------------------------
df-db utility will provide following commands to the administrator
df-db utility will provide following commands to the administrator.
::
+------+------------------+----------------------------------------------------+
| S.No | command | Description |

View File

@ -41,11 +41,7 @@ commands =
coverage report
[testenv:docs]
deps =
sphinx
oslosphinx
reno
commands = python setup.py build_sphinx
commands = sphinx-build -W -b html doc/source doc/build/html
[flake8]
# E126 continuation line over-indented for hanging indent