Skip to content

Commit a9c26c4

Browse files
authored
[self-hosted] Prepare release of 0.7.0 (gitpod-io#3099)
* [docs] Make Self-hosted version explicit (0.7.0) * [chart] bump version: 0.7.0-beta1 * [docs] Update for 0.7.0 * [docs] More troubleshooting from 0.6.0->0.7.0 upgrade experience * [docs] Add 'Upgrade' section * [chart] bump version to 0.7.0
1 parent 192ef65 commit a9c26c4

12 files changed

+52
-20
lines changed

chart/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Copyright (c) 2020 Gitpod GmbH. All rights reserved.
22
# Licensed under the MIT License. See License-MIT.txt in the project root for license information.
33

4-
version: 0.6.0-beta5
4+
version: "0.7.0"
55

66
hostname: localhost
77
# ingressModes determines how Gitpod makes workspaces and their ports available. Possible values are:

docs/self-hosted/install/configure-ingress.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ To configure the HTTPS certificates for your domain
5555
```bash
5656
kubectl create secret generic https-certificates --from-file=secrets/https-certificates
5757
```
58-
4. Afterwards, do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
58+
4. Afterwards, do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
5959
6060
6161
### Using Let's Encrypt to generate HTTPS certificates
6262
63-
The most accessible means of obtaining HTTPS certificates is using [Let's Encrypt](https://letsencrypt.org/). It provides free certificats to anybody who can prove ownership of a domain.
63+
The most accessible means of obtaining HTTPS certificates is using [Let's Encrypt](https://letsencrypt.org/). It provides free certificates to anybody who can prove ownership of a domain.
6464
Let's Encrypt offers a program called [certbot](https://certbot.eff.org/) to make acquiring certificates as striaght forward as possible.
6565
6666
Assuming you have [certbot](https://certbot.eff.org/) installed, the following script will generate and configure the required certificates (notice the placeholders):

docs/self-hosted/install/database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ This chart installs a MySQL database which gets Gitpod up and running but is not
3838
mysql:
3939
enabled: false
4040
```
41-
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
41+
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.

docs/self-hosted/install/docker-registry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To connect to an existing Docker registry, perform the following steps:
4848
4949
> This does not work for Google Cloud Registries because their login tokens are short-lived. See the [example](#example-google-cloud-registry-credentials) below on how to configure it.
5050
51-
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
51+
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
5252
5353
Make sure the resulting JSON file contains the credentials (there should be an `auths` section containing them as base64 encoded string).
5454

docs/self-hosted/install/install-on-aws-script.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
url: /docs/self-hosted/latest/install/install-on-aws-script/
33
---
44

5-
> For this release (0.6.0, December 2019) the installers are broken. We're working in bringing those with the next release (January 2020).
5+
> Since the `0.6.0` release (December 2019) the installers are broken. We're working on bringing those back with one of the next releases.
66
77
# Getting started with Gitpod on AWS
88

@@ -28,7 +28,7 @@ docker run --rm -it \
2828
-e AWS_ACCESS_KEY_ID \
2929
-e AWS_SECRET_ACCESS_KEY \
3030
-v "$PWD/awsinstall":"/workspace" \
31-
gcr.io/gitpod-io/self-hosted/installer:latest aws
31+
gcr.io/gitpod-io/self-hosted/installer:0.7.0 aws
3232
```
3333

3434
This will kickstart the installation process, authenticate with AWS and automatically set up your Gitpod deployment using Docker and Terraform.

docs/self-hosted/install/install-on-gcp-script.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
url: /docs/self-hosted/latest/install/install-on-gcp-script/
33
---
44

5-
> For this release (0.6.0, December 2019) the installers are broken. We're working in bringing those with the next release (January 2020).
5+
> Since the `0.6.0` release (December 2019) the installers are broken. We're working on bringing those back with one of the next releases.
66
77
# Getting started with Gitpod on GCP
88

@@ -20,7 +20,7 @@ mkdir -p $PWD/gpinstall
2020
docker run --rm -it \
2121
-v $PWD/gcloud:/root/.config/gcloud \
2222
-v $PWD/gpinstall:/workspace \
23-
gcr.io/gitpod-io/self-hosted/installer:latest \
23+
gcr.io/gitpod-io/self-hosted/installer:0.7.0 \
2424
gcp
2525
```
2626

docs/self-hosted/install/install-on-kubernetes.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,28 @@ To install Gitpod in your Kubernetes cluster, follow these steps:
3636
```console
3737
helm repo add gitpod.io https://charts.gitpod.io
3838

39-
helm install -f values.custom.yaml gitpod gitpod.io/gitpod
39+
helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0
4040
```
4141

42-
1. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/).
43-
4442
1. Configure [domain and https](../configure-ingress/).
4543

44+
1. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/).
45+
4646
1. Go to [https://\<your-domain.com\>](https://\<your-domain.com\>) and follow the steps to complete the installation.
4747

4848

49+
## Upgrade
50+
51+
1. Check the [Upgrade Guide](../upgrade/) and follow the steps outlined there.
52+
53+
1. Run the update
54+
```console
55+
helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0
56+
```
57+
58+
1. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/).
59+
60+
4961
## Recommended Configuration
5062

5163
By default, the Helm chart installs a working Gitpod installation in a lot of scenarios. Yet, there are certain things you might want to review when installing Gitpod for long term use and/or a bigger audience:

docs/self-hosted/install/nodes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ To do this:
4141
# The faster this location is (in terms of IO) the faster workspaces will initialize.
4242
hostWorkspaceArea: /mnt/disks/ssd0/workspaces
4343
```
44-
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
44+
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
4545

4646
> Note that Helm does _not_ merge hierarchies in a single file. Please make sure there is only ever _one_ `components` hierarchy or the last one overwrites all previous values.

docs/self-hosted/install/oauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Alternatively, you can configure it per Helm values file:
4646
```
4747
Replace `CLIENT_ID` and `SECRET` with their respective values.
4848

49-
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
49+
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
5050

5151
## GitHub
5252
To authenticate your users with GitHub you need to create a [GitHub OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).

docs/self-hosted/install/storage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For more complex use case we recommend configuring more permanent means of persi
3333
minio:
3434
enabled: false
3535
```
36-
2. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes
36+
2. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes
3737

3838
> Note that Helm does _not_ merge hierarchies in a single file. Please make sure there is only ever _one_ `components` hierarchy or the last one overwrites all previous values.
3939

@@ -46,4 +46,4 @@ For more complex use case we recommend configuring more permanent means of persi
4646
secretKey: add-a-radom-secret-key-here
4747
# insert custom config here
4848
```
49-
3. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes
49+
3. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes

docs/self-hosted/install/troubleshooting.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ url: /docs/self-hosted/latest/install/troubleshooting/
66

77
This section should solve all errors that might come up during installation of Gitpod.
88

9-
## `ws-daemon` is stuck in `Init: 0/1`
109

11-
### Diagnose
10+
## 1. `ws-daemon` is stuck in `Init: 0/1`
11+
1212
`kubectl describe pod ws-daemon-...` gives:
1313
`MountVolume.SetUp failed for volume "node-fs1" : hostPath type check failed: /run/containerd/io.containerd.runtime.v1.linux/k8s.io is not a directory`
1414

@@ -27,4 +27,24 @@ This section should solve all errors that might come up during installation of G
2727
- <your path here>
2828
```
2929
30-
3. Do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
30+
3. Do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
31+
32+
33+
## 2. `helm install` fails with: "minio access key is required, please add a value to your values.yaml"
34+
35+
Since `0.7.0` minio requires custom credentials to be configured.
36+
37+
### Solution
38+
1. Follow the [Upgrade Guide](../upgrade/).
39+
40+
41+
## 3. After upgrade, the `minio` Pod is stuck in `ContainerCreating`
42+
43+
This is caused by a bug in the minio Helm chart which blocks itself on updates.
44+
45+
### Solution
46+
1. `kubectl scale deployments/minio --replicas=0`
47+
48+
1. `kubectl scale deployments/minio --replicas=1`
49+
50+
1. Wait until the pod comes up.

docs/self-hosted/install/workspaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ If you want to change the default sizing (~ 8GiB per workspace) you should
4646
controlPeriod: "15m"
4747
```
4848
49-
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod` to apply the changes.
49+
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.

0 commit comments

Comments
 (0)