feat: updated hubble ui docs #1659
Open
Conversation
This file contains hidden or 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
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
Signed-off-by: Animesh Pathak <53110238+Sonichigo@users.noreply.github.com>
|
@microsoft-github-policy-service agree |
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.
Description
This pull request updates the
docs/07-Integrations/02-hubble-ui.mdfile to enhance the documentation for Hubble UI. The changes include restructuring the content, adding detailed installation and troubleshooting steps, and improving clarity and usability for users deploying Hubble UI in Kubernetes environments.Documentation Improvements:
Introduction and Overview: Replaced the previous overview with a detailed introduction to Hubble UI, highlighting its purpose and features, such as the graphical service map and flow analysis capabilities.
Installation Steps: Added step-by-step instructions for exposing the Hubble UI service and verifying the installation, including commands and links to related documentation.
Troubleshooting Section: Introduced a comprehensive troubleshooting guide covering common issues such as missing flows, port-forwarding problems, UI loading errors, and Retina installation issues, along with specific commands for debugging.
Prerequisites: Included a list of prerequisites for deploying Hubble UI, such as a running Kubernetes cluster and access to
kubectl.Improved Visuals: Updated descriptions and added new images for the Hubble UI dashboard and service map to enhance user understanding.
Related Issue
closes issue #1598
Checklist
git commit -S -s ...). See this documentation on signing commits.Screenshots (if applicable) or Testing Completed
Please add any relevant screenshots or GIFs to showcase the changes made.
Additional Notes
Add any additional notes or context about the pull request here.
Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.