Skip to content

[sh] (Finally) update docs according to 0.8.0 #3900

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.

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

Merged
merged 2 commits into from
Apr 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/self-hosted/install/configure-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ To configure the HTTPS certificates for your domain
```bash
kubectl create secret generic https-certificates --from-file=secrets/https-certificates
```
4. Afterwards, do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.

4. Afterwards, do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes.

### Using Let's Encrypt to generate HTTPS certificates

Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/install/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ This chart installs a MySQL database which gets Gitpod up and running but is not
mysql:
enabled: false
```
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
3. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes.
2 changes: 1 addition & 1 deletion docs/self-hosted/install/docker-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To connect to an existing Docker registry, perform the following steps:

> 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.

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

Make sure the resulting JSON file contains the credentials (there should be an `auths` section containing them as base64 encoded string).

Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/install/install-on-aws-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
url: /docs/self-hosted/latest/install/install-on-aws-script/
---

> 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.
> Since the `0.6.0` release (December 2019) the installers are deprecated. They are no longer working to their full extend and will be removed in a future release.

# Getting started with Gitpod on AWS

Expand All @@ -28,7 +28,7 @@ docker run --rm -it \
-e AWS_ACCESS_KEY_ID \
-e AWS_SECRET_ACCESS_KEY \
-v "$PWD/awsinstall":"/workspace" \
gcr.io/gitpod-io/self-hosted/installer:0.7.0 aws
gcr.io/gitpod-io/self-hosted/installer:0.8.0 aws
```

This will kickstart the installation process, authenticate with AWS and automatically set up your Gitpod deployment using Docker and Terraform.
Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/install/install-on-gcp-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
url: /docs/self-hosted/latest/install/install-on-gcp-script/
---

> 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.
> Since the `0.6.0` release (December 2019) the installers are deprecated. They are no longer working to their full extend and will be removed in a future release.

# Getting started with Gitpod on GCP

Expand All @@ -20,7 +20,7 @@ mkdir -p $PWD/gpinstall
docker run --rm -it \
-v $PWD/gcloud:/root/.config/gcloud \
-v $PWD/gpinstall:/workspace \
gcr.io/gitpod-io/self-hosted/installer:0.7.0 \
gcr.io/gitpod-io/self-hosted/installer:0.8.0 \
gcp
```

Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/install/install-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To install Gitpod in your Kubernetes cluster, follow these steps:
```console
helm repo add gitpod.io https://charts.gitpod.io

helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0
helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0
```

1. Configure [domain and https](../configure-ingress/).
Expand All @@ -52,7 +52,7 @@ To install Gitpod in your Kubernetes cluster, follow these steps:

1. Run the update
```console
helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0
helm install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0
```

1. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/).
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/install/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ To do this:
# The faster this location is (in terms of IO) the faster workspaces will initialize.
hostWorkspaceArea: /mnt/disks/ssd0/workspaces
```
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes.

> 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.
2 changes: 1 addition & 1 deletion docs/self-hosted/install/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Alternatively, you can configure it per Helm values file:
```
Replace `CLIENT_ID` and `SECRET` with their respective values.

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

## GitHub
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/).
Expand Down
4 changes: 2 additions & 2 deletions docs/self-hosted/install/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For more complex use case we recommend configuring more permanent means of persi
minio:
enabled: false
```
2. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes
2. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes

> 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.

Expand All @@ -46,4 +46,4 @@ For more complex use case we recommend configuring more permanent means of persi
secretKey: add-a-radom-secret-key-here
# insert custom config here
```
3. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes
3. Redeploy Gitpod using `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes
2 changes: 1 addition & 1 deletion docs/self-hosted/install/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This section should solve all errors that might come up during installation of G
- <your path here>
```

3. Do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
3. Do an `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes.


## 2. `helm install` fails with: "minio access key is required, please add a value to your values.yaml"
Expand Down
6 changes: 3 additions & 3 deletions docs/self-hosted/install/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ url: /docs/self-hosted/latest/install/upgrade/

# Gitpod Self-Hosted Upgrade Notes

## Upgrading Gitpod from v0.6.0 to v0.7.0
## Upgrading Gitpod from v0.6.0 to v0.8.0

With version 0.7.0 there are two major changes that require a user action. Both relate to the remote storage.
With version 0.8.0 there are two major changes that require a user action. Both relate to the remote storage.

### Built-in MinIO is now accessable at minio.your-gitpod-domain.com

When you install Gitpod on your own Kubernetes installation, it brings a built-in MinIO object storage (unless disabled). As of v0.7.0, the built-in MinIO instance is accessable at https://minio.your-gitpod-domain.com. That's the reason that (for security reasons) we do not set a default access and secret key for the built-in MinIO installation anymore. That means, you need to add your own random keys in your values files like this:
When you install Gitpod on your own Kubernetes installation, it brings a built-in MinIO object storage (unless disabled). As of v0.8.0, the built-in MinIO instance is accessable at https://minio.your-gitpod-domain.com. That's the reason that (for security reasons) we do not set a default access and secret key for the built-in MinIO installation anymore. That means, you need to add your own random keys in your values files like this:
```
minio:
accessKey: add-a-radom-access-key-here
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/install/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ If you want to change the default sizing (~ 8GiB per workspace) you should
controlPeriod: "15m"
```

2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.7.0` to apply the changes.
2. Do a `helm upgrade --install -f values.custom.yaml gitpod gitpod.io/gitpod --version=0.8.0` to apply the changes.