Create gp info command

[loujaybee]

Create a gp info command that includes:

• Workspace class name
• Resources available (CPU/RAM/Storage)
• URL
• Workspace cluster and region

To replace the use of the respective environment variables.

---

Original description

Deprecate all "default environment variables" in favour of either gp cli wrapper, or namespaced variables.

We currently have listed "default" environment variables listed in the documentation. For a user to understand which environment variables they can rely on, they have to bounce from the docs to the product. It would be good if they can discover these variables more easily using an approach more familiar to "linux", e.g. through gp, and/or man pages.

Some preferred experience could be:

1. Move all default environment variables under gp
2. Namespace protected environment variabes with a prefix, etc to make it clear which ones can be relied upon.

Examples:

• GITPOD_IDE_ALIAS (https://github.com/gitpod-io/website/pull/2562/files)

Important: This doesn't mean breaking backwards compatibility, or removing the env variables (yet) but introducing an alias, or a clear API, such as the gp wrapper, to open the opportunity for future removal as an integration point within the product.

Related issues:

• [gp cli] gp command to print/show workspace class #10572

[loujaybee]

Design TBD, some suggestions for the gp interface (from @akosyakov):

Maybe we can have gp info which basically prints information exposed via supervisor info with some flags which is a selector. I am not sure about idea of adding a new command for each bit of information. i.e gp info --filter=workspaceClass prints workspace class, maybe --json to provide machine-readable.

[loujaybee]

Not sure which labels are best for this issue, would appreciate it being tagged up 🙏

@gitpod-io/engineering-workspace could you label this up with any labels you think appropriate? Adding to the workspace inbox for labelling, but not urgent, more a long-term suggestion that we can gradually move towards.

[akosyakov]

To clarify: env vars are internal implementations of supervisor, they are there, but they should not be surfaced to user in docs, rather gp cli.

[atduarte]

@loujaybee Are there other env vars that you believe should be converted into a gp command other than the workspace class / info?

[loujaybee]

@atduarte not that i know off the top of my head, would need to audit / look through the current variables.

[atduarte]

@loujaybee based on that, changed the issue to be more actionable to the workspace team. LMKWYT. I'm aware we are modifying the gp top to include the workspace class name, but this seems worth it nonetheless.