Bug 1821856 - [Debugging] [Documentation] Create tutorial for OVN debugging tools
Summary: [Debugging] [Documentation] Create tutorial for OVN debugging tools
Keywords:
Status: NEW
Alias: None
Product: Red Hat Enterprise Linux Fast Datapath
Classification: Red Hat
Component: OVN
Version: FDP 20.C
Hardware: Unspecified
OS: Unspecified
low
high
Target Milestone: ---
: ---
Assignee: Dumitru Ceara
QA Contact: Jianlin Shi
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-04-07 17:59 UTC by Mark Michelson
Modified: 2023-07-13 07:25 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker FD-561 0 None None None 2022-04-10 12:15:09 UTC

Description Mark Michelson 2020-04-07 17:59:02 UTC
OVN has some nice debugging tools. While they have good manpages, discovering the tools' existence, and understanding all their possible options is difficult. Having a tutorial document in the Documentation/ directory of the OVN source would be very helpful.

If this document is also posted to ovn.org, then this gives an easily-linked document and makes it more easily discoverable.

Comment 1 Mark Michelson 2022-10-10 18:06:07 UTC
We discussed this issue today during our OVN meeting. For context, this issue got created after a user of OVN was told by a developer that the developer had used ovn-detrace to help debug an issue. The user said "oh, I didn't know that ovn-detrace existed!" and so we decided that having some sort of tutorial pointing out debugging tools was a good idea.

There are now multiple resources for OVN debugging that exist outside of the OVN project that do a good job of explaining tools. However, there still is not a document in the source that directs people to specific tools for debugging certain types of issues. So this issue currently exists to create such a document in the documentation directory of OVN.

It was also brought up that we might want to create testsuite tests that verify the integrity of this particular document, but as of this moment, that is not within the scope of this particular issue.


Note You need to log in before you can comment on or make changes to this bug.