Merge pull request #197 from helgi/dotted

feat(k8s): use dotted format instead of JSON for router domain configuration

Author: helgi

rootfs/api/models.py

@@ -12,8 +12,8 @@
 import logging
 import re
 import time
-import json
 import uuid
+import morph
 from threading import Thread
 
 from django.conf import settings
@@ -1001,40 +1001,61 @@ def _scheduler(self):
                                    settings.SCHEDULER_AUTH,
                                    settings.SCHEDULER_OPTIONS)
 
-    def _load_service_config(self, app):
+    def _fetch_service_config(self, app):
         # Get the service from k8s to attach the domain correctly
         svc = self._scheduler._get_service(app, app).json()
         # Get minimum structure going if it is missing on the service
         if 'metadata' not in svc or 'annotations' not in svc['metadata']:
             default = {'metadata': {'annotations': {}}}
             svc = dict_merge(svc, default)
 
-        # Check if any config has been set
-        if 'deis.io/routerConfig' not in svc['metadata']['annotations']:
-            config = {}
-        else:
-            config = json.loads(svc['metadata']['annotations']['deis.io/routerConfig'])
+        return svc
 
-        # See if domains are available
-        if 'domains' not in config:
-            config['domains'] = []
+    def _load_service_config(self, app, component):
+        # fetch setvice definition with minimum structure
+        svc = self._fetch_service_config(app)
+
+        # always assume a .deis.io/ ending
+        component = "%s.deis.io/" % component
+
+        # Filter to only include values for the component and strip component out of it
+        # Processes dots into a nested structure
+        config = morph.unflatten(morph.pick(svc['metadata']['annotations'], prefix=component))
+
+        return config
 
-        return svc, config
+    def _save_service_config(self, app, component, data):
+        # fetch setvice definition with minimum structure
+        svc = self._fetch_service_config(app)
+
+        # always assume a .deis.io ending
+        component = "%s.deis.io/" % component
+
+        # add component to data and flatten
+        data = {"%s%s" % (component, key): value for key, value in data.items()}
+        svc['metadata']['annotations'].update(morph.flatten(data))
+
+        # Update the k8s service for the application with new domain information
+        self._scheduler._update_service(app, app, svc)
 
     def save(self, *args, **kwargs):
         app = str(self.app)
         domain = str(self.domain)
 
-        # setup the service and config dict
-        svc, config = self._load_service_config(app)
-        if domain not in config['domains']:
-            config['domains'].append(domain)
+        # get annotations for the service
+        config = self._load_service_config(app, 'router')
 
-        # save as a JSON string since annotations don't take a structure on its keys
-        svc['metadata']['annotations']['deis.io/routerConfig'] = json.dumps(config)
+        # See if domains are available
+        if 'domains' not in config:
+            config['domains'] = ''
 
-        # Update the k8s service for the application with new domain information
-        self._scheduler._update_service(app, app, svc)
+        # convert from string to list to work with and filter out empty strings
+        domains = filter(None, config['domains'].split(','))
+        if domain not in domains:
+            domains.append(domain)
+        config['domains'] = ','.join(domains)
+
+        self._save_service_config(app, 'router', config)
 
         # Save to DB
         return super(Domain, self).save(*args, **kwargs)
@@ -1043,16 +1064,20 @@ def delete(self, *args, **kwargs):
         app = str(self.app)
         domain = str(self.domain)
 
-        # setup the service and config dict
-        svc, config = self._load_service_config(app)
-        if domain in config['domains']:
-            config['domains'].remove(domain)
+        # get annotations for the service
+        config = self._load_service_config(app, 'router')
 
-        # save as a JSON string since annotations don't take a structure on its keys
-        svc['metadata']['annotations']['deis.io/routerConfig'] = json.dumps(config)
+        # See if domains are available
+        if 'domains' not in config:
+            config['domains'] = ''
 
-        # Update the k8s service for the application with new domain information
-        self._scheduler._update_service(app, app, svc)
+        # convert from string to list to work with and filter out empty strings
+        domains = filter(None, config['domains'].split(','))
+        if domain in domains:
+            domains.remove(domain)
+        config['domains'] = ','.join(domains)
+
+        self._save_service_config(app, 'router', config)
 
         # Delete from DB
         return super(Domain, self).delete(*args, **kwargs)

rootfs/api/utils.py

@@ -141,26 +141,6 @@ def dict_merge(origin, merge):
     return result
 
 
-def flatten(collection):
-    """
-    Flatten an arbitrarily deep structure of dicts, lists and tuples and
-    extract the strings at the leaves of the structures.
-    """
-    vals = []
-    if isinstance(collection, basestring):
-        vals.append(collection)
-    elif isinstance(collection, (list, tuple)):
-        for item in collection:
-            vals.extend(flatten(item))
-    elif isinstance(collection, dict):
-        vals.extend(flatten(collection.values()))
-    else:
-        raise Exception(
-            "Can't extract values from a %s" % collection.__class__
-        )
-    return vals
-
-
 if __name__ == "__main__":
     import doctest
     doctest.testmod()

rootfs/requirements.txt

@@ -13,3 +13,4 @@ PyYAML==3.11
 requests==2.8.1
 simpleflock==0.0.2
 static==1.1.1
+morph==0.1.2

rootfs/scheduler/utils.py

@@ -31,23 +31,3 @@ def dict_merge(origin, merge):
             else:
                 result[key] = deepcopy(value)
     return result
-
-
-def flatten(collection):
-    """
-    Flatten an arbitrarily deep structure of dicts, lists and tuples and
-    extract the strings at the leaves of the structures.
-    """
-    vals = []
-    if isinstance(collection, basestring):
-        vals.append(collection)
-    elif isinstance(collection, (list, tuple)):
-        for item in collection:
-            vals.extend(flatten(item))
-    elif isinstance(collection, dict):
-        vals.extend(flatten(collection.values()))
-    else:
-        raise Exception(
-            "Can't extract values from a %s" % collection.__class__
-        )
-    return vals