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.

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

[Gitpod Self-Hosted] Docs updates for 0.7.0 release #3098

Merged
merged 2 commits into from
Feb 4, 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
16 changes: 12 additions & 4 deletions docs/self-hosted/install/install-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://\<your-domain.com\>](https://\<your-domain.com\>) and follow the steps to complete the installation.
1. Go to [https://\<your-domain.com\>](https://\<your-domain.com\>) and follow the steps to complete the installation.


## Recommended Configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/self-hosted/install/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
27 changes: 27 additions & 0 deletions docs/self-hosted/install/upgrade.md
Original file line number Diff line number Diff line change
@@ -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
Copy link
Member

Choose a reason for hiding this comment

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

👍


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.