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

Commit

Permalink
Spelling, updated to match intended use: create env
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucasvaltl @mrsimonemms
lucasvaltl authored and mrsimonemms committed Apr 28, 2022
1 parent f1e6c24 commit e4a323e
Showing 1 changed file with 4 additions and 68 deletions.
72 changes: 4 additions & 68 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Running Gitpod in [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine)

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

The whole process takes around twenty minutes. In the end, the following resources are created:
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):

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

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

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

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.
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.

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

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

## Verify the installation

First, check that Gitpod components are running.

```shell
kubectl get pods
NAME READY STATUS RESTARTS AGE
agent-smith-bz97r 2/2 Running 0 95m
agent-smith-dll6b 2/2 Running 0 95m
agent-smith-kvrs5 2/2 Running 0 95m
blobserve-74599b4b98-5t9dq 2/2 Running 0 95m
cloudsqlproxy-cloud-sql-proxy-7556c57c4d-zqptx 1/1 Running 0 95m
cloudsqlproxy-session-ldl9h 0/1 Completed 0 95m
content-service-758878c6c-b4sqh 1/1 Running 0 95m
dashboard-758f94ccf5-qk8cm 1/1 Running 0 95m
image-builder-mk3-55f948b89f-m6qbk 2/2 Running 0 95m
jaeger-operator-6cc9f79cc8-dfkjh 1/1 Running 0 95m
messagebus-0 1/1 Running 0 95m
migrations-5jmkx 0/1 Completed 0 95m
openvsx-proxy-0 1/1 Running 0 95m
proxy-55665d8765-n2b2w 2/2 Running 0 95m
registry-facade-4c7tz 2/2 Running 0 95m
registry-facade-5dxfx 2/2 Running 0 95m
registry-facade-gxmhv 2/2 Running 0 95m
server-ccb459f85-8vgfn 2/2 Running 0 95m
ws-daemon-6qrjf 2/2 Running 0 95m
ws-daemon-hslz7 2/2 Running 0 95m
ws-daemon-hzw8h 2/2 Running 0 95m
ws-manager-8f6bc54f4-r67kk 1/1 Running 0 95m
ws-manager-bridge-56d7978664-6l6ht 2/2 Running 0 95m
ws-proxy-fbc47486d-kqdvj 1/1 Running 0 95m
ws-scheduler-5c5d9f998-6zxmz 2/2 Running 0 95m

```

### Test Gitpod workspaces

When the provisioning and configuration of the cluster is done, the script shows the URL of the load balancer,
like:

```shell
Load balancer IP address: XXX.XXX.XXX.XXX
```

Please open the URL `https://<domain>/workspaces`.
It should display the Gitpod login page similar to the next image.

*DNS propagation* can take several minutes.

![Gitpod login page](./images/gitpod-login.png "Gitpod Login Page")

----

## Delete Gitpod from your cluster

Remove Gitpod from your cluster running:

```shell
kubectl get configmaps gitpod-app \
-o jsonpath='{.data.app\.yaml}' | \
kubectl delete -f -
```

## Destroy the cluster and GCP resources

Remove the GCP cluster running:
Expand Down

0 comments on commit e4a323e

Please sign in to comment.