group and give description for gitpod ports

[konne]

the current port list just contains all currently shared ports.

This is very confusing because we open for example a lot of nodejs debugging ports that are not needed to be used by the users.
It would be great to first have a possibility in the gitpod.yml to give a group name

ports:
  - port: 33000-33999
     group: debugging
     state: closed
     onOpen: ignore
   - port: 80-2000
     group: web
     state: opened
   - port: 6008
     group: VNC
     state: closed

On Top it would be even great to give each port also a description that would be visible beside the port number like

ports:

• port: 33000-33999
  ...

• port 330100

  • description: Debug API gateway

• port 330101

  • description: Debug Service1

• port 6008

  • description: VNC

[loujaybee]

There is another use case for this: In some cases, frameworks, or even integrations with Gitpod open ports for their own use, however, it's not always explicit where this port came from/why it's been opened. Having descriptions and encouraging explicit naming or descriptions of ports could make it more clear when there's an unknown / undefined opened port, possibly by grouping or labeling these ports as unknown. We could also take a look at guessing what the port might be related to by inspecting the parent process.

[akosyakov]

@konne It actually supported:

But we are missing docs about it, sorry.

[konne]

@akosyakov thx & cool. I will asap add it to our config.

[akosyakov]

I'm closing it, please reopen if it does not work.

For auto derived name and description: #3374

[konne]

@akosyakov do you also plan to implement grouping.

• server
  • 80
  • 8080
• debugging
  • 5061
  • 5062
  • 5062,..
    This was also part of the idea / feature request.

[konne]

@akosyakov names and descriptions are working

[akosyakov]

Should it work based on name attribute or you think there should be another attribute? Would you file another issue just about grouping? 🙏

[konne]

@akosyakov can you please add this ticket to the epic, thanks

#10294