openstack
/
dragonflow
Code Issues Proposed changes

Added documentation to the db-model app 

Added app usage instructions to the testing and debugging document.

Change-Id: Ice0dc6c29f6afe0a383606156610e3cdb5fe06a5
Closes-Bug: #1734146
This commit is contained in:
Shachar Snapiri 2017-11-30 08:11:50 +02:00
parent e8a1ece4f4
commit 8dbb794cfe
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/testing_and_debugging.rst
View File

@ -73,4 +73,18 @@ dump db content, list db tables, list db table keys and print value of the
specific key in the table. Use *df-db --help* to list and get details on
supported sub-commands.
::
> df-model
This utility will allow to print a representation of the DragonFlow model in
different formats. Currently supported formats are: text, PlantUML and
JsonSchema (OpenApiSchema 3.0). The output may be sent to the stdout or to a
file.
* PlantUML output can be visualized using the PlantUML Server [#]_
Use the *df-model --help* command to get a detailed usage instructions.
.. [#] https://gist.github.com/omeranson/5c731955edcf0517bfb0ce0ce511cc9b
.. [#] http://www.plantuml.com/plantuml/uml/