Skip to content

doc: Troubleshooting with Hubble#11827

Merged
borkmann merged 1 commit intomasterfrom
pr/gandro/hubble-troubleshooting-docs
Jun 3, 2020
Merged

doc: Troubleshooting with Hubble#11827
borkmann merged 1 commit intomasterfrom
pr/gandro/hubble-troubleshooting-docs

Conversation

@gandro
Copy link
Copy Markdown
Member

@gandro gandro commented Jun 2, 2020

This adds a Hubble section to the Troubleshooting chapter, explaining how to use the CLI for embedded Hubble.

@gandro gandro added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.8 labels Jun 2, 2020
@gandro gandro requested a review from a team as a code owner June 2, 2020 15:54
@gandro
Copy link
Copy Markdown
Member Author

gandro commented Jun 2, 2020

test-docs-please

Copy link
Copy Markdown
Contributor

@michi-covalent michi-covalent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great one minor nit

Comment thread Documentation/troubleshooting.rst Outdated
@coveralls
Copy link
Copy Markdown

coveralls commented Jun 2, 2020

Coverage Status

Coverage decreased (-0.01%) to 36.905% when pulling c424915 on pr/gandro/hubble-troubleshooting-docs into 40b6f58 on master.

@gandro gandro force-pushed the pr/gandro/hubble-troubleshooting-docs branch from c8d69d3 to 75f588f Compare June 2, 2020 16:59
@gandro
Copy link
Copy Markdown
Member Author

gandro commented Jun 2, 2020

test-docs-please

Comment thread Documentation/troubleshooting.rst Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we document using hubble relay even if it's in beta? Because I feel that if we mention this but don't explain how, it's going to be an open question for whoever reads this doc. I would suggest to either remove this note or write doc about how to troubleshoot with hubble relay.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 When I read In order to observe the traffic of a specific pod, you will first have to retrieve the name of the cilium instance managing it, I immediately thought "Why can't I use Hubble relay". (But I've been coached by Robin :p)

Nit if we keep this note: Beta -> beta.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I discussed this offline with @gandro and I'll add a hubble relay section to the doc.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed Beta -> beta, but left the note in. My thinking is that we add a link to the hubble-relay section there, but I'm also happy to remove the note completely for now.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My thinking is that we add a link to the hubble-relay section there

I'll do this as part of writing the hubble relay section.

Copy link
Copy Markdown
Member

@pchaigno pchaigno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM except for one/two nits below. Probably not worth fixing if you don't change anything else.

Comment thread Documentation/troubleshooting.rst Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 When I read In order to observe the traffic of a specific pod, you will first have to retrieve the name of the cilium instance managing it, I immediately thought "Why can't I use Hubble relay". (But I've been coached by Robin :p)

Nit if we keep this note: Beta -> beta.

Comment thread Documentation/troubleshooting.rst Outdated
This adds a Hubble section to the Troubleshooting chapter, explaining
how to use the CLI for embedded Hubble.

Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
@gandro gandro force-pushed the pr/gandro/hubble-troubleshooting-docs branch from 75f588f to c424915 Compare June 3, 2020 08:21
@gandro
Copy link
Copy Markdown
Member Author

gandro commented Jun 3, 2020

test-docs-please

@pchaigno pchaigno added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jun 3, 2020
@borkmann borkmann merged commit 6421ecc into master Jun 3, 2020
@borkmann borkmann deleted the pr/gandro/hubble-troubleshooting-docs branch June 3, 2020 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants