Merge pull request #1011 from deis/controller-behind-router

carmstrong · carmstrong · commit 9194f487bff3 · 2014-05-28T10:47:09.000-06:00
feat(router): route deis.domain to controller
diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ $ cd client && python setup.py install
 Use the Deis Client to register a new user.
 
 ```console
-$ deis register http://local.deisapp.com:8000
+$ deis register http://deis.local.deisapp.com
 $ deis keys:add
 ```
 
diff --git a/client/README.rst b/client/README.rst
@@ -85,7 +85,7 @@ version of the Deis client for Mac OS X, Windows, or Debian Linux:
 
 .. code-block:: console
 
-    $ deis register http://local.deisapp.com:8000
+    $ deis register http://deis.local.deisapp.com
     $ deis keys:add
 
 
diff --git a/contrib/ec2/README.md b/contrib/ec2/README.md
@@ -83,7 +83,7 @@ you configure your own DNS records using a domain you own. See [Configuring DNS]
 ## Use Deis!
 After that, register with Deis!
 ```console
-$ deis register deis.example.org:8000
+$ deis register http://deis.example.org
 username: deis
 password:
 password (confirm):
diff --git a/contrib/rackspace/README.md b/contrib/rackspace/README.md
@@ -78,7 +78,7 @@ You'll need to configure DNS records so you can access applications hosted on De
 ### Use Deis!
 After that, register with Deis!
 ```console
-$ deis register deis.example.org:8000
+$ deis register http://deis.example.org
 username: deis
 password:
 password (confirm):
diff --git a/controller/api/serializers.py b/controller/api/serializers.py
@@ -129,12 +129,14 @@ class Meta:
 
     def validate_id(self, attrs, source):
         """
-        Check that the ID is all lowercase
+        Check that the ID is all lowercase and not 'deis'
         """
         value = attrs[source]
         match = re.match(r'^[a-z0-9-]+$', value)
         if not match:
             raise serializers.ValidationError("App IDs can only contain [a-z0-9-]")
+        if value == 'deis':
+            raise serializers.ValidationError("App IDs cannot be 'deis'")
         return attrs
 
 
diff --git a/controller/api/tests/test_app.py b/controller/api/tests/test_app.py
@@ -100,6 +100,10 @@ def test_app_errors(self):
         body = {'cluster': cluster_id, 'id': 'camelCase'}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertContains(response, 'App IDs can only contain [a-z0-9-]', status_code=400)
+        url = '/api/apps'
+        body = {'cluster': cluster_id, 'id': 'deis'}
+        response = self.client.post(url, json.dumps(body), content_type='application/json')
+        self.assertContains(response, "App IDs cannot be 'deis'", status_code=400)
         body = {'cluster': cluster_id, 'id': app_id}
         response = self.client.post(url, json.dumps(body), content_type='application/json')
         self.assertEqual(response.status_code, 201)
diff --git a/controller/bin/boot b/controller/bin/boot
@@ -42,7 +42,7 @@ until confd -onetime -node $ETCD -config-file /app/confd.toml 2>/dev/null; do
 done
 
 # wait for confd to populate all values
-while grep -q '<no value>' /templates/confd_settings.py; do
+while grep -q '<no value>' /etc/nginx/nginx.conf; do
        echo "controller: waiting for confd to write all values..."
        confd -onetime -node $ETCD -config-file /app/confd.toml 2>/dev/null
        sleep $(($ETCD_TTL/2))  # sleep for half the TTL
diff --git a/docs/contributing/localdev.rst b/docs/contributing/localdev.rst
@@ -132,23 +132,14 @@ receive full admin permissions.
 
 .. code-block:: console
 
-    $ deis register http://local.deisapp.com:8000
+    $ deis register http://deis.local.deisapp.com
     username: myuser
     password:
     password (confirm):
     email: myuser@example.com
     Registered myuser
     Logged in as myuser
 
-.. note::
-
-    As of v0.5.1, the proxy was removed for Deis platform services. It has yet to be added
-    back in. See `issue 535`_ for more details.
-
-    As a workaround, use the following:
-
-    :code:`deis register http://local.deisapp.com:8000`
-
 Once the user is registered, add your SSH key for ``git push``
 access using:
 
@@ -252,4 +243,3 @@ ensure the pull request doesn't break any tests or reduce code coverage.
 .. _`VirtualBox`: https://www.virtualbox.org/
 .. _`fork the Deis repository`: https://github.com/deis/deis/fork
 .. _`pull request`: https://github.com/deis/deis/pulls
-.. _`issue 535`: https://github.com/deis/deis/issues/535
diff --git a/docs/developer/deploy-application.rst b/docs/developer/deploy-application.rst
@@ -5,7 +5,7 @@
 
 Deploy an Application
 =====================
-An :ref:`Application` is deployed to Deis using ``git push`` or the ``deis`` client.  
+An :ref:`Application` is deployed to Deis using ``git push`` or the ``deis`` client.
 
 Supported Applications
 ----------------------
@@ -21,7 +21,7 @@ Before deploying an application, users must first authenticate against the Deis
 
 .. code-block:: console
 
-    $ deis login http://example.com:8000
+    $ deis login http://deis.example.com
     username: deis
     password:
     Logged in as deis
@@ -50,4 +50,4 @@ Learn how to use deploy applications on Deis :ref:`using-dockerfiles`.
 .. _`twelve-factor methodology`: http://12factor.net/
 .. _`Heroku Buildpacks`: https://devcenter.heroku.com/articles/buildpacks
 .. _`Dockerfiles`: http://docs.docker.io/en/latest/use/builder/
-.. _`Docker Image`: http://docs.docker.io/introduction/understanding-docker/
+.. _`Docker Image`: http://docs.docker.io/introduction/understanding-docker/
diff --git a/docs/developer/register-user.rst b/docs/developer/register-user.rst
@@ -14,7 +14,7 @@ to create a new account.  You will be logged in automatically.
 
 .. code-block:: console
 
-    $ deis register http://deis.example.com:8000
+    $ deis register http://deis.example.com
     username: myuser
     password:
     password (confirm):
@@ -52,13 +52,11 @@ If you already have an account, use ``deis login`` to authenticate against the D
 
 .. code-block:: console
 
-    $ deis login http://example.com:8000
+    $ deis login http://deis.example.com
     username: deis
     password:
     Logged in as deis
 
 .. note::
 
     Deis session information is stored in your user's ~/.deis directory.
-    
-.. _`issue 535`: https://github.com/deis/deis/issues/535
diff --git a/docs/operations/configure-dns.rst b/docs/operations/configure-dns.rst
@@ -9,7 +9,7 @@ Configure DNS
 For local clusters, we've created the DNS record ``local.deisapp.com`` which resolves to the IP of the first VM, 172.17.8.100.
 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``). Similarly, you can use ``local3.deisapp.com`` or ``local5.deisapp.com`` for 3- and 5-node clusters, respectively. No DNS configuration is necessary for local clusters.
 
-For Deis clusters hosted elsewhere (EC2, Rackspace, bare metal, etc.), DNS records will need to be created to point to the cluster. For a one-node cluster, we schedule and launch one router, and deis-router and deis-controller will run on the same host. So, both DNS records specified below can be configured to point to this one machine.
+For Deis clusters hosted elsewhere (EC2, Rackspace, bare metal, etc.), DNS records will need to be created to point to the cluster. For a one-node cluster, we schedule and launch one router, and deis-router and deis-controller will run on the same host. So, the DNS record specified below can be configured to point to this one machine.
 
 On a multi-node cluster, however, there are probably multiple routers, and the controller will likely be scheduled on a separate machine. As mentioned in :ref:`configure-load-balancers`, a load balancer is recommended in this scenario.
 
@@ -18,8 +18,9 @@ Note that the controller will eventually live behind the routers so that all ext
 Necessary DNS records
 ---------------------
 
-The DNS records for Deis should be configured as such:
-* ``deis.example.org`` should resolve to the IP of the machine that runs ``deis-controller``
-* ``*.deis.example.org`` (a wildcard DNS entry) should point to the load balancer (or the same machine for 1-node Vagrant, or any single instance of ``deis-router`` if one likes to live life on the edge)
+Deis requires one wildcard DNS record. Assuming ``myapps.com`` is the top-level domain apps will live under:
+* ``*.myapps.com`` should have A-record entries for each of the load balancer IP addresses
 
-These records are necessary for all deployments of Deis (EC2, Rackspace, bare metal, etc.). Local clusters can use the hostnames ``local.deisapp.com``, ``local3.deisapp.com``, or ``local5.deiaspp.com``.
+Apps can then be accessed via ``appname.myapps.com``, and the Deis controller can be accessed at ``deis.myapps.com``.
+
+This record is necessary for all deployments of Deis (EC2, Rackspace, bare metal, etc.). Local clusters can use the domain ``local.deisapp.com``, ``local3.deisapp.com``, or ``local5.deiaspp.com``.
diff --git a/docs/operations/register-admin-user.rst b/docs/operations/register-admin-user.rst
@@ -42,24 +42,13 @@ Now that the client is installed, create a user account on the Deis :ref:`Contro
 
 .. code-block:: console
 
-    $ deis register http://deis.example.com:8000
+    $ deis register http://deis.example.com
     username: myuser
     password:
     password (confirm):
     email: myuser@example.com
     Registered myuser
     Logged in as myuser
 
-.. note::
-
-    As of v0.5.1, the proxy was removed for Deis platform services. It has yet to be added
-    back in. See `issue 535`_ for more details.
-
-    As a workaround, use the following:
-
-    :code:`deis register http://deis.example.com:8000`
-
-
 .. _pip: http://www.pip-installer.org/en/latest/installing.html
 .. _Python: https://www.python.org/
-.. _`issue 535`: https://github.com/deis/deis/issues/535
diff --git a/router/bin/boot b/router/bin/boot
@@ -25,7 +25,7 @@ done
 sleep $(($ETCD_TTL+1))
 
 function etcd_safe_mkdir {
-  etcdctl --no-sync -C $ETCD mkdir $1 || true >/dev/null 2>&1
+  etcdctl --no-sync -C $ETCD mkdir $1 >/dev/null 2>&1 || true
 }
 
 function etcd_safe_set {
@@ -34,6 +34,7 @@ function etcd_safe_set {
   fi
 }
 
+etcd_safe_mkdir /deis/controller
 etcd_safe_mkdir /deis/services
 etcd_safe_mkdir /deis/domains
 etcd_safe_set port ${PORT:-80}
diff --git a/router/conf.d/nginx.conf.toml b/router/conf.d/nginx.conf.toml
@@ -8,6 +8,7 @@ keys = [
   "/deis/services",
   "/deis/router",
   "/deis/domains",
+  "/deis/controller",
 ]
-#check_cmd  = "/usr/sbin/nginx -t -c {{ .src }}"
+check_cmd  = "/usr/sbin/nginx -t -c {{ .src }}"
 reload_cmd = "/usr/sbin/nginx -s reload"
diff --git a/router/templates/nginx.conf b/router/templates/nginx.conf
@@ -34,10 +34,27 @@ http {
     access_log /dev/stdout;
     error_log /dev/stdout;
 
+    upstream deis-controller {
+        server {{ .deis_controller_host }}:{{ .deis_controller_port }};
+    }
+
     server {
         listen 80 default_server;
-        server_name _; # will never match
+        server_name ~^deis\.(?<domain>.+)$;
         server_name_in_redirect off;
+        port_in_redirect off;
+
+        location / {
+            proxy_buffering             off;
+            proxy_set_header            Host $host;
+            proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_redirect              off;
+            proxy_connect_timeout       10;
+            proxy_send_timeout          30;
+            proxy_read_timeout          30;
+
+            proxy_pass                  http://deis-controller;
+        }
     }
 
     # service definitions for each application
diff --git a/test/Rakefile b/test/Rakefile
@@ -22,10 +22,10 @@ end
 namespace :tests do
   task :all => ['register','login','add_key','create_cluster','create_app','push_app','scale_app','verify_app']
   task :register do
-    run_command("deis register http://#{HOSTNAME}:8000 --username=test --email=test@test.co.nz --password=asdf1234 || true")
+    run_command("deis register http://deis.#{HOSTNAME} --username=test --email=test@test.co.nz --password=asdf1234 || true")
   end
   task :login do
-    run_command("deis login http://#{HOSTNAME}:8000 --username=test --password=asdf1234")
+    run_command("deis login http://deis.#{HOSTNAME} --username=test --password=asdf1234")
   end
   task :add_key do
     run_command("deis keys:add #{AUTH_KEY}.pub")
