Epic: Local preview "installation" method #9075

lucasvaltl · 2022-04-01T15:15:02Z

Summary

Create a way to install a basic version of self-hosted Gitpod on a local machine for trial purposes. Should require minimal effort (time to wow) for most somewhat technical enterprise users.

Context

The easiest way to try out Gitpod is via our SaaS offering (gitpod.io). However, there are users and companies where this is not possible because of internal compliance issues and other restrictions (e.g. can only use vetted providers of software if it is running somewhere else). For these, Self-Hosted is the only viable path. However, our current self-hosted installation method requires you to set up an entire Kubernetes cluster just to try out Gitpod for the first time and see what it is all about. In a large corporation (exactly the ones that cannot use the SaaS version) this might mean going through internal hurdles to provision said cluster. Further this requires k8s experience.

We want to create a way for these corporate users that are technical but may not have deep Kubernetes expertise to experience Gitpod before they go to the next phase of investing more into it and getting for example a team to spin up a k8s cluster and install Gitpod self-hosted.

Value

Enables those that cannot or do not want to run Gitpod SaaS to try out Gitpod, (hopefully) be amazed by it and potentially become full time users, and then potentially tell their friends / colleagues about it and start pushing for a wider implementation.

Acceptance Criteria

Gitpod can be installed via simple and straight forward way that most somewhat technical enterprise users can successfully go through. It is a tradeoff: minimizing dependencies, minimizing installation steps vs. maximizing amount of addressable target users.
Support for Mac, Windows and Linux

Measurement

Measure amount of successful installations
Amount of new leads we get from users that first used this installation method should be going up dramatically
Amount of support questions we get related to basic K8s concepts should go down

Complexities

Runtime: docker vs. vm
Certs
DNS resolution: localhost, DNS masks etc.

Related Issues / Work

Issues:

For milestones, see internal planning document

csweichel · 2022-05-30T15:19:12Z

Current work: https://github.com/gitpod-io/preview-install

meysholdt · 2022-05-30T15:56:22Z

On the Platform team, we used a Hack Friday to explore solutions around DNS and certs. Find the notes here:
https://www.notion.so/gitpod/Platform-Hack-Friday-3341419375c0499891499da281294151

JohannesLandgraf · 2022-05-30T17:02:41Z

Current work from @aledbf: https://gitpod.slack.com/archives/C02F19UUW6S/p1653860753279139

Fixes #9075 This PR adds a new install method called `preview` under the `install` directory. This includes a sh script i.e `entrypoint.sh` that gets loaded into a docker container in the `Dockerfile`. This `entrypoint.sh` does the following: - Checks for minimum system requirements - Generates a root certificate using `mkcerts`, and loads into the host's `/tmp/gitpod/gitpod-ca.crt`. - Renders `cert-manager` resources, self-signed Gitpod into `/var/lib/rancher/k3s/server/manifests`. - Initialises `k3s` inside the container. Signed-off-by: Tarun Pothulapati <[email protected]>

JohannesLandgraf · 2022-06-15T11:29:06Z

When do we expect to ship this? cc @lucasvaltl @Pothulapati

Fixes #9075 This PR adds a new install method called `preview` under the `install` directory. This includes a sh script i.e `entrypoint.sh` that gets loaded into a docker container in the `Dockerfile`. This `entrypoint.sh` does the following: - Checks for minimum system requirements - Generates a root certificate using `mkcerts`, and loads into the host's `/tmp/gitpod/gitpod-ca.crt`. - Renders `cert-manager` resources, self-signed Gitpod into `/var/lib/rancher/k3s/server/manifests`. - Initialises `k3s` inside the container. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati · 2022-06-15T17:28:54Z

The basic version of the preview install just got merged with #10532, but we still have the following things to do before we can close this Issue:

Publish the preview install image on the latest tag.
Documentation
User friendly output.

We might be able to ship these above things this week, but the support M1 Mac's and Windows is still in the works!

Part of #9075 This PR adds user friendly output to the `preview` install docker container. Signed-off-by: Tarun Pothulapati <[email protected]>

Part of #9075 This PR adds user friendly output to the preview install docker container by adding a new program prettylog that looks at the output of the entry-point.sh and just adds status updates and spinners. This feels easier instead of adding the same status updates in bash. The status updates are also kept as simple as possible and any additional instructions (URL, and certs) will be added to the documentation instead of here. Feel free to post here if you think it would be better to have them here in the script. Signed-off-by: Tarun Pothulapati <[email protected]>

Fixes #9075 This PR adds a new install method called `preview` under the `install` directory. This includes a sh script i.e `entrypoint.sh` that gets loaded into a docker container in the `Dockerfile`. This `entrypoint.sh` does the following: - Checks for minimum system requirements - Generates a root certificate using `mkcerts`, and loads into the host's `/tmp/gitpod/gitpod-ca.crt`. - Renders `cert-manager` resources, self-signed Gitpod into `/var/lib/rancher/k3s/server/manifests`. - Initialises `k3s` inside the container. Signed-off-by: Tarun Pothulapati <[email protected]>

Part of #9075 This PR adds user friendly output to the preview install docker container by adding a new program prettylog that looks at the output of the entry-point.sh and just adds status updates and spinners. This feels easier instead of adding the same status updates in bash. The status updates are also kept as simple as possible and any additional instructions (URL, and certs) will be added to the documentation instead of here. Feel free to post here if you think it would be better to have them here in the script. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati · 2022-06-22T08:40:00Z

With https://github.com/gitpod-io/website/pull/2261, We have a 🛹 version of this up.

Windows and Mac support is being worked on right now on high priority, and the docs will be updated once we have something up!

Fixes gitpod-io#9075 This PR adds a new install method called `preview` under the `install` directory. This includes a sh script i.e `entrypoint.sh` that gets loaded into a docker container in the `Dockerfile`. This `entrypoint.sh` does the following: - Checks for minimum system requirements - Generates a root certificate using `mkcerts`, and loads into the host's `/tmp/gitpod/gitpod-ca.crt`. - Renders `cert-manager` resources, self-signed Gitpod into `/var/lib/rancher/k3s/server/manifests`. - Initialises `k3s` inside the container. Signed-off-by: Tarun Pothulapati <[email protected]>

Part of gitpod-io#9075 This PR adds user friendly output to the preview install docker container by adding a new program prettylog that looks at the output of the entry-point.sh and just adds status updates and spinners. This feels easier instead of adding the same status updates in bash. The status updates are also kept as simple as possible and any additional instructions (URL, and certs) will be added to the documentation instead of here. Feel free to post here if you think it would be better to have them here in the script. Signed-off-by: Tarun Pothulapati <[email protected]>

lucasvaltl · 2022-10-11T19:24:40Z

Removing from Q3 roadmap and closing this as we need to replan this - most of this has been done though, the issues left are either hard to do or not planned.

lucasvaltl added the type: epic label Apr 1, 2022

lucasvaltl added this to 🚚 Security, Infrastructure, and Delivery Team (SID) Apr 1, 2022

lucasvaltl moved this to 🧊Backlog in 🚚 Security, Infrastructure, and Delivery Team (SID) Apr 1, 2022

lucasvaltl self-assigned this Apr 1, 2022

lucasvaltl moved this from 🧊Backlog to 🤝Proposed in 🚚 Security, Infrastructure, and Delivery Team (SID) Apr 1, 2022

lucasvaltl added the team: delivery Issue belongs to the self-hosted team label Apr 12, 2022

lucasvaltl changed the title ~~Epic: Single Command Self-Hosted Install~~ Epic: Local installation method to try out Gitpod May 10, 2022

lucasvaltl changed the title ~~Epic: Local installation method to try out Gitpod~~ Epic: Local preview installation method that is as simple as possible for most users May 10, 2022

lucasvaltl changed the title ~~Epic: Local preview installation method that is as simple as possible for most users~~ Epic: Local preview installation method May 10, 2022

Pothulapati self-assigned this May 13, 2022

lucasvaltl moved this from 🤝Proposed to 📓Scheduled in 🚚 Security, Infrastructure, and Delivery Team (SID) May 30, 2022

lucasvaltl moved this from 📓Scheduled to ⚒In Progress in 🚚 Security, Infrastructure, and Delivery Team (SID) May 31, 2022

This was referenced Jun 1, 2022

Add contributing guidelines with a local kubernetes cluster or minikube #6563

Closed

Epic: Improve Self-Hosted Day 2 Documentation #10464

Closed

Restructure Self Hosted Docs around Types of documentation #10465

Closed

Pothulapati mentioned this issue Jun 8, 2022

[self-hosted] Gitpod local preview install method #10532

Merged

lucasvaltl mentioned this issue Jun 13, 2022

Epic: Proof of Value Reference Architecture #10622

Closed

4 tasks

roboquat closed this as completed in #10532 Jun 15, 2022

Repository owner moved this from ⚒In Progress to ✨Done in 🚚 Security, Infrastructure, and Delivery Team (SID) Jun 15, 2022

Pothulapati reopened this Jun 15, 2022

Repository owner moved this from ✨Done to 📓Scheduled in 🚚 Security, Infrastructure, and Delivery Team (SID) Jun 15, 2022

Pothulapati added a commit that referenced this issue Jun 16, 2022

[preview-install] Add user-friendly output

0aa7f0d

Part of #9075 This PR adds user friendly output to the `preview` install docker container. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati mentioned this issue Jun 16, 2022

[preview-install] Add user-friendly output #10695

Merged

Pothulapati added a commit that referenced this issue Jun 16, 2022

[preview-install] Add user-friendly output

b44bc95

Part of #9075 This PR adds user friendly output to the `preview` install docker container. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati added a commit that referenced this issue Jun 16, 2022

[preview-install] Add user-friendly output

d122a6b

Part of #9075 This PR adds user friendly output to the `preview` install docker container. Signed-off-by: Tarun Pothulapati <[email protected]>

Pothulapati added a commit that referenced this issue Jun 16, 2022

[preview-install] Add user-friendly output

c0aa15d

Part of #9075 This PR adds user friendly output to the `preview` install docker container. Signed-off-by: Tarun Pothulapati <[email protected]>

lucasvaltl mentioned this issue Jun 17, 2022

[installer] mysql helm global.storageClass may need to be set #6789

Closed

lucasvaltl moved this from 📓Scheduled to ⚒In Progress in 🚚 Security, Infrastructure, and Delivery Team (SID) Jun 20, 2022

Pothulapati mentioned this issue Jun 20, 2022

Platform information in gitpod telemetry #10766

Closed

gtsiolis mentioned this issue Jun 23, 2022

Epic: Improve Community Contributor Experience #6466

Open

8 tasks

lucasvaltl changed the title ~~Epic: Local preview installation method~~ Epic: Local preview "installation" method Jun 28, 2022

This was referenced Jul 18, 2022

Gitea support #80

Open

Use custom images / versions for local preview #11436

Closed

lucasvaltl closed this as completed Oct 11, 2022

Repository owner moved this from ⚒In Progress to ✨Done in 🚚 Security, Infrastructure, and Delivery Team (SID) Oct 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Epic: Local preview "installation" method #9075

Epic: Local preview "installation" method #9075

lucasvaltl commented Apr 1, 2022 •

edited

Loading

csweichel commented May 30, 2022

meysholdt commented May 30, 2022

JohannesLandgraf commented May 30, 2022

JohannesLandgraf commented Jun 15, 2022

Pothulapati commented Jun 15, 2022 •

edited

Loading

Pothulapati commented Jun 22, 2022

lucasvaltl commented Oct 11, 2022

Epic: Local preview "installation" method #9075

Epic: Local preview "installation" method #9075

Comments

lucasvaltl commented Apr 1, 2022 • edited Loading

Summary

Context

Value

Acceptance Criteria

Measurement

Complexities

Related Issues / Work

Issues:

csweichel commented May 30, 2022

meysholdt commented May 30, 2022

JohannesLandgraf commented May 30, 2022

JohannesLandgraf commented Jun 15, 2022

Pothulapati commented Jun 15, 2022 • edited Loading

Pothulapati commented Jun 22, 2022

lucasvaltl commented Oct 11, 2022

lucasvaltl commented Apr 1, 2022 •

edited

Loading

Pothulapati commented Jun 15, 2022 •

edited

Loading