Merge pull request #813 from deis/rename-containers

refactor(client): rename containers to ps

Author: Matthew Fisher

client/deis.py

@@ -14,7 +14,7 @@
 
   apps          manage applications used to provide services
   clusters      manage clusters used to host applications
-  containers    manage containers used to handle requests and jobs
+  ps            manage processes inside an app container
   config        manage environment variables that define app config
   builds        manage builds created using `git push`
   releases      manage releases of an application
@@ -25,7 +25,7 @@
 Developer shortcut commands::
 
   create        create a new application
-  scale         scale containers by type (web=2, worker=1)
+  scale         scale processes by type (web=2, worker=1)
   info          view information about the current app
   open          open a URL to the app in a browser
   logs          view aggregated log info for the app
@@ -549,7 +549,7 @@ def apps_info(self, args):
             print("=== {} Application".format(app))
             print(json.dumps(response.json(), indent=2))
             print()
-            self.containers_list(args)
+            self.ps_list(args)
             print()
         else:
             raise ResponseError(response)
@@ -1055,24 +1055,24 @@ def config_unset(self, args):
         else:
             raise ResponseError(response)
 
-    def containers(self, args):
+    def ps(self, args):
         """
-        Valid commands for containers:
+        Valid commands for processes:
 
-        containers:list        list application containers
-        containers:scale       scale app containers (e.g. web=4 worker=2)
+        ps:list        list application processes
+        ps:scale       scale processes (e.g. web=4 worker=2)
 
         Use `deis help [command]` to learn more
         """
-        sys.argv[1] = 'containers:list'
-        args = docopt(self.containers_list.__doc__)
-        return self.containers_list(args)
+        sys.argv[1] = 'ps:list'
+        args = docopt(self.ps_list.__doc__)
+        return self.ps_list(args)
 
-    def containers_list(self, args, app=None):
+    def ps_list(self, args, app=None):
         """
-        List containers servicing an application
+        List processes servicing an application
 
-        Usage: deis containers:list [--app=<app>]
+        Usage: deis ps:list [--app=<app>]
         """
         if not app:
             app = args.get('--app')
@@ -1082,10 +1082,10 @@ def containers_list(self, args, app=None):
                                   "/api/apps/{}/containers".format(app))
         if response.status_code != requests.codes.ok:  # @UndefinedVariable
             raise ResponseError(response)
-        containers = response.json()
-        print("=== {} Containers".format(app))
+        processes = response.json()
+        print("=== {} Processes".format(app))
         c_map = {}
-        for item in containers['results']:
+        for item in processes['results']:
             c_map.setdefault(item['type'], []).append(item)
         print()
         for c_type in c_map.keys():
@@ -1094,13 +1094,13 @@ def containers_list(self, args, app=None):
                 print("{type}.{num} {state} ({release})".format(**c))
             print()
 
-    def containers_scale(self, args):
+    def ps_scale(self, args):
         """
-        Scale an application's containers by type
+        Scale an application's processes by type
 
-        Example: deis containers:scale web=4 worker=2
+        Example: deis ps:scale web=4 worker=2
 
-        Usage: deis containers:scale <type=num>... [--app=<app>]
+        Usage: deis ps:scale <type=num>... [--app=<app>]
         """
         app = args.get('--app')
         if not app:
@@ -1109,7 +1109,7 @@ def containers_scale(self, args):
         for type_num in args.get('<type=num>'):
             typ, count = type_num.split('=')
             body.update({typ: int(count)})
-        print('Scaling containers... but first, coffee!')
+        print('Scaling processes... but first, coffee!')
         try:
             progress = TextProgress()
             progress.start()
@@ -1122,7 +1122,7 @@ def containers_scale(self, args):
             progress.join()
         if response.status_code == requests.codes.no_content:  # @UndefinedVariable
             print('done in {}s\n'.format(int(time.time() - before)))
-            self.containers_list({}, app)
+            self.ps_list({}, app)
         else:
             raise ResponseError(response)
 
@@ -1568,8 +1568,7 @@ def shortcuts(self, args):
     ('register', 'auth:register'),
     ('login', 'auth:login'),
     ('logout', 'auth:logout'),
-    ('ps', 'containers:list'),
-    ('scale', 'containers:scale'),
+    ('scale', 'ps:scale'),
     ('rollback', 'releases:rollback'),
     ('sharing', 'perms:list'),
     ('sharing:list', 'perms:list'),

docs/client/containers.rst

@@ -1,10 +1,10 @@
-:title: Containers
-:description: Learn how to list and scale Deis containers for an application using the Deis client.
+:title: Processes
+:description: Learn how to list and scale Deis processes for an application using the Deis client.
 
 
-containers
-==========
+processes
+=========
 
-.. automethod:: client.deis.DeisClient.containers_list
-.. automethod:: client.deis.DeisClient.containers_scale
+.. automethod:: client.deis.DeisClient.ps_list
+.. automethod:: client.deis.DeisClient.ps_scale
 

docs/client/index.rst

@@ -28,7 +28,7 @@ Client Reference
     keys
 
     apps
-    containers
+    ps
     config
     builds
     releases

docs/client/scale.rst

@@ -1,9 +1,9 @@
 :title: Scale
-:description: Learn how to scale containers for a Deis application using the Deis client.
+:description: Learn how to scale processes for a Deis application using the Deis client.
 
 
 scale
 =====
 
-.. automethod:: client.deis.DeisClient.containers_scale
+.. automethod:: client.deis.DeisClient.ps_scale
    :noindex:

docs/developer/manage-application.rst

@@ -32,10 +32,10 @@ that power your app.
 .. code-block:: console
 
     $ deis scale web=8
-    Scaling containers... but first, coffee!
+    Scaling processes... but first, coffee!
     done in 20s
 
-    === peachy-waxworks Containers
+    === peachy-waxworks Processes
 
     --- web: `java -cp target/classes:target/dependency/* HelloWorld`
     web.1 up 2013-12-03T00:00:25.836Z (dev-runtime-1)

docs/gettingstarted/concepts.rst

@@ -46,7 +46,7 @@ CoreOS
 needed by modern infrastructure stacks and targeted at massive
 server deployments.
 
-Deis applications are containers running on CoreOS machines, which can
+Deis applications are processes running on CoreOS machines, which can
 be private or public cloud instances, or bare metal. CoreOS clusters
 allow Deis to host applications and services at scale with
 high resilience.
@@ -75,7 +75,7 @@ An :ref:`application`, or app, lives on a :ref:`cluster`, where it uses
 deployed git repository.
 
 Developers use :ref:`Applications <application>` to push code, change
-configuration, scale containers, view logs, or run admin commands --
+configuration, scale processes, view logs, or run admin commands --
 regardless of the cluster's underlying infrastructure.
 
 .. _concepts_build_release_run:
@@ -99,7 +99,7 @@ changed, making it easy to rollback code and configuration.
 Run Stage
 ^^^^^^^^^
 The run stage shells out jobs to the scheduler. The scheduler is in control of balancing the
-containers evenly across the cluster, as well as the announcers and the loggers for each
+processes evenly across the cluster, as well as the announcers and the loggers for each
 application. The scheduler uses SSH to submit jobs to each node in the cluster and updates
 the proxy component between releases, making zero downtime deployments possible.