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
Adding connectivity test to troubleshooting doc #11643
Adding connectivity test to troubleshooting doc #11643
Conversation
Please set the appropriate release note label. |
@jedsalazar looks like you need to update the spelling word list. you can also run https://docs.cilium.io/en/latest/contributing/testing/documentation/ |
Commit 33d89c40cb6bb80a2c152f9cbb5bf5974032b2e3 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
Deploy preview for cilium-docs failed. Built with commit 33d89c40cb6bb80a2c152f9cbb5bf5974032b2e3 https://app.netlify.com/sites/cilium-docs/deploys/5ec6cbc594e7af00079df10e |
Previously the troubleshooting documentation lacked a reference to the connectivity tests specified in the getting started guide. Added the connectivity guide reference as well as some minor style updates Fixes: cilium#11581 Signed-off-by: Jed Salazar <jed@isovalent.com> Updating issues in the docs Fixing ts_agent_logs line, adding a link to the test and fixing a spelling error
33d89c4
to
675797a
Compare
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.
This is a welcome change :)
Couple of comments below.
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.
lgtm overall, one minor comment about not hardcoding the release tag.
Documentation/troubleshooting.rst
Outdated
variant and the readiness and liveness gate indicates success or failure of the | ||
test: | ||
|
||
.. _test: https://raw.githubusercontent.com/cilium/cilium/1.7.4/examples/kubernetes/connectivity-check/connectivity-check.yaml |
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 think you need to use the SCM_WEB
variable defined in Documentation/conf.py here to avoid hardcoding branches/tags. here is an example: https://github.com/cilium/cilium/blame/054dd163fdb792c44b3c493b8d6fd111e5e1a2bc/Documentation/gettingstarted/dns.rst#L33
Commit d4ae623733662b7e504d201be61c8fba9074c353 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
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.
lgtm overall, one minor comment about not hardcoding the release tag.
thanks, Michi! added. it doesn't seem to render on my local build. going see if it works in netlify
Commit d4ae623733662b7e504d201be61c8fba9074c353 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
1 similar comment
Commit d4ae623733662b7e504d201be61c8fba9074c353 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
@jedsalazar some commits are missing sign-offs |
Hard-coding is bad, variables are good. Fixes: cilium#11581 Signed-off-by: Jed Salazar <jed@isovalent.com>
Given that the connectivity testing is referenced in the troubleshooting docs, it's worth deploying them to an empty namespace, `cilium-test`. h/t @joe Also included an initial effort to inlcude a table describing the coverage that each testing type provides. Fixes: cilium#11581 Signed-off-by: Jed Salazar <jed@isovalent.com>
Fixes: cilium#11581 Signed-off-by: Jed Salazar <jed@isovalent.com>
a3b97c3
to
ec22fa4
Compare
Thanks, @aanm. I updated the commits. PTAL |
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.
let's roll
Previously the troubleshooting documentation lacked a reference to the connectivity tests specified in the getting started guide.
Added the connectivity guide reference as well as some minor style updates
Fixes: #11581
Signed-off-by: Jed Salazar jed@isovalent.com
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXX
line if the commit addresses a particularGitHub issue.
Fixes: #issue-number