diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 47d2e336a..539870aa2 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -45,7 +45,7 @@ DOC_SOURCE = \ Documentation/topics/fuzzing/ovs-fuzzing-infrastructure.rst \ Documentation/topics/fuzzing/ovs-fuzzers.rst \ Documentation/topics/fuzzing/security-analysis-of-ovs-fuzzers.rst \ - Documentation/topics/testing.rst \ + Documentation/topics/flow-visualization.rst \ Documentation/topics/integration.rst \ Documentation/topics/language-bindings.rst \ Documentation/topics/networking-namespaces.rst \ @@ -55,6 +55,7 @@ DOC_SOURCE = \ Documentation/topics/ovsdb-replication.rst \ Documentation/topics/porting.rst \ Documentation/topics/record-replay.rst \ + Documentation/topics/testing.rst \ Documentation/topics/tracing.rst \ Documentation/topics/usdt-probes.rst \ Documentation/topics/userspace-checksum-offloading.rst \ @@ -162,6 +163,7 @@ RST_MANPAGES = \ ovs-actions.7.rst \ ovs-appctl.8.rst \ ovs-ctl.8.rst \ + ovs-flowviz.8.rst \ ovs-l3ping.8.rst \ ovs-parse-backtrace.8.rst \ ovs-pki.8.rst \ diff --git a/Documentation/conf.py b/Documentation/conf.py index 2364405ad..303973fc9 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -112,6 +112,8 @@ html_static_path = ['_static'] # Define the canonical URL for our domain configured on Read the Docs. html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") +option_emphasise_placeholders = True + # Tell Jinja2 templates the build is running on Read the Docs. html_context = {} if os.environ.get("READTHEDOCS", "") == "True": @@ -128,6 +130,8 @@ _man_pages = [ u'utility for configuring running Open vSwitch daemons'), ('ovs-ctl.8', u'OVS startup helper script'), + ('ovs-flowviz.8', + u'utility for visualizing OpenFlow and datapath flows'), ('ovs-l3ping.8', u'check network deployment for L3 tunneling problems'), ('ovs-parse-backtrace.8', diff --git a/Documentation/ref/index.rst b/Documentation/ref/index.rst index 03ada932f..7f2fe6177 100644 --- a/Documentation/ref/index.rst +++ b/Documentation/ref/index.rst @@ -42,6 +42,7 @@ time: ovs-actions.7 ovs-appctl.8 ovs-ctl.8 + ovs-flowviz.8 ovs-l3ping.8 ovs-pki.8 ovs-sim.1 diff --git a/Documentation/ref/ovs-flowviz.8.rst b/Documentation/ref/ovs-flowviz.8.rst new file mode 100644 index 000000000..fc850e1d3 --- /dev/null +++ b/Documentation/ref/ovs-flowviz.8.rst @@ -0,0 +1,540 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +=========== +ovs-flowviz +=========== + +Synopsis +======== + +``ovs-flowviz`` +[``-i`` [*alias*,]\ *file* | ``--input`` [*alias*,]\ *file*] +[``-c`` *file* | ``--config`` *file*] +[``-f`` *filter* | ``--filter`` *filter*] +[``-h`` *filter* | ``--highlight`` *filter*] +[``--style`` *style*] +*flow-type* *format* [*args*...] + +``ovs-flowviz --help`` + +Description +=========== + +``ovs-flowviz`` helps visualize OpenFlow and datapath flow dumps in different +formats in order to make them more easily understood. + +``ovs-flowviz`` reads flows from ``stdin`` or from a *file* specified by the +``--input`` option, filters them, highlights them, and finally outputs +them in one of the predefined *format*\ s. + + +Options +======= + +.. program: ovs-flowviz + +.. option:: -h, --help + + Print a brief help message to the console. + +.. option:: -i [,], --input [,] + + File to read flows from. If not provided, ``ovs-flowviz`` + will read flows from stdin. + + This option can be specified multiple times. + The file path can prepended by an alias that will be shown in the output. + For example: ``--input node1,/path/to/file1 --input node2,/path/to/file2`` + +.. option:: -c , --config + + Style configuration file to use, overriding the default one. + Styles defined in the style configuration file can be selected using + the ``--style`` option. + + For more details on the style configuration file, see the + `Style Configuration File`_ section below. + +.. option:: -f , --filter + + Flow filter expression. Only those flows matching the expression will be + shown (although some formats implement filtering differently, see the + `Datapath tree format`_ section below). + + The filtering syntax is detailed in `Filtering Syntax`_. + +.. option:: -h , --highlight + + Highlight the flows that match the provided *filter* expression. + + The filtering syntax is detailed in `Filtering Syntax`_. + +.. option:: --style