Merge pull request #1665 from gabrtv/tags

Application tags for scheduling to specific hosts

Author: Gabriel Monroy

client/deis.py

@@ -19,6 +19,7 @@
   domains       manage and assign domain names to your applications
   builds        manage builds created using `git push`
   limits        manage resource limits for your application
+  tags          manage tags for application containers
   releases      manage releases of an application
 
   keys          manage ssh keys used for `git push` deployments
@@ -1591,6 +1592,127 @@ def ps_scale(self, args):
         else:
             raise ResponseError(response)
 
+    def tags(self, args):
+        """
+        Valid commands for tags:
+
+        tags:list        list tags for an app
+        tags:set         set tags for an app
+        tags:unset       unset tags for an app
+
+        Use `deis help [command]` to learn more.
+        """
+        sys.argv[1] = 'tags:list'
+        args = docopt(self.tags_list.__doc__)
+        return self.tags_list(args)
+
+    def tags_list(self, args):
+        """
+        Lists tags for an application.
+
+        Usage: deis tags:list [options]
+
+        Options:
+          -a --app=<app>
+            the uniquely identifiable name of the application.
+        """
+        app = args.get('--app')
+        if not app:
+            app = self._session.app
+        response = self._dispatch('get', "/api/apps/{}/config".format(app))
+        if response.status_code == requests.codes.ok:  # @UndefinedVariable
+            self._print_tags(app, response.json())
+        else:
+            raise ResponseError(response)
+
+    def tags_set(self, args):
+        """
+        Sets tags for an application.
+
+        A tag is a key/value pair used to tag an application's containers.
+        This is often used to restrict workloads to specific hosts.
+
+        Usage: deis tags:set [options] <key>=<value>...
+
+        Arguments:
+          <key> the tag key, for example: "environ" or "rack"
+          <value> the tag value, for example: "prod" or "1"
+
+        Options:
+          -a --app=<app>
+            the uniquely identifiable name for the application.
+        """
+        app = args.get('--app')
+        if not app:
+            app = self._session.app
+        body = {}
+        body['tags'] = json.dumps(dictify(args['<key>=<value>']))
+        sys.stdout.write('Applying tags... ')
+        sys.stdout.flush()
+        try:
+            progress = TextProgress()
+            progress.start()
+            response = self._dispatch('post', "/api/apps/{}/config".format(app), json.dumps(body))
+        finally:
+            progress.cancel()
+            progress.join()
+        if response.status_code == requests.codes.created:  # @UndefinedVariable
+            version = response.headers['x-deis-release']
+            print("done, v{}\n".format(version))
+
+            self._print_tags(app, response.json())
+        else:
+            raise ResponseError(response)
+
+    def tags_unset(self, args):
+        """
+        Unsets tags for an application.
+
+        Usage: deis tags:unset [options] <key>...
+
+        Arguments:
+          <key> the tag key to unset, for example: "environ" or "rack"
+
+        Options:
+          -a --app=<app>
+            the uniquely identifiable name for the application.
+        """
+        app = args.get('--app')
+        if not app:
+            app = self._session.app
+        values = {}
+        for k in args.get('<key>'):
+            values[k] = None
+        body = {}
+        body['tags'] = json.dumps(values)
+        sys.stdout.write('Applying tags... ')
+        sys.stdout.flush()
+        try:
+            progress = TextProgress()
+            progress.start()
+            response = self._dispatch('post', "/api/apps/{}/config".format(app), json.dumps(body))
+        finally:
+            progress.cancel()
+            progress.join()
+        if response.status_code == requests.codes.created:  # @UndefinedVariable
+            version = response.headers['x-deis-release']
+            print("done, v{}\n".format(version))
+            self._print_tags(app, response.json())
+        else:
+            raise ResponseError(response)
+
+    def _print_tags(self, app, config):
+        items = json.loads(config['tags'])
+        print("=== {} Tags".format(app))
+        if len(items) == 0:
+            print('No tags defined')
+            return
+        keys = sorted(items)
+        width = max(map(len, keys)) + 5
+        for k in keys:
+            v = items[k]
+            print(("{k:<" + str(width) + "} {v}").format(**locals()))
+
     def keys(self, args):
         """
         Valid commands for SSH keys:

controller/api/models.py

@@ -337,7 +337,8 @@ def _command_announceable(self):
     def create(self):
         image = self.release.image
         kwargs = {'memory': self.release.config.memory,
-                  'cpu': self.release.config.cpu}
+                  'cpu': self.release.config.cpu,
+                  'tags': self.release.config.tags}
         self._scheduler.create(name=self._job_id,
                                image=image,
                                command=self._command,
@@ -366,7 +367,8 @@ def deploy(self, release):
         image = self.release.image
         c_type = self.type
         kwargs = {'memory': self.release.config.memory,
-                  'cpu': self.release.config.cpu}
+                  'cpu': self.release.config.cpu,
+                  'tags': self.release.config.tags}
         self._scheduler.create(name=new_job_id,
                                image=image,
                                command=self._command.format(**locals()),
@@ -459,6 +461,7 @@ class Config(UuidAuditedModel):
     values = JSONField(default={}, blank=True)
     memory = JSONField(default={}, blank=True)
     cpu = JSONField(default={}, blank=True)
+    tags = JSONField(default={}, blank=True)
 
     class Meta:
         get_latest_by = 'created'
@@ -595,6 +598,22 @@ def save(self, *args, **kwargs):  # noqa
                 if changes:
                     changes = 'changed limits for '+', '.join(changes)
                     self.summary += "{} {}".format(self.config.owner, changes)
+                # if the tags changed, log the dict diff
+                changes = []
+                old_tags = old_config.tags if old_config else {}
+                diff = dict_diff(self.config.tags, old_tags)
+                # try to be as succinct as possible
+                added = ', '.join(k for k in diff.get('added', {}))
+                added = 'added tag ' + added if added else ''
+                changed = ', '.join(k for k in diff.get('changed', {}))
+                changed = 'changed tag ' + changed if changed else ''
+                deleted = ', '.join(k for k in diff.get('deleted', {}))
+                deleted = 'deleted tag ' + deleted if deleted else ''
+                changes = ', '.join(i for i in (added, changed, deleted) if i)
+                if changes:
+                    if self.summary:
+                        self.summary += ' and '
+                    self.summary += "{} {}".format(self.config.owner, changes)
             if not self.summary:
                 if self.version == 1:
                     self.summary = "{} created the initial release".format(self.owner)

controller/api/serializers.py

@@ -17,6 +17,8 @@
 PROCTYPE_MATCH = re.compile(r'^(?P<type>[a-z]+)')
 MEMLIMIT_MATCH = re.compile(r'^(?P<mem>[0-9]+[BbKkMmGg])$')
 CPUSHARE_MATCH = re.compile(r'^(?P<cpu>[0-9]+)$')
+TAGKEY_MATCH = re.compile(r'^[a-z]+$')
+TAGVAL_MATCH = re.compile(r'^\w+$')
 
 
 class OwnerSlugRelatedField(serializers.SlugRelatedField):
@@ -114,6 +116,8 @@ class ConfigSerializer(serializers.ModelSerializer):
         model_field=models.Config()._meta.get_field('memory'), required=False)
     cpu = serializers.ModelField(
         model_field=models.Config()._meta.get_field('cpu'), required=False)
+    tags = serializers.ModelField(
+        model_field=models.Config()._meta.get_field('tags'), required=False)
 
     class Meta:
         """Metadata options for a :class:`ConfigSerializer`."""
@@ -149,6 +153,16 @@ def validate_cpu(self, attrs, source):
                     raise serializers.ValidationError("CPU shares must be between 0 and 1024")
         return attrs
 
+    def validate_tags(self, attrs, source):
+        for k, v in attrs.get(source, {}).items():
+            if v is None:  # use NoneType to unset a value
+                continue
+            if not re.match(TAGKEY_MATCH, k):
+                raise serializers.ValidationError("Tag keys can only contain [a-z]")
+            if not re.match(TAGVAL_MATCH, str(v)):
+                raise serializers.ValidationError("Invalid tag value")
+        return attrs
+
 
 class ReleaseSerializer(serializers.ModelSerializer):
     """Serialize a :class:`~api.models.Release` model."""