Skip to content

Commit 000cbb5

Browse files
author
Matthew Fisher
committed
docs(quickstart): add DNS registrar and Route53 docs for AWS
1 parent 6be97a2 commit 000cbb5

1 file changed

Lines changed: 58 additions & 15 deletions

File tree

  • src/quickstart/provider/aws

src/quickstart/provider/aws/dns.md

Lines changed: 58 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
## Find Your Load Balancer Hostname
22

3-
On EC2, Deis Workflow will automatically provision and attach a Google Cloud Loadbalancer to the router copmonent. This
4-
component is responsible for routing HTTP and HTTPS requests from the public internet to applications that are deployed
5-
and managed by Deis Workflow.
3+
On EC2, Deis Workflow will automatically provision and attach an Elastic Load Balancer (ELB) to the
4+
[Router][]. The Router is responsible for routing HTTP and HTTPS requests from the public internet
5+
to applications that are deployed and managed by Deis Workflow, as well as streaming TCP requests
6+
to the [Builder][].
67

7-
By describing the `deis-router` service, you can see what hostname allocated by Google Cloud for your Deis Workflow
8-
cluster:
8+
By describing the `deis-router` service, you can see what hostname allocated by AWS for your Deis
9+
Workflow cluster:
910

1011
```
1112
$ kubectl --namespace=deis describe svc deis-router | egrep LoadBalancer
@@ -15,37 +16,75 @@ LoadBalancer Ingress: abce0d48217d311e69a470643b4d9062-2074277678.us-west-1.el
1516

1617
## Prepare the Hostname
1718

18-
Now that you have the hostname of your load balancer we can use the `nip.io`
19-
DNS service to route arbitrary hostnames to the Deis Workflow edge router. This
20-
lets us point the Workflow CLI at your cluster without having to either use
21-
your own domain or update DNS!
19+
### Using DNS
20+
21+
Now that we have the hostname of the load balancer, let's create the wildcard DNS record that
22+
directs requests from your machine to the application.
23+
24+
First, if you haven't already done so, register your domain name. The Internet Corporation for
25+
Assigned Names and Numbers (ICANN) manages domain names on the Internet. You register a domain name
26+
using a domain name registrar, an ICANN-accredited organization that manages the registry of domain
27+
names. The website for your registrar will provide detailed instructions and pricing information
28+
for registering your domain name. For more information, see the following resources:
29+
30+
- To use Amazon Route 53 to register a domain name, see [Registering Domain Names Using Amazon Route 53](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar.html).
31+
- For a list of accredited registrars, see the [Accredited Registrar Directory](www.internic.net/regist.html).
32+
33+
Next, use your DNS service, such as your domain registrar, to create a wildcard CNAME record to
34+
route queries to your load balancer. For more information, see the documentation for your DNS
35+
service.
36+
37+
Alternatively, you can use Amazon Route 53 as your DNS service. You create a hosted zone, which
38+
contains information about how to route traffic on the Internet for your domain, and an alias
39+
resource record set, which routes queries for your domain name to your load balancer.
40+
41+
To create a hosted zone and an alias record set for your domain using Amazon Route 53:
42+
43+
1. Open the Amazon Route 53 console at https://console.aws.amazon.com/route53/.
44+
2. Create a Public Hosted Zone with your domain name.
45+
3. Select the hosted zone that you just created for your domain.
46+
4. Click Go to Record Sets.
47+
5. Create a Record Set with the name as `*`, the type as `CNAME - Canonical Name`, and as an alias
48+
of the Load Balancer created from the router.
49+
50+
### Using nip.io
51+
52+
If you do not have registered a domain name and just want to try out Workflow on AWS, we can use
53+
the `nip.io` wildcard DNS service to route arbitrary hostnames to the Deis Workflow edge router.
54+
This lets us point the Workflow CLI at your cluster without having to either use your own domain or
55+
update DNS!
56+
57+
!!! note
58+
this is **not** how you should connect to your cluster after the quickstart. This is
59+
for demonstration purposes only. Instead, you will want to use your own domain name routed to
60+
the ELB through your domain registrar. AWS actively manages the ELB IPv4 addresses, so what may
61+
be an IP address associated with your ELB today will be something else later on.
2262

2363
First, pick one of the IP addresses allocated to your ELB:
64+
2465
```
2566
$ host abce0d48217d311e69a470643b4d9062-2074277678.us-west-1.elb.amazonaws.com
2667
abce0d48217d311e69a470643b4d9062-2074277678.us-west-1.elb.amazonaws.com has address 52.8.166.233
2768
abce0d48217d311e69a470643b4d9062-2074277678.us-west-1.elb.amazonaws.com has address 54.193.5.73
2869
```
2970

30-
Note that this is **not** how you should connect to your cluster after the quickstart. Instead you will want to use your
31-
own domain name routed to the ELB CNAME. AWS actively manages the ELB addresses so what may be an ip address associated
32-
with your ELB today will be something else later on.
33-
34-
For now though, grab either address for the next step. We'll use `52.8.166.233` for this example.
71+
Grab either address for the next step. We'll use `52.8.166.233` for this example.
3572

3673
To verify the Workflow API server and nip.io, construct your hostname by taking
3774
the ip address for your load balancer and adding `nip.io`. For our example
3875
above, the address would be: `52.8.166.233.nip.io`.
3976

4077
Nip answers with the ip address no matter the hostname:
78+
4179
```
4280
$ host 52.8.166.233.nip.io
4381
52.8.166.233.nip.io has address 52.8.166.233
4482
$ host something-random.52.8.166.233.nip.io
4583
something-random.52.8.166.233.nip.io has address 52.8.166.233
4684
```
4785

48-
By default, any HTTP traffic for the hostname `deis` will be sent to the Workflow API service. To test that everything is connected properly you may validate connectivity using `curl`:
86+
By default, any HTTP traffic for the hostname `deis` will be sent to the Workflow API service. To
87+
test that everything is connected properly you may validate connectivity using `curl`:
4988

5089
```
5190
$ curl http://deis.52.8.166.233.nip.io/v2/ && echo
@@ -59,3 +98,7 @@ Remember the hostname, we will use it in the next step.
5998
You are now ready to [register an admin user and deploy your first app](../../deploy-an-app.md).
6099

61100
[next: deploy your first app](../../deploy-an-app.md)
101+
102+
103+
[builder]: ../../../understanding-workflow/components.md#builder-builder-slugbuilder-and-dockerbuilder
104+
[router]: ../../../understanding-workflow/components.md#router

0 commit comments

Comments
 (0)