Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Hubble control plane #1055

Open
anubhabMajumdar opened this issue Nov 21, 2024 · 0 comments · May be fixed by #1229
Open

Add documentation for Hubble control plane #1055

anubhabMajumdar opened this issue Nov 21, 2024 · 0 comments · May be fixed by #1229
Assignees
@kamilprz
Labels
area/documentation Improvements or additions to documentation control-plane/hubble good first issue Good for newcomers help wanted Extra attention is needed priority/0 P0
Milestone
1.0

Comments

@anubhabMajumdar
Copy link
Contributor

Is your feature request related to a problem? Please describe.

retina.sh is missing any documentation around Hubble control plane.
Suggested sections:

  • what is Hubble
  • installation
  • metrics
  • flow logs (CLI installation)
@anubhabMajumdar anubhabMajumdar added area/documentation Improvements or additions to documentation control-plane/hubble good first issue Good for newcomers help wanted Extra attention is needed priority/0 P0 labels Nov 21, 2024
@anubhabMajumdar anubhabMajumdar added this to the 1.0 milestone Nov 21, 2024
@SRodi SRodi mentioned this issue Dec 5, 2024
Closed
@kamilprz kamilprz self-assigned this Jan 7, 2025
@SRodi SRodi mentioned this issue Jan 7, 2025
Merged
7 tasks
github-merge-queue bot pushed a commit that referenced this issue Jan 10, 2025
@SRodi
chore(docs): Add doc for Hubble control plane and metrics (#1194)
e31cc3c 
# Description

Initial PR to add documentation for Hubble control plane and metrics.

## Related Issue

#1055 
#1093

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

![image](https://github.com/user-attachments/assets/eafb42b9-795d-42d6-86cf-a9271eaaea4c)


![image](https://github.com/user-attachments/assets/f491ce0e-4456-4190-bb54-7dfa64f7b626)


![image](https://github.com/user-attachments/assets/eab86779-ed75-4d94-877d-e6f48213e865)


![image](https://github.com/user-attachments/assets/d82cc71d-3d74-427d-8e91-e7c1c4b495d9)


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](../CONTRIBUTING.md) file for more
information on how to contribute to this project.
kamilprz pushed a commit to kamilprz/retina that referenced this issue Jan 13, 2025
@SRodi @kamilprz
chore(docs): Add doc for Hubble control plane and metrics (microsoft#…
4deb1bf 
…1194)

# Description

Initial PR to add documentation for Hubble control plane and metrics.

## Related Issue

microsoft#1055 
microsoft#1093

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [x] I have followed the project's style guidelines.
- [x] I have updated the documentation, if necessary.
- [x] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

![image](https://github.com/user-attachments/assets/eafb42b9-795d-42d6-86cf-a9271eaaea4c)


![image](https://github.com/user-attachments/assets/f491ce0e-4456-4190-bb54-7dfa64f7b626)


![image](https://github.com/user-attachments/assets/eab86779-ed75-4d94-877d-e6f48213e865)


![image](https://github.com/user-attachments/assets/d82cc71d-3d74-427d-8e91-e7c1c4b495d9)


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](../CONTRIBUTING.md) file for more
information on how to contribute to this project.
This was referenced Jan 15, 2025
Closed
Closed
Open
@SRodi SRodi mentioned this issue Jan 17, 2025
Open
7 tasks
@kamilprz kamilprz linked a pull request Jan 17, 2025 that will close this issue
chore(docs): Add docs about architecture and fix structure #1229
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kamilprz kamilprz

Labels
area/documentation Improvements or additions to documentation control-plane/hubble good first issue Good for newcomers help wanted Extra attention is needed priority/0 P0
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

chore(docs): Add docs about architecture and fix structure kamilprz/retina
2 participants
@anubhabMajumdar @kamilprz