VOL-4836 - Cosmetic edits to force a jenkins job.
Makefile
bandwidth-profiles/bandwidth-profiles.rst
-----------------------------------------
o Update document text to force trivial deltas.
o For readability: reformat runon command output to fit 80cpl.
howto/edit_voltha_docs.rst
--------------------------
o Copy in gendocs howto text from repo:infra-docs.
overview/troubleshooting.rst
----------------------------
o Update document text to force trivial deltas.
o Change variable delimiter syntax $()-makefile into ${}-shell since context is the command line.
o cat | grep command can be replaced by a single grep command to avoid the extra process.
testing/index.rst
-----------------
o Minor reformatting for readability.
o Include URLs for both voltha-system-test repository access: gerrit & github.
o Added a "See Also" section to hilight cord-* resources.
Change-Id: Ibf0881a6172abcb866f54dce57ce67a4c29b1bb1
diff --git a/overview/troubleshooting.rst b/overview/troubleshooting.rst
index 1bd2fc9..3ff63f1 100644
--- a/overview/troubleshooting.rst
+++ b/overview/troubleshooting.rst
@@ -17,13 +17,17 @@
-------------------------------
Given that ``VOLTHA`` is a collection of microservices we strongly suggest the usage of a log aggregator like
-`stern <https://github.com/stern/stern>`_ installed. You can then aggregate logs from multiple containers in
+`stern <https://github.com/stern/stern>`_. Stern is able to aggregate logs from multiple containers in
a simple way, for example to track all the ``packet-ins`` and ``packet-outs``:
.. code:: bash
+ # Capture to a file
$ stern -n voltha "voltha|adapter" | grep -E "packet-out|packet-in" > packets.trace
+ # Live streaming packet capture using the tee command:
+ $ stern -n voltha "voltha|adapter" | grep -E "packet-out|packet-in" | tee packets.trace
+
Once you have captured the packets you need, you can see them in wireshark by transforming the logs with:
.. code:: bash
@@ -34,9 +38,9 @@
Or you can decode a single packet using this online tool: `https://hpd.gasmi.net <https://hpd.gasmi.net>`_
-To get all the EAPOL packets: ``cat packets.trace | grep 888e``
+To get all the EAPOL packets: ``grep -e '888e' packets.trace``
-or if you have `hl <https://github.com/mbornet-hl/hl>`__ installed you can highlight with:
+or if you have the colorization program `hl <https://github.com/mbornet-hl/hl>`__ installed you can highlight with:
.. code:: bash
@@ -60,12 +64,15 @@
.. code:: bash
- mkdir -p $(HOME)/.local/lib/wireshark/plugins
- cd $(HOME)/.local/lib/wireshark/plugins
+ mkdir -p "${HOME}/.local/lib/wireshark/plugins"
+ cd "${HOME}/.local/lib/wireshark/plugins"
wget "https://wiki.wireshark.org/Contrib?action=AttachFile&do=get&target=omci.lua"
wget "https://wiki.wireshark.org/Contrib?action=AttachFile&do=get&target=BinDecHex.lua"
-IMPORTANT - Apply `this <https://ask.wireshark.org/question/4557/bindechexlua-error-bad-argument-to-module-packageseeall/?answer=4573#post-id-4573>`_ fix to BinDecHex.lua.
+- IMPORTANT - Apply `this <https://ask.wireshark.org/question/4557/bindechexlua-error-bad-argument-to-module-packageseeall/?answer=4573#post-id-4573>`_ fix to BinDecHex.lua.
+
+- TODO NOTE - The BinDecHex.lua thread is 4 years old, is the patch still
+ required or has it been incorporated into the code base ?
To capture the OMCI packets for all ONUs: