Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[installer]: create readme #6767

Merged
merged 1 commit into from
Dec 7, 2021
Merged

[installer]: create readme #6767

merged 1 commit into from
Dec 7, 2021

Conversation

mrsimonemms
Copy link
Contributor

Description

Create an initial readme for the Installer. This is designed to provide an overview to the technical usage of the application.

Related Issue(s)

Fixes #6704

How to test

Read it and follow the instructions

Release Notes

[Installer]: create readme

Documentation

@roboquat roboquat added size/L and removed size/M labels Nov 18, 2021
@roboquat roboquat added size/XL and removed size/L labels Nov 18, 2021
kylos101
kylos101 reviewed Nov 19, 2021
View reviewed changes
Copy link
Contributor

@kylos101 kylos101 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there @mrsimonemms, Happy Friday!

🤝 🍺 🐝

installer/README.md Outdated
```shell
#!/bin/bash

VERSION="${VERSION:-main.1844}" # Build ID taken from https://werft.gitpod-dev.com/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is our versioning strategy? I see we've used releases here for self hosted in the past. Is this a product engineering question?

Short term it makes sense to hard code here. Long term, I'm not so sure, but it also may be too early to come up with a hardened long term solution.

LinkerD does stable and edge releases/tags. Stable sounds nice to me, like a cozy 🧸. "There be dragons" with Edge, but is also good for some parties.

It would be nice if our instruction to the end-user was a one-liner: To get the installer: curl -fsL https://run.gitpod.io/install | sh. That would download and run a script that::

  1. Check for prerequisites, like the OS being sane, Docker existing, etc.
  2. Get the latest stable version # somehow (probably from the latest stable Github release via API call, or baked into the script from our CI as a constant).
  3. Author this script mentioned here, and echo a message asking the user to add the github-installer.sh to their path.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see you opened #6766, good man @mrsimonemms ! 👍 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kylos101 I'm planning on writing an RFC for Gitpodders next week to discuss the options. My personal favourite is to do a regular monthly release on-or-around the 7th of the month (then I do a release on my birthday) and to number them as Ubuntu does - eg, this month's would be 21.11, next would be 21.12. These would be then treated as stable and anything in any branch would be treated as edge (I'm easy on terminology) - FYI, I don't think we have the capacity to offer an LTS version yet.

The one advantage to a regular monthly cadence is that the community can then expect things to drop on a certain date.

I think what I've done in the readme is good enough for today, but will need to be figured out in the next few weeks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed on all counts. 😄

Btw, RFC is a great idea. It's a tricky subject.

installer/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
installer/README.md Show resolved Hide resolved
installer/README.md Show resolved Hide resolved
installer/README.md Show resolved Hide resolved
installer/README.md Outdated Show resolved Hide resolved
@mrsimonemms mrsimonemms force-pushed the sje/installer-readme branch 7 times, most recently from a2c6bd8 to 91e2f5b Compare November 24, 2021 15:28
@mrsimonemms mrsimonemms mentioned this pull request Nov 24, 2021
Merged
@mrsimonemms mrsimonemms force-pushed the sje/installer-readme branch 6 times, most recently from 9dfb89d to 7e8e79b Compare November 25, 2021 13:38
@mrsimonemms mrsimonemms marked this pull request as ready for review November 25, 2021 13:38
@mrsimonemms mrsimonemms requested a review from kylos101 November 25, 2021 13:40
@mrsimonemms mrsimonemms force-pushed the sje/installer-readme branch 2 times, most recently from dadc84e to be418d4 Compare November 29, 2021 14:48
@mrsimonemms mrsimonemms mentioned this pull request Nov 30, 2021
Merged
princerachit
princerachit reviewed Nov 30, 2021
View reviewed changes
installer/README.md Outdated Show resolved Hide resolved
princerachit
princerachit reviewed Nov 30, 2021
View reviewed changes
Copy link
Contributor

@princerachit princerachit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL

installer/README.md Outdated Show resolved Hide resolved
installer/README.md Show resolved Hide resolved
installer/README.md Outdated

```shell
# Checks that your cluster is ready to install Gitpod
gitpod-installer validate cluster --kubeconfig /root/.kube/config --config /gitpod/gitpod.config.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For previous and all other commands please update the binary name. It should be installer, if you want to continue with gitpod-installer then we shoudl update the build command

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly the path to config file is confusing as we are using absolute path which will be different for users. I would rather use relative paths

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot on the abs paths - I'll switch to the standard /path/to/file

@princerachit
Copy link
Contributor

I will suggest you to paste the output of each command here or a screenshot in the comments of this PR

@mrsimonemms mrsimonemms force-pushed the sje/installer-readme branch 2 times, most recently from 560df72 to fe2b266 Compare December 2, 2021 09:00
@csweichel
Copy link
Contributor

/lgtm

@roboquat roboquat added the lgtm label Dec 7, 2021
@roboquat
Copy link
Contributor

roboquat commented Dec 7, 2021

LGTM label has been added.

Git tree hash: 420244a66575da82218000aa842b7b1c3a5c60e7

@roboquat
Copy link
Contributor

roboquat commented Dec 7, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: csweichel

Associated issue: #6704

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@csweichel
Copy link
Contributor

csweichel commented Dec 7, 2021 •
edited by werft-gitpod-dev-com bot
Loading

/werft run no-preview

👍 started the job as gitpod-build-sje-installer-readme.24

@roboquat roboquat merged commit 73772a3 into main Dec 7, 2021
@roboquat roboquat deleted the sje/installer-readme branch December 7, 2021 12:32
@roboquat roboquat added deployed: workspace Workspace team change is running in production deployed Change is completely running in production labels Dec 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@princerachit princerachit princerachit left review comments

@kylos101 kylos101 Awaiting requested review from kylos101

@aledbf aledbf Awaiting requested review from aledbf

@csweichel csweichel Awaiting requested review from csweichel

Assignees

@csweichel csweichel

Labels
approved deployed: workspace Workspace team change is running in production deployed Change is completely running in production release-note size/XL team: workspace Issue belongs to the Workspace team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[installer]: create a readme
5 participants
@mrsimonemms @princerachit @csweichel @roboquat @kylos101