diff --git a/docs/self-hosted/install/install-on-kubernetes.md b/docs/self-hosted/install/install-on-kubernetes.md index 65a616ff47628d..28e7a63ee3a3bc 100644 --- a/docs/self-hosted/install/install-on-kubernetes.md +++ b/docs/self-hosted/install/install-on-kubernetes.md @@ -24,18 +24,26 @@ For some cloud providers, we offer [Terraform](https://www.terraform.io/) script To install Gitpod in your Kubernetes cluster, follow these steps: +1. Create a file `values.custom.yaml` with the following content: + ``` + minio: + accessKey: your-random-access-key + secretKey: your-random-secret-key + ``` + You should replace the keys with 2 different random strings unique for your installation. + 1. Run the following commands in your local terminal: ```console helm repo add gitpod.io https://charts.gitpod.io - helm install gitpod gitpod.io/gitpod + helm install -f values.custom.yaml gitpod gitpod.io/gitpod ``` -2. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/). +1. Run `kubectl get pods` and verify that all pods are in state `RUNNING`. If some are not, please see the [Troubleshooting Guide](../troubleshooting/). -3. Configure [domain and https](../configure-ingress/). +1. Configure [domain and https](../configure-ingress/). -4. Go to [https://\](https://\) and follow the steps to complete the installation. +1. Go to [https://\](https://\) and follow the steps to complete the installation. ## Recommended Configuration diff --git a/docs/self-hosted/install/storage.md b/docs/self-hosted/install/storage.md index 02aa5836c32284..b73ae3609f6f85 100644 --- a/docs/self-hosted/install/storage.md +++ b/docs/self-hosted/install/storage.md @@ -42,6 +42,8 @@ For more complex use case we recommend configuring more permanent means of persi 2. Create a file `values.custom.yaml` with this content: ```yaml minio: + accessKey: add-a-radom-access-key-here + 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` to apply the changes diff --git a/docs/self-hosted/install/upgrade.md b/docs/self-hosted/install/upgrade.md new file mode 100644 index 00000000000000..00fae0d99d7681 --- /dev/null +++ b/docs/self-hosted/install/upgrade.md @@ -0,0 +1,27 @@ +--- +url: /docs/self-hosted/latest/install/upgrade/ +--- + +# Gitpod Self-Hosted Upgrade Notes + +## Upgrading Gitpod from v0.6.0 to v0.7.0 + +With version 0.7.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: +``` +minio: + accessKey: add-a-radom-access-key-here + secretKey: add-a-radom-secret-key-here +``` + +If you don't do this, `helm` will fail with the following message: + +> minio access key is required, please add a value to your values.yaml + + +### Remote storage config has been moved to a new component + +If you have a custom remote storage config (e.g. you use your own MinIO instance or the Google Cloud Storage), you need to move the config from the component `wsDaemon` to the new component `contentService`. See the [Storage Guide](../storage/) for an example.