From f9974d02af54c37bd42e7e5ff1ac99b14e08712e Mon Sep 17 00:00:00 2001 From: Gero Posmyk-Leinemann Date: Mon, 15 Mar 2021 11:06:11 +0000 Subject: [PATCH 1/2] [docs] Bump to 0.8.0 --- docs/self-hosted/install/configure-ingress.md | 3 +-- docs/self-hosted/install/database.md | 2 +- docs/self-hosted/install/docker-registry.md | 2 +- docs/self-hosted/install/install-on-aws-script.md | 2 +- docs/self-hosted/install/install-on-gcp-script.md | 2 +- docs/self-hosted/install/install-on-kubernetes.md | 4 ++-- docs/self-hosted/install/nodes.md | 2 +- docs/self-hosted/install/oauth.md | 2 +- docs/self-hosted/install/storage.md | 4 ++-- docs/self-hosted/install/troubleshooting.md | 2 +- docs/self-hosted/install/upgrade.md | 6 +++--- docs/self-hosted/install/workspaces.md | 2 +- 12 files changed, 16 insertions(+), 17 deletions(-) diff --git a/docs/self-hosted/install/configure-ingress.md b/docs/self-hosted/install/configure-ingress.md index b80a1f5c4923c4..3bd5f47cb31f54 100644 --- a/docs/self-hosted/install/configure-ingress.md +++ b/docs/self-hosted/install/configure-ingress.md @@ -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 diff --git a/docs/self-hosted/install/database.md b/docs/self-hosted/install/database.md index a1fdd416cd7e85..b536ff370b3210 100644 --- a/docs/self-hosted/install/database.md +++ b/docs/self-hosted/install/database.md @@ -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. diff --git a/docs/self-hosted/install/docker-registry.md b/docs/self-hosted/install/docker-registry.md index 07e9206e8524e0..e54d9ef53c0b52 100644 --- a/docs/self-hosted/install/docker-registry.md +++ b/docs/self-hosted/install/docker-registry.md @@ -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). diff --git a/docs/self-hosted/install/install-on-aws-script.md b/docs/self-hosted/install/install-on-aws-script.md index 8b62211fe230c2..31774e0a894792 100644 --- a/docs/self-hosted/install/install-on-aws-script.md +++ b/docs/self-hosted/install/install-on-aws-script.md @@ -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. diff --git a/docs/self-hosted/install/install-on-gcp-script.md b/docs/self-hosted/install/install-on-gcp-script.md index 348e9beb9a4406..6271df5527097a 100644 --- a/docs/self-hosted/install/install-on-gcp-script.md +++ b/docs/self-hosted/install/install-on-gcp-script.md @@ -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 ``` diff --git a/docs/self-hosted/install/install-on-kubernetes.md b/docs/self-hosted/install/install-on-kubernetes.md index 030d59c48ecbdd..5fb3725a3f90b3 100644 --- a/docs/self-hosted/install/install-on-kubernetes.md +++ b/docs/self-hosted/install/install-on-kubernetes.md @@ -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/). @@ -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/). diff --git a/docs/self-hosted/install/nodes.md b/docs/self-hosted/install/nodes.md index 098ec873f1bcd4..c0ede50957fdb3 100644 --- a/docs/self-hosted/install/nodes.md +++ b/docs/self-hosted/install/nodes.md @@ -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. diff --git a/docs/self-hosted/install/oauth.md b/docs/self-hosted/install/oauth.md index f106e224ad61c9..ab9005cafbb1f3 100644 --- a/docs/self-hosted/install/oauth.md +++ b/docs/self-hosted/install/oauth.md @@ -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/). diff --git a/docs/self-hosted/install/storage.md b/docs/self-hosted/install/storage.md index 87782e70e00213..35cde420d93c40 100644 --- a/docs/self-hosted/install/storage.md +++ b/docs/self-hosted/install/storage.md @@ -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. @@ -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 diff --git a/docs/self-hosted/install/troubleshooting.md b/docs/self-hosted/install/troubleshooting.md index 746f7c515ba9b3..919c6aca2b2bb0 100644 --- a/docs/self-hosted/install/troubleshooting.md +++ b/docs/self-hosted/install/troubleshooting.md @@ -27,7 +27,7 @@ This section should solve all errors that might come up during installation of G - ``` - 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" diff --git a/docs/self-hosted/install/upgrade.md b/docs/self-hosted/install/upgrade.md index 00fae0d99d7681..0923a9a2cd8c6f 100644 --- a/docs/self-hosted/install/upgrade.md +++ b/docs/self-hosted/install/upgrade.md @@ -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 diff --git a/docs/self-hosted/install/workspaces.md b/docs/self-hosted/install/workspaces.md index fdf917f1ffc54b..01a2391a8815dc 100644 --- a/docs/self-hosted/install/workspaces.md +++ b/docs/self-hosted/install/workspaces.md @@ -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. From 375189af4d873cdd1a7846ba9cd38ee6fe54fbed Mon Sep 17 00:00:00 2001 From: Gero Posmyk-Leinemann Date: Mon, 15 Mar 2021 12:32:48 +0000 Subject: [PATCH 2/2] [docs] Deprecate installer images --- docs/self-hosted/install/install-on-aws-script.md | 2 +- docs/self-hosted/install/install-on-gcp-script.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/self-hosted/install/install-on-aws-script.md b/docs/self-hosted/install/install-on-aws-script.md index 31774e0a894792..8d468b68735674 100644 --- a/docs/self-hosted/install/install-on-aws-script.md +++ b/docs/self-hosted/install/install-on-aws-script.md @@ -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 diff --git a/docs/self-hosted/install/install-on-gcp-script.md b/docs/self-hosted/install/install-on-gcp-script.md index 6271df5527097a..683712120c8f3d 100644 --- a/docs/self-hosted/install/install-on-gcp-script.md +++ b/docs/self-hosted/install/install-on-gcp-script.md @@ -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