Merge pull request #2605 from bacongobbler/fix-get-command

feat(controller): send procfile entries to scheduler

Author: Matthew Fisher

client/Makefile

@@ -1,6 +1,6 @@
 
 build: setup-venv
-	venv/bin/pip install docopt==0.6.2 python-dateutil==2.2 requests==2.4.3 pyinstaller==2.1 termcolor==1.1.0
+	venv/bin/pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.4.3 pyinstaller==2.1 termcolor==1.1.0
 	venv/bin/pyinstaller deis.spec
 	chmod +x dist/deis
 

client/README.rst

@@ -75,7 +75,7 @@ you used to provision the server. You can make a symlink or shell alias for
 
 .. code-block:: console
 
-    $ pip install docopt==0.6.2 python-dateutil==2.2 requests==2.4.3 termcolor==1.1.0
+    $ pip install docopt==0.6.2 python-dateutil==2.2 PyYAML==3.11 requests==2.4.3 termcolor==1.1.0
     $ sudo ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
     $ deis
     Usage: deis <command> [<args>...]

client/deis.py

@@ -59,6 +59,7 @@
 import time
 import urlparse
 import webbrowser
+import yaml
 
 from dateutil import parser
 from dateutil import relativedelta
@@ -878,7 +879,8 @@ def builds(self, args):
     def builds_create(self, args):
         """
         Creates a new build of an application. Imports an <image> and deploys it to Deis
-        as a new release.
+        as a new release. If a Procfile is present in the current directory, it will be used
+        as the default process types for this application.
 
         Usage: deis builds:create <image> [options]
 
@@ -890,11 +892,28 @@ def builds_create(self, args):
         Options:
           -a --app=<app>
             The uniquely identifiable name for the application.
+          -p --procfile=<procfile>
+            A YAML string used to supply a Procfile to the application.
         """
         app = args.get('--app')
         if not app:
             app = self._session.app
         body = {'image': args['<image>']}
+        procfile = args.get('--procfile')
+        if procfile:
+            try:
+                body['procfile'] = yaml.load(procfile)
+            except yaml.YAMLError:
+                self._logger.error('could not parse --procfile')
+                sys.exit(1)
+        else:
+            # read in Procfile for default process types
+            if os.path.exists('Procfile'):
+                try:
+                    body['procfile'] = yaml.load(open('Procfile'))
+                except yaml.YAMLError:
+                    self._logger.error('could not parse Procfile')
+                    sys.exit(1)
         sys.stdout.write('Creating build... ')
         sys.stdout.flush()
         try:

client/setup.py

@@ -57,7 +57,9 @@
       ],
       long_description=LONG_DESCRIPTION,
       install_requires=[
-          'docopt==0.6.2', 'python-dateutil==2.2', 'requests==2.4.3', 'termcolor==1.1.0'
+          'docopt==0.6.2', 'python-dateutil==2.2',
+          'PyYAML==3.11', 'requests==2.4.3',
+          'termcolor==1.1.0'
       ],
       zip_safe=True,
       **KWARGS)

controller/api/models.py

@@ -404,7 +404,11 @@ def _get_command(self):
         # handle special case for Dockerfile deployments
         if self.type == 'cmd':
             return ''
-        else:
+        try:
+            # ensure they cannot break out and run commands on the host
+            return "bash -c '{}'".format(self.release.build.procfile[self.type])
+        # if the key is not present or if a parent attribute is None
+        except (KeyError, TypeError):
             return 'start {}'.format(self.type)
 
     _command = property(_get_command)

controller/api/tests/test_container.py

@@ -435,3 +435,36 @@ def test_scale_without_build_should_error(self):
                                     HTTP_AUTHORIZATION='token {}'.format(self.token))
         self.assertEqual(response.status_code, 400)
         self.assertEqual(response.data, "No build associated with this release")
+
+    def test_command_good(self):
+        """Test the default command for each container workflow"""
+        url = '/v1/apps'
+        response = self.client.post(url, HTTP_AUTHORIZATION='token {}'.format(self.token))
+        self.assertEqual(response.status_code, 201)
+        app_id = response.data['id']
+        app = App.objects.get(id=app_id)
+        user = User.objects.get(username='autotest')
+        build = Build.objects.create(owner=user,
+                                     app=app,
+                                     image="qwerty",
+                                     procfile={'web': 'node server.js',
+                                               'worker': 'node worker.js'})
+        # create an initial release
+        release = Release.objects.create(version=2,
+                                         owner=user,
+                                         app=app,
+                                         config=app.config_set.latest(),
+                                         build=build)
+        # create a container
+        c = Container.objects.create(owner=user,
+                                     app=app,
+                                     release=release,
+                                     type='web',
+                                     num=1)
+        self.assertEqual(c._command, "bash -c 'node server.js'")
+        c.type = 'worker'
+        self.assertEqual(c._command, "bash -c 'node worker.js'")
+        c.release.build.procfile = None
+        self.assertEqual(c._command, 'start worker')
+        c.type = 'cmd'
+        self.assertEqual(c._command, '')

docs/docs_requirements.txt

@@ -19,6 +19,7 @@ gunicorn==19.1.1
 paramiko==1.14.1
 psycopg2==2.5.4
 python-etcd==0.3.2
+PyYAML==3.11
 South==1.0.1
 
 # Deis client requirements

docs/using_deis/index.rst

@@ -15,6 +15,7 @@ Using Deis
     install-client
     register-user
     deploy-application
+    process-types
     using-buildpacks
     using-dockerfiles
     using-docker-images

docs/using_deis/process-types.rst

@@ -0,0 +1,91 @@
+:title: Process Types and the Procfile
+:description: First steps for using the 12 factor process model with Deis.
+
+.. _process-types:
+
+Process Types and the Procfile
+==============================
+
+A Procfile is a mechanism for declaring what commands are run by your application’s containers on
+the Deis platform. It follows the `process model`_. You can use a Procfile to declare various
+process types, such as multiple types of workers, a singleton process like a clock, or a consumer
+of the Twitter streaming API.
+
+Process Types as Templates
+--------------------------
+
+A Procfile is a text file named ``Procfile`` placed in the root of your application that lists the
+process types in an application. Each process type is a declaration of a command that is executed
+when a container of that process type is started.
+
+All the language and frameworks using :ref:`Heroku's Buildpacks <using-buildpacks>` declare a
+``web`` process type, which starts the application server. Rails 3 has the following process type:
+
+.. code-block:: console
+
+    web: bundle exec rails server -p $PORT
+
+All applications using :ref:`Dockerfile deployments <using-dockerfiles>` have an implied ``cmd``
+process type, which spawns the default process of a Docker image:
+
+.. code-block:: console
+
+    $ cat Dockerfile
+    FROM centos:latest
+    COPY . /app
+    WORKDIR /app
+    CMD python -m SimpleHTTPServer 5000
+    EXPOSE 5000
+
+For applications using :ref:`Docker image deployments <using-docker-images>`, a ``cmd`` process
+type is also implied and spawns the default process of the image.
+
+Declaring Process Types
+-----------------------
+
+Process types are declared via a file named ``Procfile``, placed in the root of your app. Its
+format is one process type per line, with each line containing:
+
+.. code-block:: console
+
+    <process type>: <command>
+
+The syntax is defined as:
+
+``<process type>`` – an alphanumeric string, is a name for your command, such as web, worker, urgentworker, clock, etc.
+
+``<command>`` – a command line to launch the process, such as ``rake jobs:work``.
+
+.. note::
+
+    The web and cmd process types are special as they’re the only process types that will receive
+    HTTP traffic from Deis’s routers. Other process types can be named arbitrarily.
+
+Deploying to Deis
+-----------------
+
+A ``Procfile`` is not necessary to deploy most languages supported by Deis. The platform
+automatically detects the language and supplies a default ``web`` process type to boot the server.
+
+Creating an explicit Procfile is recommended for greater control and flexibility over your app.
+
+For Deis to use your Procfile, add the Procfile to the root of your application, then push to Deis:
+
+.. code-block:: console
+
+    $ git add .
+    $ git commit -m "Procfile"
+    $ git push deis master
+    ...
+    -----> Procfile declares process types: web, worker
+    Compiled slug size is 10.4MB
+
+           Launching... done, v2
+
+    -----> unisex-huntress deployed to Deis
+           http://unisex-huntress.example.com
+
+For Docker image deployments, a Procfile in the current directory or specified by
+``deis push --procfile`` will define the default process types for the application.
+
+.. _`process model`: https://devcenter.heroku.com/articles/process-model

docs/using_deis/using-docker-images.rst

@@ -72,13 +72,6 @@ Because you are deploying a Docker image, the ``cmd`` process type is automatica
 
     Support for Docker registry authentication is coming soon
 
-Define Process Types
---------------------
-Docker containers have a default command usually specified by a `CMD instruction`_.
-Deis uses the ``cmd`` process type to refer to this default command.
-
-Process types other than ``cmd`` are not supported when using Docker images.
-
 
 .. _`Docker Image`: https://docs.docker.com/introduction/understanding-docker/
 .. _`DockerHub`: https://registry.hub.docker.com/