You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Gitpod builds Docker images during workspace startup. This enables custom Dockerfiles as part of your workspace config, but is also required for Gitpod itself to function.
@@ -14,20 +13,60 @@ By default Gitpod ships with a built-in Docker registry. If you operate your own
14
13
The docker registry requires a Kubernetes PersistentVolume. This registry is not recommended to be used for production.
15
14
* Own docker registry: Gitpod can connect to your own docker registry. Compared to its built-in counterpart this enables performance gains and access to otherwise private images.
16
15
17
-
This helm chart can either deploy its own registry (default but requires [HTTPS certs](../https-certs/)) or use an existing one.
18
-
To connect to an existing Docker registry, do the following steps:
16
+
This helm chart can either deploy its own registry (default but requires [HTTPS certs](../configures-ingress/)) or use an existing one.
19
17
20
-
```
21
-
echo values/registry.yaml >> configuration.txt
22
-
```
18
+
## Configuration
19
+
To connect to an existing Docker registry, perform the following steps:
23
20
24
-
In `values/registry.yaml` replace `your.registry.com` with the name of your registry.
21
+
1. Create a file `values.docker-registry.yaml` containing:
> 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.
48
+
49
+
3. Do a `helm upgrade --install -f values.docker-registry.yaml gitpod .` to apply the changes.
50
+
51
+
Make sure the resulting JSON file contains the credentials (there should be an `auths` section containing them as base64 encoded string).
32
52
33
53
If that's not the case you might have a credential store/helper set up (e.g. on macOS the _Securely store Docker logins in macOS keychain_ setting).
54
+
55
+
### Example Google Cloud Registry Credentials
56
+
57
+
Prerequisites:
58
+
- `gcloud` [installed](https://cloud.google.com/sdk/docs/quickstart) and [authenticated](https://cloud.google.com/sdk/gcloud/reference/auth/login)
59
+
60
+
How to use Google Cloud Registry as Docker registry for Gitpod:
61
+
1. Go to [https://console.cloud.google.com/gcr/images/\<your-project-id\>?project=\<your-project-id\>](https://console.cloud.google.com/gcr/images/\<your-project-id\>?project=\<your-project-id\>) and hit "Enable Registry API" (if not already enabled).
62
+
63
+
1. Execute the following commands:
64
+
```
65
+
export PROJECT_ID="<your-project-id>"
66
+
67
+
gcloud iam service-accounts create gitpod-registry-full --project=$PROJECT_ID
helm upgrade --install $(for i in $(cat configuration.txt); do echo -e "-f $i"; done) gitpod .
28
+
helm install gitpod .
28
29
```
29
-
#####TODO
30
-
## Recommended Configuration
31
30
31
+
> Review the deployment worked properly by running `kubectl get pods`. Eventually all pods should be up-and-running. In case they are not have a look the the [Troubleshooting Guide](./troubleshooting.md)
32
+
33
+
1. Configure [ingress into the cluster](../configure-ingress/)
34
+
35
+
2. Go to https://123-123-123-123.ip.mygitpod.com/workspace and follow the steps to setup OAuth
36
+
37
+
## Recommended Configuration
32
38
39
+
Without further configuration the Helm chart installs a working Gitpod installation in a lot of scenarios.
40
+
Yet, there are certain things you want to review when installing Gitpod for long term use or a bigger audience:
41
+
*[**Database**](../database/): Configure where Gitpod stores all internal runtime data.
42
+
*[**Storage**](../storage/): Configure where Gitpod persists workspace content.
43
+
*[**Docker Registry**](../docker-registry/): Configure where Gitpod stores workspace images that are build at runtime.
33
44
34
45
## Customization
35
46
36
-
*[**Storage**](../storage/): Configure where Gitpod stores stopped workspaces.
47
+
Further customizations:
37
48
*[**Kubernetes Nodes**](../nodes/): Configure file system layout and the workspace's node associativity.
0 commit comments