Skip to content

Commit 7fdfa27

Browse files
lucasvaltlmrsimonemms
authored andcommitted
Minor spelling and removed gitpod install steps
1 parent 28bdf0a commit 7fdfa27

File tree

1 file changed

+7
-57
lines changed

1 file changed

+7
-57
lines changed

README.md

Lines changed: 7 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Running Gitpod in [Azure AKS](https://azure.microsoft.com/en-gb/services/kubernetes-service/)
22

3-
> **IMPORTANT** This guide exists as a simple and reliable way of creating a Gitpod instance in Azure AKS. It
4-
> is not designed to cater for every situation. If you find that it does not meet your exact needs,
3+
> **IMPORTANT** This guide exists as a simple and reliable way of creating an environment in AKS that can run Gitpod. It is not designed to cater for every situation. If you find that it does not meet your exact needs,
54
> please fork this guide and amend it to your own needs.
65
76
Before starting the installation process, you need:
@@ -28,7 +27,7 @@ To sign in, use a web browser to open the page https://microsoft.com/devicelogin
2827
make install
2928
```
3029

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

3332
- an AKS cluster running Kubernetes v1.21.
3433
- Azure load balancer.
@@ -39,15 +38,14 @@ The whole process takes around twenty minutes. In the end, the following resourc
3938
- [calico](https://docs.projectcalico.org) as CNI and NetworkPolicy implementation.
4039
- [cert-manager](https://cert-manager.io/) for self-signed SSL certificates.
4140

42-
Upon completion, it will print the config for resource (including passwords) and instructions on what
43-
to do next. **IMPORTANT** - running the `make install` command after the initial install will change
41+
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
4442
your database password which will require you to update your KOTS configuration.
4543

4644
## DNS records
4745

4846
> This setup will work even if the parent domain is not owned by a DNS zone in the Azure portal.
4947
50-
The recommended setup is to have `SETUP_MANAGED_DNS` to be `true` which will create an
48+
The recommended setup is to have `SETUP_MANAGED_DNS` be `true` which will create an
5149
[Azure DNS zone](https://docs.microsoft.com/en-us/azure/dns/dns-zones-records) for your
5250
domain. When the zone is created, you will see various nameserver records (with type `NS`), such
5351
as `ns1-xx.azure-dns.com`, `ns2-xx.azure-dns.net`, `ns3-xx.azure-dns.org` and `ns4-xx.azure-dns.info`
@@ -59,7 +57,7 @@ This is what it would look like if your parent domain was using Cloudflare.
5957

6058
![Cloudflare DNS manager](./images/dns-record.png "Cloudflare DNS manager")
6159

62-
Once applied, please allow a few minutes to for DNS propagation.
60+
Once applied, please allow a few minutes for DNS propagation.
6361

6462
### Common errors running make install
6563

@@ -78,7 +76,7 @@ Once applied, please allow a few minutes to for DNS propagation.
7876
proxy-5998488f4c-t8vkh 0/1 Init 0/1 0 5m
7977
```
8078

81-
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 Azure DNS zone nameserver.
79+
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 Azure DNS zone nameserver.
8280

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

@@ -94,54 +92,6 @@ Once applied, please allow a few minutes to for DNS propagation.
9492
https-certificates True https-certificates 5m
9593
```
9694

97-
## Verify the installation
98-
99-
First, check that Gitpod components are running.
100-
101-
```shell
102-
kubectl get pods
103-
NAME READY STATUS RESTARTS AGE
104-
agent-smith-c9v58 2/2 Running 0 7m35s
105-
agent-smith-j7b85 2/2 Running 0 7m35s
106-
agent-smith-mwf5d 2/2 Running 0 7m35s
107-
blobserve-84f895c88c-476m2 2/2 Running 0 7m33s
108-
content-service-57c7fdb84d-dl49k 1/1 Running 0 7m34s
109-
dashboard-b79d84d47-z7hzg 1/1 Running 0 7m34s
110-
image-builder-mk3-5ff7c68bb4-qqbw5 2/2 Running 0 7m34s
111-
jaeger-operator-777d987c8b-ts9gw 1/1 Running 0 7m33s
112-
messagebus-0 1/1 Running 0 7m34s
113-
minio-697975c744-swwp6 1/1 Running 0 7m34s
114-
minio-697975c744-tj96r 1/1 Running 0 7m34s
115-
openvsx-proxy-0 1/1 Running 0 7m34s
116-
proxy-c58846cf5-cbdgb 2/2 Running 0 7m33s
117-
registry-facade-84sgf 2/2 Running 0 7m34s
118-
registry-facade-n6kc9 2/2 Running 0 7m35s
119-
registry-facade-zt7qt 2/2 Running 0 7m34s
120-
server-689b886647-dkd5h 2/2 Running 0 7m34s
121-
ws-48fe6d74-6e6d-4e3e-a6a4-1bf160b4ed3d 1/1 Running 0 2m43s
122-
ws-daemon-v8284 2/2 Running 0 7m35s
123-
ws-daemon-vs59b 2/2 Running 0 7m35s
124-
ws-daemon-w6gmj 2/2 Running 0 7m35s
125-
ws-manager-54c8f9995f-lrrkx 1/1 Running 0 7m34s
126-
ws-manager-bridge-8648cd6b69-nqxnh 2/2 Running 0 7m34s
127-
ws-proxy-574f9dcbcc-qrn5m 1/1 Running 0 7m33s
128-
ws-scheduler-84d99cbbbb-5p86k 2/2 Running 0 7m34s
129-
```
130-
131-
### Test Gitpod workspaces
132-
133-
When the provisioning and configuration of the cluster is done, the script shows the URL of the load balancer,
134-
like:
135-
136-
Please open the URL `https://<domain>/workspaces`.
137-
It should display the Gitpod login page similar to the next image.
138-
139-
*DNS propagation* can take several minutes.
140-
141-
![Gitpod login page](./images/gitpod-login.png "Gitpod Login Page")
142-
143-
----
144-
14595
## Destroy the cluster and Azure resources
14696

14797
Remove the Azure cluster running:
@@ -150,7 +100,7 @@ Remove the Azure cluster running:
150100
make uninstall
151101
```
152102

153-
> The command asks for a confirmation:
103+
> The command asks for confirmation:
154104
> `Are you sure you want to delete: Gitpod (y/n)?`
155105
156106
This will destroy the Kubernetes cluster and allow you to manually delete the cloud storage.

0 commit comments

Comments
 (0)