[public-api] Simple CLI tool to interact with Public API

[easyCZ]

Description

Adds api workspaces get --id 123 --token "foo-bar" to interact with Public API. Creates a dir apiundercmd` and gives code-ownership to WebApp.

 ./gpctl 
Gpctl controls a Gitpod installation

Usage:
  gpctl [command]

Available Commands:
  api         Interact with Public API services
  clusters    Controls and inspects cluster
  completion  Generate completion script
  debug       Helps with debugging a component
  help        Help about any command
  imagebuilds Controls and inspects workspace Docker image builds
  workspaces  Controls and inspects workspaces in the Gitpod installation

Flags:
  -h, --help                     help for gpctl
  -c, --kubeconfig string        Path to the kubeconfig file used for connecting to the cluster (default "$HOME/.kube/config")
  -o, --output-format string     Output format. One of: string|json|jsonpath|template (default "template")
      --output-template string   Output format Go template or jsonpath. Use with -o template or -o jsonpath

Use "gpctl [command] --help" for more information about a command.

./gpctl api workspaces get --id 123 --token foo-bar --address api.mp-papi-cmd-yolo.staging.gitpod-dev.com:443
INFO[0000] Estabilishing gRPC connection against api.mp-papi-cmd-yolo.staging.gitpod-dev.com:443 
{"result":{"workspaceId":"123","ownerId":"mock_owner","projectId":"mock_project_id","context"{"contextUrl":"https://github.com/gitpod-io/gitpod"},"description":"This is a mock response"}}%  

Related Issue(s)

Fixes #

How to test

Test the CLI works

cd dev/gpctl
go run main.go api workspaces get --id 123 --token foo-bar --address api.mp-papi-cmd-yolo.staging.gitpod-dev.com:443

Test with a local instance of Public API

1. Navigate to preview env on main
2. Open dev console and run

await window._gp.gitpodService.server.generateNewGitpodToken({ type: 1, scopes: ["function:getGitpodTokenScopes",
	"function:getWorkspace",
	"function:getWorkspaces",
	"function:listenForWorkspaceInstanceUpdates",
	"resource:default",]})

, this will obtain a token you can use to access the through a CLI
4. Start the Public API locally with cd components/public-api-server && go run main.go
5. Hit the local API using the CLI, here we need to use --insecure because we're not serving TLS certs

go run main.go api workspaces get --id $WORKSPACE_ID --token $TOKEN --insecure --address localhost:9501

You'll likely get Not Found. To get a response, start a workspace on the main preview env and use its ID as $WORKSPACE_ID

Release Notes

NONE

Documentation

NONE

/uncc

• /werft without-vm=true

[csweichel]

should be part of gpctl imho

[easyCZ]

@csweichel That's a good point. How do we want to use the first iteration? Should it eventually be a CLI that externals should be able to interact with to consume the API? Or do we want to merge it with gpctl which has an explicit purpose of being used by Gitpod engineers to operate the system.

My inclination is to keep it separate and gear more towards a CLI for the API only, which can be published and consumed by externals.

[easyCZ]

/werft run without-vm=true

👍 started the job as gitpod-build-mp-papi-cmd-yolo.8
(with .werft/ from main)

[csweichel]

@easyCZ I'd start with the latter - go for gpctl. It gives you more freedom to move quickly without having to consider breaking changes or the experience of others. If we see a need for a CLI for our public API we can always transform that part of gpctl.

Also, we're noticing a trend where gpctl might become part of the product down the road, if just for "integrators". There's a lot of functionality in there already that's handy in e.g. a self-hosted context.

[easyCZ]

/werft run without-vm=true

👍 started the job as gitpod-build-mp-papi-cmd-yolo.12
(with .werft/ from main)

[easyCZ]

@csweichel @geropl I've now moved this under gpctl. I've put it under an api directory to slightly better manage code-ownership and allow us to make changes without needing workspace reviews.

[laushinka]

I've tested this and it works like a charm. Can't wait for this to be merged 😍 Thanks for this, @easyCZ!

[sagor999]

LGTM except for a minor nit.

/hold

[easyCZ]

/unhold