Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix README broken link and give a clearer explanation of debug scripts #11

Merged
merged 1 commit into from
Oct 21, 2020
Merged

Fix README broken link and give a clearer explanation of debug scripts #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
debug-network
=============

`openshift-debug-network` is a tool for debugging network.
The directory structure, as well as specific details behind this tool can be found [in this enhancement](https://github.com/openshift/enhancements/blob/master/enhancements/oc/debug-network.md).
`debug-network` is a tool for debugging OpenShift cluster network issues.
It will contain both debugging scripts (described in the next section) and useful tools that can be used
by network engineers and openshift operators to debug and diagnose issues.

## Debugging Scripts
Debugging scripts are kept in `./debug-scripts`. The content of that folder is placed in `/usr/bin` in the image.
The debug network scripts should only include debug logic for OpenShift Networking.
Outside components are encouraged to produce a similar "debug-network" image, but this is not the spot to be
included.
These scripts will typically create Kubernetes network objects (pods, services, network policies etc) and perform
a series of tests to diagnose the functionality in the cluster works ok. In case there is a check that fails, we
would dig in the script and provide further checks to point at potential root causes to resolve the issue.
Therefore, the pattern for these scripts is to find issues and *why* those issues exist. Gathering logs is not
in the scope of these scripts and are better suited on the openshift/must-gather image.