Epic: MVC Public Gitpod API

[JanKoehnlein]

Summary

In this epic we lay the foundation for a new public Gitpod API that can be consumed by Gitpod components as well as external clients. See this design doc for details.

Context

Extensively summed up in the design doc.

Value

• provide a uniform, reliable, stable and versioned API
• potential to consolidate our tech stack (e.g. replace JSON-RPC and REST interfaces)
• centralise common aspects such as authentication, rate-limiting, circuit-breaking etc.
• more in the design doc

Measurement

This epic has been successfully finished when

• we have hardened and proven our API Guidelines
• we feel confident about our choice of technologies
• we are convinced the API is ready for internal adoption

Steps

• Define gRPC interface files for a workspace API #8681
  • define proto files covering services to list workspaces, create and start workspace, and listen to status updates (including pre-builds and image builds)
  • gather experiences with/revise API design guidelines from the design doc
  • define and separate re-usable concepts, e.g. for paging, structured errors
  • generate implementations in TypeScript, Go and Java
• Deploy a Hello World server as initial Public API  #9229
  • workspace.get
  • workspace.getOwnerToken
• Epic: WorkspaceService public API and validate usage from IDE #9866

Out of scope

• Complete migration of the current JSON-RPC API
• Define separation between public and private API

[andymac4182]

Can you please make the design doc public.

Would be great to see a Terraform provider for managing Gitpod teams.

[loujaybee]

Hey @andymac4182 👋

A Terraform provider for managing Gitpod teams

This request is worthy of its own feature request / issue. This epic will most likely not be the fully-fledged API, but a subsection of some of the API's as well as a foundation for future API's. I doubt all of the CRUD API's required for a fully working Terraform provider will be possible within this issue/epic alone.

Can you please make the design doc public.
I'll look into this to see if there's anything sensitive or whether it's indeed possible to make public 🙏

[ajhalili2006]

What about authorization and authentication stuff? Will you go to the OpenID Connect route like others or the usual OAuth way like GitHub did? Will managing own OAuth clients be included in the epic roadmap?

[geropl]

The original epic from team IDE with the narrowly-scoped feature requests for the very first iteration: #8512

[jmls]

any updates on this ?

[geropl]

Hi @jmls, you can follow the current progress on the linked issue: #9229

As written in the description, we're currently focusing on our first internal client and their specific needs, and use the experience for that to lay out the foundations. How we're going to move forward beyond that specifically - e.g. how we prioritize adding more functionality is - up to future discussions.

[jldec]

Closing this epic and will follow up with new issues.
Significant foundational progress has been made on this Epic - nice work 🎉

@geropl has updated the title, description and the tasks completed so far.