Skip to content
This repository was archived by the owner on Sep 6, 2022. It is now read-only.

Commit e4a323e

Browse files
lucasvaltlmrsimonemms
authored andcommitted
Spelling, updated to match intended use: create env
1 parent f1e6c24 commit e4a323e

File tree

1 file changed

+4
-68
lines changed

1 file changed

+4
-68
lines changed

README.md

+4-68
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Running Gitpod in [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine)
22

3-
> **IMPORTANT** This guide exists as a simple and reliable way of creating a Gitpod instance in GKE. It
3+
> **IMPORTANT** This guide exists as a simple and reliable way of creating an environment in GKE that can run Gitpod. It
44
> is not designed to cater for every situation. If you find that it does not meet your exact needs,
55
> please fork this guide and amend it to your own needs.
66
@@ -21,7 +21,7 @@ Before starting the installation process, you need:
2121
make install
2222
```
2323

24-
The whole process takes around twenty minutes. In the end, the following resources are created:
24+
The whole process takes around twenty minutes. In the end, the following resources are created. These are the GCP versions of the [components Gitpod requires](https://www.gitpod.io/docs/self-hosted/latest/required-components):
2525

2626
- a GKE cluster running Kubernetes v1.21 ([rapid channel](https://cloud.google.com/kubernetes-engine/docs/release-notes-rapid)).
2727
- GCP L4 load balancer.
@@ -30,9 +30,8 @@ The whole process takes around twenty minutes. In the end, the following resourc
3030
- In-cluster docker registry using [Cloud Storage](https://cloud.google.com/storage) as storage backend.
3131
- [calico](https://docs.projectcalico.org) as CNI and NetworkPolicy implementation.
3232
- [cert-manager](https://cert-manager.io/) for self-signed SSL certificates.
33-
- [gitpod.io](https://github.com/gitpod-io/gitpod) deployment.
3433

35-
Upon completion, it will print the config for resource (including passwords) and instructions on what
34+
Upon completion, it will print the config for the resources created (including passwords) and instructions on what
3635
to do next. **IMPORTANT** - running the `make install` command after the initial install will change
3736
your database password which will require you to update your KOTS configuration.
3837

@@ -55,7 +54,7 @@ your database password which will require you to update your KOTS configuration.
5554
proxy-5998488f4c-t8vkh 0/1 Init 0/1 0 5m
5655
```
5756

58-
The most likely reason is because the [DNS01 challenge](https://cert-manager.io/docs/configuration/acme/dns01/) has yet to resolve. If using `SETUP_MANAGED_DNS`, you will need to update your DNS records to point to the GCP Cloud DNS nameserver.
57+
The most likely reason is that the [DNS01 challenge](https://cert-manager.io/docs/configuration/acme/dns01/) has yet to resolve. If using `SETUP_MANAGED_DNS`, you will need to update your DNS records to point to the GCP Cloud DNS nameserver.
5958

6059
Once the DNS record has been updated, you will need to delete all cert-manager pods to retrigger the certificate request
6160

@@ -71,69 +70,6 @@ your database password which will require you to update your KOTS configuration.
7170
https-certificates True https-certificates 5m
7271
```
7372

74-
## Verify the installation
75-
76-
First, check that Gitpod components are running.
77-
78-
```shell
79-
kubectl get pods
80-
NAME READY STATUS RESTARTS AGE
81-
agent-smith-bz97r 2/2 Running 0 95m
82-
agent-smith-dll6b 2/2 Running 0 95m
83-
agent-smith-kvrs5 2/2 Running 0 95m
84-
blobserve-74599b4b98-5t9dq 2/2 Running 0 95m
85-
cloudsqlproxy-cloud-sql-proxy-7556c57c4d-zqptx 1/1 Running 0 95m
86-
cloudsqlproxy-session-ldl9h 0/1 Completed 0 95m
87-
content-service-758878c6c-b4sqh 1/1 Running 0 95m
88-
dashboard-758f94ccf5-qk8cm 1/1 Running 0 95m
89-
image-builder-mk3-55f948b89f-m6qbk 2/2 Running 0 95m
90-
jaeger-operator-6cc9f79cc8-dfkjh 1/1 Running 0 95m
91-
messagebus-0 1/1 Running 0 95m
92-
migrations-5jmkx 0/1 Completed 0 95m
93-
openvsx-proxy-0 1/1 Running 0 95m
94-
proxy-55665d8765-n2b2w 2/2 Running 0 95m
95-
registry-facade-4c7tz 2/2 Running 0 95m
96-
registry-facade-5dxfx 2/2 Running 0 95m
97-
registry-facade-gxmhv 2/2 Running 0 95m
98-
server-ccb459f85-8vgfn 2/2 Running 0 95m
99-
ws-daemon-6qrjf 2/2 Running 0 95m
100-
ws-daemon-hslz7 2/2 Running 0 95m
101-
ws-daemon-hzw8h 2/2 Running 0 95m
102-
ws-manager-8f6bc54f4-r67kk 1/1 Running 0 95m
103-
ws-manager-bridge-56d7978664-6l6ht 2/2 Running 0 95m
104-
ws-proxy-fbc47486d-kqdvj 1/1 Running 0 95m
105-
ws-scheduler-5c5d9f998-6zxmz 2/2 Running 0 95m
106-
107-
```
108-
109-
### Test Gitpod workspaces
110-
111-
When the provisioning and configuration of the cluster is done, the script shows the URL of the load balancer,
112-
like:
113-
114-
```shell
115-
Load balancer IP address: XXX.XXX.XXX.XXX
116-
```
117-
118-
Please open the URL `https://<domain>/workspaces`.
119-
It should display the Gitpod login page similar to the next image.
120-
121-
*DNS propagation* can take several minutes.
122-
123-
![Gitpod login page](./images/gitpod-login.png "Gitpod Login Page")
124-
125-
----
126-
127-
## Delete Gitpod from your cluster
128-
129-
Remove Gitpod from your cluster running:
130-
131-
```shell
132-
kubectl get configmaps gitpod-app \
133-
-o jsonpath='{.data.app\.yaml}' | \
134-
kubectl delete -f -
135-
```
136-
13773
## Destroy the cluster and GCP resources
13874

13975
Remove the GCP cluster running:

0 commit comments

Comments
 (0)