Epic: Basic “How to Operate Self Hosted Gitpod” Guides and Aids

[lucasvaltl]

Summary

Provide basic guides and aides to help self-hosted Gitpod users operate their installation effectively and efficiently

Context

We want to help our self-hosted users not just install Gitpod, but also operate it successfully. It makes sense to provide a central repository with tips and tricks as well as best practices around this. This Epic is targeted at creating a basic, minimal version of this as a first step. This will be something that we need to improve and iterate on over time.

A good example here is sourcegraph's documentation on the administration of self-hosted Sourcegraph instances.

Value

Our users and customer's success is our success. Helping our users operate their self-hosted instances means that they can maximise the value they get out of them, helping everyone involved.

Acceptance Criteria

• How to operate Gitpod Guide: Installing, upgrading, configuration, observability.
• A list of reference metrics: what they mean and how to use them and tests that ensure consistency (requires coordination with platform and other teams!)

Measurement

• The above minimal list of documentation is in place.
• Feedback on this documentation is received and incorporated by at least 3 users

Complexities

Getting a reference list of metrics in place will require coordination with other teams. We will need to agree on the metrics that are important, potentially a standard as how they are structured, and how to test for their correctness over time via automated tests.

Issues

• [Documentation] Gitpod Self Hosted Monitoring Guide #8566
• New Enterprise Replicated Release Channel #10468
• Self Hosted Release & support Policy Documentation #10467 (requires New Enterprise Replicated Release Channel #10468)

[lucasvaltl]

We will finish the remaining tasks here which will give as a basic documentation about operating Gitpod. We want to then improve on this via #10464

[omarluq]

As a person who's setting up Self hosted Gitpod for an enterprise company right now I think this would be really helpful to have specially that there is no tech articles online talking about self hosting Gitpod at all! I'm thinking about publishing one after I finish setting it up.