Skip to content

Commit 2a0089a

Browse files
Simon Emmsmrsimonemms
authored andcommitted
docs: add docs to point to DNS zone
1 parent 2f2b8c9 commit 2a0089a

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Before starting the installation process, you need:
77
- A user account with "Owner" IAM rights on the subscription
88
- A `.env` file with basic details about the environment.
99
- We provide an example of such file [here](.env.example).
10-
- [Docker](https://docs.docker.com/engine/install/) installed on your machine, or better, a Gitpod workspace :)
10+
- [Docker](https://docs.docker.com/engine/install/) installed on your machine, or better, a Gitpod workspace :)
1111

1212
## Azure authentication
1313

@@ -37,6 +37,24 @@ The whole process takes around twenty minutes. In the end, the following resourc
3737
- [Jaeger operator](https://github.com/jaegertracing/helm-charts/tree/main/charts/jaeger-operator) - and Jaeger deployment for Gitpod distributed tracing.
3838
- [gitpod.io](https://github.com/gitpod-io/gitpod) deployment.
3939

40+
## DNS records
41+
42+
> This setup will work even if the parent domain is not owned by a DNS zone in the Azure portal.
43+
44+
The recommended setup is to have `SETUP_MANAGED_DNS` to be `true` which will create an
45+
[Azure DNS zone](https://docs.microsoft.com/en-us/azure/dns/dns-zones-records) for your
46+
domain. When the zone is created, you will see various nameserver records (with type `NS`), such
47+
as `ns1-xx.azure-dns.com`, `ns2-xx.azure-dns.net`, `ns3-xx.azure-dns.org` and `ns4-xx.azure-dns.info`
48+
(where `xx` is the number randomly assigned by Azure).
49+
50+
In the DNS manager for the parent domain (eg, `example.com`), create a nameserver record for
51+
each of the nameservers generated by Azure under the subdomain used (eg, `gitpod.example.com`).
52+
This is what it would look like if your parent domain was using Cloudflare.
53+
54+
![Cloudflare DNS manager](./images/dns-record.png "Cloudflare DNS manager")
55+
56+
Once applied, please allow a few minutes to for DNS propagation.
57+
4058
### Common errors running make install
4159

4260
- Insufficient regional quota to satisfy request

images/dns-record.png

35 KB
Loading

0 commit comments

Comments
 (0)