Skip to content

Commit 0426805

Browse files
committed
docs(dns): move content from README.md into "Configure DNS" doc
1 parent 5d3cebf commit 0426805

5 files changed

Lines changed: 21 additions & 12 deletions

File tree

README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,7 @@ Use `make run` to start all Deis containers and attach to their log output. This
7171
$ make run
7272
```
7373

74-
## Configuring DNS for multi-node clusters
75-
For a one-node cluster, both deis-router and deis-controller will run on the same host. For convenience, we've created the DNS record `local.deisapp.com` which resolves to the IP of the first VM, 172.17.8.100.
76-
You can use `local.deisapp.com` to both log into the controller and to access applications that you've deployed (they will be subdomains of `local.deisapp.com`, like `happy-unicorn.local.deisapp.com`).
77-
78-
On a multi-node cluster, however, the router and controller will likely be scheduled on separate machines. Since we cannot know the IP addresses ahead of time, you'll need to setup resolution yourself using your own domain (unfortunately, wildcard hostnames are not permitted in `/etc/hosts`). The records should be as follows:
79-
80-
* `deis.example.org` should resolve to the IP of the machine that runs `deis-controller`
81-
* `*.deis.example.org` (a wildcard DNS entry) should resolve to the IP of the machine that runs `deis-router`
82-
83-
These records are necessary for multi-node Vagrant as well as any other multi-node deployments of Deis (EC2, Rackspace, etc.).
74+
Your Vagrant VM is accessible at `local.deisapp.com`. For clusters with more than one node, see our guide to [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/).
8475

8576
## Testing the cluster
8677
Integration tests and corresponding documentation can be found under the `test/` folder.

contrib/ec2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ The script will deploy Deis and make sure the services start properly.
6363

6464
## Configure DNS
6565
While you can reference the controller and hosted applications with public hostnames provided by EC2, it is recommended for ease-of-use that
66-
you configure your own DNS records using a domain you own. See [Configuring DNS for multi-node clusters](../../README.md#configuring-dns-for-multi-node-clusters) for details.
66+
you configure your own DNS records using a domain you own. See [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/) for details.
6767

6868
## Use Deis!
6969
After that, register with Deis!

contrib/rackspace/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ $ cd ../.. && make run
5858
The script will deploy Deis and make sure the services start properly.
5959

6060
### Configure DNS
61-
You'll need to configure DNS records so you can access applications hosted on Deis. See [Configuring DNS for multi-node clusters](../../README.md#configuring-dns-for-multi-node-clusters) for details.
61+
You'll need to configure DNS records so you can access applications hosted on Deis. See [Configuring DNS](http://docs.deis.io/en/latest/operations/configure-dns/) for details.
6262

6363
### Use Deis!
6464
After that, register with Deis!

docs/operations/configure-dns.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:title: Configure DNS
2+
:description: Configure name resolution for your Deis Cluster
3+
4+
.. _configure-dns:
5+
6+
Configure DNS
7+
-------------
8+
9+
For a one-node cluster, both deis-router and deis-controller will run on the same host. For convenience, we've created the DNS record ``local.deisapp.com`` which resolves to the IP of the first VM, 172.17.8.100.
10+
You can use ``local.deisapp.com`` to both log into the controller and to access applications that you've deployed (they will be subdomains of ``local.deisapp.com``, like ``happy-unicorn.local.deisapp.com``).
11+
12+
On a multi-node cluster, however, the router and controller will likely be scheduled on separate machines. Since we cannot know the IP addresses ahead of time, you'll need to setup resolution yourself using your own domain (unfortunately, wildcard hostnames are not permitted in ``/etc/hosts``). The records should be as follows:
13+
14+
* ``deis.example.org`` should resolve to the IP of the machine that runs ``deis-controller``
15+
* ``*.deis.example.org`` (a wildcard DNS entry) should resolve to the IP of the machine that runs ``deis-router``
16+
17+
These records are necessary for multi-node Vagrant as well as any other multi-node deployments of Deis (EC2, Rackspace, etc.).

docs/operations/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ Operations Guide
1515
provision-controller
1616
register-admin-user
1717
manage-controller
18+
configure-dns

0 commit comments

Comments
 (0)