doc: update Hubble/Hubble Relay guides for recent CLI changes #15981
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To ensure a more logical flow, move the section that explains how to ensure that Hubble is running before the section that explains how to observe flows with Hubble. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
The format of the `hubble status` and `hubble observe` subcommands vary slightly with the new Hubble CLI. Make sure the examples are consistent with the new version. While there, the new CLI also defaults to `localhost:4245` as the server address. Hence, remove notes that hinted to use `--server localhost:4245` when running Hubble CLI commands. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
rolinh
added
area/documentation
kaworu
requested changes
May 4, 2021
gandro
approved these changes
May 4, 2021
qmonnet
requested changes
May 4, 2021
qmonnet
approved these changes
May 4, 2021
kaworu
approved these changes
May 4, 2021
The format of the `hubble status` and `hubble observe` subcommands vary slightly with the new Hubble CLI. Make sure the examples are consistent with the new version. While there, the new CLI also defaults to `localhost:4245` as the server address. Hence, remove notes that hinted to use `--server localhost:4245` when running Hubble CLI commands. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
There is already a section that explains how to enable Hubble Relay and install the Hubble CLI so link to it instead. While there, hint about using `hubble list nodes`. Signed-off-by: Robin Hahling <robin.hahling@gw-computing.net>
rolinh
force-pushed
the
pr/rolinh/doc-hubble-output
branch
from
d4f16cd
to
9a560e6
Compare
|
The CI failures are flakes/unrelated (this PR only touches documentation pages). Got required approval, hence marking ready to merge. |
rolinh
added
the
ready-to-merge
maintainer-s-little-helper
bot
moved this from Needs backport from master
to Backport pending to v1.10
in 1.10.0-rc2
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.0-rc2
maintainer-s-little-helper
bot
moved this from Backport pending to v1.10
to Backport done to v1.10
in 1.10.0-rc2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the troubleshooting with Hubble/Hubble Relay sections as well as the getting started with Hubble guide to recent Hubble CLI changes. Namely, the output of
hubble statusandhubble observeis now slightly different and the CLI defaults tolocalhost:4245a the server address, which allows removing instructions about setting the server address when targeting Hubble Relay.This PR also includes other minor improvements, see commits for details.