-
Notifications
You must be signed in to change notification settings - Fork 1.5k
docs: add some networking troubleshooting docs #669
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.
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
docs: add some networking troubleshooting docs #669
Conversation
2b02314 to
a933acd
Compare
a933acd to
65f4a57
Compare
0ce0f8b to
c221137
Compare
wking
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've dropped some minor copy-edits inline.
Stepping back, should this live in the network operator repo where we can link to it?
docs/user/troubleshooting.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: This block has a command with no output. Personally I like:
```console
with a prompt tfor those, but this project hsd an existing patter of:
```sh
with no prompt. More in #27.
I think we are going to answering questions on network readiness quite often and this might help us answer some easy questions for users. and then redirect them to SDN team. |
But folks might use the network operators outside of OpenShift? Or, maybe more likely, have issues with networking in running OpenShift clusters and then not think to check the installer docs? Basically, if docs are specific to a single operator (like these? I dunno), then I think they should live with that operator, and we can link them from here. Having a link shouldn't make life too much harder for folks who do think of checking the installer docs first, should it? |
c221137 to
d0b5169
Compare
|
Updated and repushed. If the network fails, the installer generally fails (since we never leave the boostrap control plane). So I think its pretty reasonable to have some network troubleshooting tasks. In the future, we'll have to have separate diagnostic tasks for each network type (and that should live in Proper Documentation), but this is more to help people before we ship 4.1. |
You still need to change
I agree that we should have network troubleshooting docs. I'm just not sold (yet ;) on the installer being the right place for them. Does networking never get through installation but then fail later on? Is everyone with networking trouble at any point going to come looking in in the installer docs? And do installer maintainers understand this well enough to maintain these docs (I don't ;)? Perhaps as a middle ground we could put these in |
d0b5169 to
6d60f2e
Compare
|
Fixed the markdown fences. I'm not gonna lie, I don't care where this goes. Someone asked me to write a troubleshooting doc, so I wrote it. Take it or leave it. |
6d60f2e to
f8441fc
Compare
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhinavdahiya, squeed The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Perhaps an unnecessary amount of debugging information. But networking is often the canary in the coal mine, issue-wise.