headlamp icon indicating copy to clipboard operation
headlamp copied to clipboard

Visualizing Gateway API Service Meshes

Open illume opened this issue 1 year ago • 20 comments

This issue is for an LXF mentorship project, see https://mentorship.lfx.linuxfoundation.org/project/62e272ef-e950-45dd-9c57-71d216d22ed2 There you can learn more and apply if interested. Please do not start this issue, as it is reserved for that project.


The Gateway API is becoming the standard for Kubernetes service networking, including ingress, traffic routing, and service mesh use cases. While Headlamp has built-in support for Gateway API resources, there is currently no integrated way to visualize and manage service mesh topologies, traffic flows, and policies. This feature aims to enhance Headlamp with a visual and interactive interface for understanding and managing service meshes built on the Gateway API.

People need to manage and visualize service mesh configurations and metrics within the Headlamp interface. Currently, there is no integrated way to monitor service meshes, which makes it difficult to manage microservices and troubleshoot issues effectively.

What users will benefit from this feature?

Users who want to manage service meshes from within Headlamp.

Integrating service mesh visualization with Headlamp using the Gateway API will streamline the management of service meshes, making it easier for users to monitor and troubleshoot their microservices architecture. This feature will enhance the overall usability of Headlamp for Kubernetes administrators and developers.

Additional context

There is are existing gateway API code for listing resources in the folder headlamp/frontend/src/components/gateway/GatewayDetails.tsx.

For visualization parts there's some docs and examples:

  • https://github.com/headlamp-k8s/plugins/pull/121
  • https://github.com/headlamp-k8s/headlamp/blob/61303e793f6a49ed21ee3422beb49fc7bd606549/docs/development/plugins/functionality/extending-the-map.md

illume avatar Jan 28 '25 04:01 illume

Hi! I’m really excited to work on this project and contribute to Headlamp. I’m looking forward to making it easier for users to visualize and manage service meshes with the Gateway API.

yugalkaushik avatar May 16 '25 16:05 yugalkaushik

Hi @illume , I am looking forward to contribute to Headlamp and learn with community. I have explored the resources shared above and run headlamp locally. Could you please share how the visualization is expected to look like? Also, is there a specific library you recommend for building the visual part, like D3.js or something else?

Thanks!

ps ( Docs is super helpful :- https://headlamp.dev/docs/latest/development/plugins/how-to )

AQIB-NAWAB avatar May 18 '25 17:05 AQIB-NAWAB

is this issue already done by @7908837174?

YashGupt29 avatar May 21 '25 06:05 YashGupt29

Yes, it was.

On Wed, 21 May, 2025, 11:38 YashGupta, @.***> wrote:

YashGupt29 left a comment (kubernetes-sigs/headlamp#2798) https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2896714499

is this issue already done by @7908837174 https://github.com/7908837174?

— Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2896714499, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLR2IIJSF7SSS7FW7QVQTUD27QJ5ZAVCNFSM6AAAAABV7TAHQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQOJWG4YTINBZHE . You are receiving this because you were mentioned.Message ID: @.***>

kallal79 avatar May 21 '25 08:05 kallal79

Hello.

This issue is reserved for the LXF mentorship project. It should be clear to not start the project. There is a selection process, and the person selected will be working on it.

illume avatar May 21 '25 21:05 illume

Thank you for the clarification.

On Thu, 22 May, 2025, 02:32 René Dudfield, @.***> wrote:

illume left a comment (kubernetes-sigs/headlamp#2798) https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2899224388

Hello.

This issue is reserved for the LXF mentorship project. It should be clear to not start the project. There is a selection process, and the person selected will be working on it.

— Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2899224388, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLR2IINGXCUC7A7IZNMAYTD27TSW5AVCNFSM6AAAAABV7TAHQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQOJZGIZDIMZYHA . You are receiving this because you were mentioned.Message ID: @.***>

kallal79 avatar May 21 '25 21:05 kallal79

@illume What is the selection process for this project do we need to include the proposal in the cover letter for LXF application process ?

upsaurav12 avatar May 23 '25 08:05 upsaurav12

  • CV, and cover letter are submitted.
  • Then reviewers look at them all... and make a short list.
  • Then some people are contacted for a short 30 minute interview.

illume avatar May 23 '25 08:05 illume

What will be the interview based on like technical or background?

yugalkaushik avatar May 24 '25 06:05 yugalkaushik

  • CV, and cover letter are submitted.
  • Then reviewers look at them all... and make a short list.
  • Then some people are contacted for a short 30 minute interview.

@illume is this same for all cnfc project

CodrAyush avatar May 26 '25 12:05 CodrAyush

@CodrAyush no, each is different.

illume avatar May 26 '25 12:05 illume

@illume what actually one has to write in cover letter?

CodrAyush avatar May 26 '25 17:05 CodrAyush

Hi @illume I tried finding some communication channel for headlamp, I came across a slack link but I was not able to join through it if there is any other channel for communication can you please provide the link

Darshit42 avatar May 30 '25 15:05 Darshit42

@Darshit42 Join kubernetes slack channel then try joining the headlamp link.

yugalkaushik avatar May 30 '25 16:05 yugalkaushik

@illume when will the results be announced?

yugalkaushik avatar Jun 01 '25 05:06 yugalkaushik

Hi @yugalkaushik , results may be announced on 4 June. Here is ref https://github.com/cncf/mentoring/blob/main/programs/lfx-mentorship/2025/02-Jun-Aug/README.md

AQIB-NAWAB avatar Jun 01 '25 05:06 AQIB-NAWAB

Awesome, thanks for the info!

On Sun, 1 Jun, 2025, 10:58 Aqib Nawab, @.***> wrote:

AQIB-NAWAB left a comment (kubernetes-sigs/headlamp#2798) https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2926561467

Hi @yugalkaushik https://github.com/yugalkaushik , Probably results may announced on 4 June. Here is ref https://github.com/cncf/mentoring/blob/main/programs/lfx-mentorship/2025/02-Jun-Aug/README.md

— Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2926561467, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLR2IINAZUJXCRRYJIUIFGL3BKFO7AVCNFSM6AAAAABV7TAHQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSMRWGU3DCNBWG4 . You are receiving this because you were mentioned.Message ID: @.***>

kallal79 avatar Jun 01 '25 08:06 kallal79

/assign

userAdityaa avatar Jun 06 '25 12:06 userAdityaa

Hey community, we have come up with a step-wise plan for it's implementation: You can see the plan here: https://kubernetes.slack.com/archives/C01FXB5E8ER/p1749643353319149 Feedback and suggestions are welcome!

userAdityaa avatar Jun 11 '25 12:06 userAdityaa

Thanks, I'll check it out!

On Wed, 11 Jun, 2025, 17:41 Aditya Chaudhary, @.***> wrote:

userAdityaa left a comment (kubernetes-sigs/headlamp#2798) https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2962444130

Hey community, we have come up with a step-wise plan for it's implementation: You can see the plan here: https://kubernetes.slack.com/archives/C01FXB5E8ER/p1749643353319149 Feedback and suggestions are welcome!

— Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/headlamp/issues/2798#issuecomment-2962444130, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLR2IIPKE2FNW2VHQA3WHW33DAMGFAVCNFSM6AAAAABV7TAHQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSNRSGQ2DIMJTGA . You are receiving this because you were mentioned.Message ID: @.***>

kallal79 avatar Jun 12 '25 02:06 kallal79

@userAdityaa

It would be good to see traffic numbers on network parts. For example, I'd like to know if one part is sending data and at what speed.

  • speed of transfer
  • Packet loss

illume avatar Jul 15 '25 07:07 illume

This project ended.

illume avatar Oct 07 '25 11:10 illume

Awesome, thanks for the update!

On Tue, 7 Oct, 2025, 16:55 René Dudfield, @.***> wrote:

Closed #2798 https://github.com/kubernetes-sigs/headlamp/issues/2798 as completed.

— Reply to this email directly, view it on GitHub https://github.com/kubernetes-sigs/headlamp/issues/2798#event-20138608778, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLR2IILX7QRLAG3KSP3KUKL3WOPKXAVCNFSM6AAAAABV7TAHQ2VHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMRQGEZTQNRQHA3TOOA . You are receiving this because you were mentioned.Message ID: @.***>

kallal79 avatar Oct 07 '25 12:10 kallal79