Merge pull request #966 from kmala/maint

feat(model): Add new model to store settings

Author: kmala

…pi/migrations/0012_auto_20160810_1603.py …pi/migrations/0011_auto_20160810_1603.pyrootfs/api/migrations/0012_auto_20160810_1603.py renamed to rootfs/api/migrations/0011_auto_20160810_1603.py rootfs/api/migrations/0012_auto_20160810_1603.py renamed to rootfs/api/migrations/0011_auto_20160810_1603.py

@@ -9,7 +9,7 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('api', '0011_config_routable'),
+        ('api', '0010_config_healthcheck'),
     ]
 
     operations = [

rootfs/api/migrations/0011_config_routable.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.8 on 2016-08-16 19:34
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import uuid
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('api', '0011_auto_20160810_1603'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='AppSettings',
+            fields=[
+                ('uuid', models.UUIDField(auto_created=True, default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True, verbose_name='UUID')),
+                ('created', models.DateTimeField(auto_now_add=True)),
+                ('updated', models.DateTimeField(auto_now=True)),
+                ('maintenance', models.NullBooleanField(default=None)),
+                ('routable', models.NullBooleanField(default=None)),
+                ('app', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.App')),
+                ('owner', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'get_latest_by': 'created',
+                'ordering': ['-created'],
+            },
+        ),
+        migrations.AlterUniqueTogether(
+            name='appsettings',
+            unique_together=set([('app', 'uuid')]),
+        ),
+    ]

rootfs/api/migrations/0012_auto_20160816_1934.py

@@ -61,6 +61,10 @@ def _fetch_service_config(self, app):
             default = {'metadata': {'annotations': {}}}
             svc = dict_merge(svc, default)
 
+        if 'labels' not in svc['metadata']:
+            default = {'metadata': {'labels': {}}}
+            svc = dict_merge(svc, default)
+
         return svc
 
     def _load_service_config(self, app, component):
@@ -117,6 +121,7 @@ class Meta:
 from .release import Release  # noqa
 from .config import Config  # noqa
 from .build import Build  # noqa
+from .appsettings import AppSettings  # noqa
 
 # define update/delete callbacks for synchronizing
 # models with the configuration management backend
@@ -142,6 +147,12 @@ def _log_config_updated(**kwargs):
     config.app.log("config {} updated".format(config))
 
 
+def _log_app_settings_updated(**kwargs):
+    appSettings = kwargs['instance']
+    # log only to the controller; this event will be logged in the release summary
+    appSettings.app.log("application settings {} updated".format(appSettings))
+
+
 def _log_domain_added(**kwargs):
     if kwargs.get('created'):
         domain = kwargs['instance']
@@ -170,6 +181,7 @@ def _log_cert_removed(**kwargs):
 post_save.connect(_log_config_updated, sender=Config, dispatch_uid='api.models.log')
 post_save.connect(_log_domain_added, sender=Domain, dispatch_uid='api.models.log')
 post_save.connect(_log_cert_added, sender=Certificate, dispatch_uid='api.models.log')
+post_save.connect(_log_app_settings_updated, sender=AppSettings, dispatch_uid='api.models.log')
 post_delete.connect(_log_domain_removed, sender=Domain, dispatch_uid='api.models.log')
 post_delete.connect(_log_cert_removed, sender=Certificate, dispatch_uid='api.models.log')
 

rootfs/api/models/__init__.py

@@ -23,6 +23,7 @@
 from api.models.release import Release
 from api.models.config import Config
 from api.models.domain import Domain
+from api.models.appsettings import AppSettings
 
 from scheduler import KubeHTTPException, KubeException
 
@@ -178,7 +179,7 @@ def log(self, message, level=logging.INFO):
 
     def create(self, *args, **kwargs):  # noqa
         """
-        Create a application with an initial config, release, domain
+        Create a application with an initial config, settings, release, domain
         and k8s resource if needed
         """
         try:
@@ -220,6 +221,10 @@ def create(self, *args, **kwargs):  # noqa
 
             raise ServiceUnavailable('Kubernetes resources could not be created') from e
 
+        try:
+            self.appsettings_set.latest()
+        except AppSettings.DoesNotExist:
+            AppSettings.objects.create(owner=self.owner, app=self)
         # Attach the platform specific application sub domain to the k8s service
         # Only attach it on first release in case a customer has remove the app domain
         if rel.version == 1 and not Domain.objects.filter(domain=self.id).exists():
@@ -389,6 +394,7 @@ def scale(self, user, structure):  # noqa
 
     def _scale_pods(self, scale_types):
         release = self.release_set.latest()
+        app_settings = self.appsettings_set.latest()
         version = "v{}".format(release.version)
         image = release.image
         envs = self._build_env_vars(release.build.type, version, image, release.config.values)
@@ -403,7 +409,7 @@ def _scale_pods(self, scale_types):
         for scale_type, replicas in scale_types.items():
             # only web / cmd are routable
             # http://docs.deis.io/en/latest/using_deis/process-types/#web-vs-cmd-process-types
-            routable = True if scale_type in ['web', 'cmd'] and release.config.routable else False
+            routable = True if scale_type in ['web', 'cmd'] and app_settings.routable else False
             # fetch application port and inject into ENV Vars as needed
             port = release.get_port()
             if port:
@@ -424,6 +430,7 @@ def _scale_pods(self, scale_types):
                 'app_type': scale_type,
                 'build_type': release.build.type,
                 'healthcheck': healthcheck,
+                'service_annotations': {'maintenance': app_settings.maintenance},
                 'routable': routable,
                 'deploy_batches': batches,
                 'deploy_timeout': deploy_timeout,
@@ -461,6 +468,8 @@ def deploy(self, release, force_deploy=False):
         if release.build is None:
             raise DeisException('No build associated with this release')
 
+        app_settings = self.appsettings_set.latest()
+
         # use create to make sure minimum resources are created
         self.create()
 
@@ -486,7 +495,7 @@ def deploy(self, release, force_deploy=False):
         for scale_type, replicas in self.structure.items():
             # only web / cmd are routable
             # http://docs.deis.io/en/latest/using_deis/process-types/#web-vs-cmd-process-types
-            routable = True if scale_type in ['web', 'cmd'] and release.config.routable else False
+            routable = True if scale_type in ['web', 'cmd'] and app_settings.routable else False
             # fetch application port and inject into ENV vars as needed
             port = release.get_port()
             if port:
@@ -509,6 +518,7 @@ def deploy(self, release, force_deploy=False):
                 'build_type': release.build.type,
                 'healthcheck': healthcheck,
                 'routable': routable,
+                'service_annotations': {'maintenance': app_settings.maintenance},
                 'deploy_batches': batches,
                 'deploy_timeout': deploy_timeout,
                 'deployment_history_limit': deployment_history,
@@ -597,7 +607,8 @@ def verify_application_health(self, **kwargs):
         """
         # Bail out early if the application is not routable
         release = self.release_set.latest()
-        if not kwargs.get('routable', False) and release.config.routable:
+        app_settings = self.appsettings_set.latest()
+        if not kwargs.get('routable', False) and app_settings.routable:
             return
 
         app_type = kwargs.get('app_type')

rootfs/api/models/app.py

@@ -0,0 +1,102 @@
+import logging
+from django.conf import settings
+from django.db import models
+
+from api.models import UuidAuditedModel
+from api.exceptions import DeisException, AlreadyExists
+from scheduler import KubeException
+
+
+class AppSettings(UuidAuditedModel):
+    """
+    Instance of Application settings used by scheduler
+    """
+
+    owner = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.PROTECT)
+    app = models.ForeignKey('App', on_delete=models.CASCADE)
+    maintenance = models.NullBooleanField(default=None)
+    routable = models.NullBooleanField(default=None)
+
+    class Meta:
+        get_latest_by = 'created'
+        unique_together = (('app', 'uuid'))
+        ordering = ['-created']
+
+    def __str__(self):
+        return "{}-{}".format(self.app.id, str(self.uuid)[:7])
+
+    def set_maintenance(self, maintenance):
+        namespace = self.app.id
+        service = self._fetch_service_config(namespace)
+        old_service = service.copy()  # in case anything fails for rollback
+
+        try:
+            service['metadata']['annotations']['router.deis.io/maintenance'] = str(maintenance)
+            self._scheduler.update_service(namespace, namespace, data=service)
+        except Exception as e:
+            self._scheduler.update_service(namespace, namespace, data=old_service)
+            raise KubeException(str(e)) from e
+
+    def set_routable(self, routable):
+        namespace = self.app.id
+        service = self._fetch_service_config(namespace)
+        old_service = service.copy()  # in case anything fails for rollback
+
+        try:
+            service['metadata']['labels']['router.deis.io/routable'] = str(routable).lower()
+            self._scheduler.update_service(namespace, namespace, data=service)
+        except Exception as e:
+            self._scheduler.update_service(namespace, namespace, data=old_service)
+            raise KubeException(str(e)) from e
+
+    def update_maintenance(self, previous_settings):
+        prev_maintenance = getattr(previous_settings, 'maintenance', None)
+        new_maintenance = getattr(self, 'maintenance', None)
+        # If no previous settings, assume this is first timeout
+        # and set the default maintenance as false
+        if not previous_settings:
+            setattr(self, 'maintenance', False)
+            self.set_maintenance(False)
+        # if nothing changed copy the settings from previous
+        elif new_maintenance is None and prev_maintenance is not None:
+            setattr(self, 'maintenance', prev_maintenance)
+        elif prev_maintenance != new_maintenance:
+            self.set_maintenance(new_maintenance)
+            self.summary += "{} changed maintenance mode from {} to {}".format(self.owner, prev_maintenance, new_maintenance)  # noqa
+
+    def update_routable(self, previous_settings):
+        old_routable = getattr(previous_settings, 'routable', None)
+        new_routable = getattr(self, 'routable', None)
+        # If no previous settings, assume this is first timeout
+        # and set the default maintenance as true
+        if not previous_settings:
+            setattr(self, 'routable', True)
+            self.set_routable(True)
+        # if nothing changed copy the settings from previous
+        elif new_routable is None and old_routable is not None:
+            setattr(self, 'routable', old_routable)
+        elif old_routable != new_routable:
+            self.set_routable(new_routable)
+            self.summary += "{} changed routablity from {} to {}".format(self.owner, old_routable, new_routable)  # noqa
+
+    def save(self, *args, **kwargs):
+        self.summary = ''
+        previous_settings = None
+        try:
+            previous_settings = self.app.appsettings_set.latest()
+        except AppSettings.DoesNotExist:
+            pass
+
+        try:
+            self.update_maintenance(previous_settings)
+            self.update_routable(previous_settings)
+        except Exception as e:
+            self.delete()
+            raise DeisException(str(e)) from e
+
+        if not self.summary and previous_settings:
+            self.delete()
+            raise AlreadyExists("{} changed nothing".format(self.owner))
+        self.app.log('summary of app setting changes: {}'.format(self.summary), logging.DEBUG)
+
+        return super(AppSettings, self).save(**kwargs)

rootfs/api/models/appsettings.py

@@ -21,7 +21,6 @@ class Config(UuidAuditedModel):
     tags = JSONField(default={}, blank=True)
     registry = JSONField(default={}, blank=True)
     healthcheck = JSONField(default={}, blank=True)
-    routable = models.BooleanField(default=True)
 
     class Meta:
         get_latest_by = 'created'

rootfs/api/models/config.py

@@ -472,17 +472,6 @@ def save(self, *args, **kwargs):  # noqa
                         self.summary += ' and '
                     self.summary += "{} {}".format(self.config.owner, changes)
 
-                # if the routable flag changed, log that too
-                changes = []
-                old_routable = old_config.routable if old_config else True
-                enabled = "enabled routing" if self.config.routable and not old_routable else ''
-                disabled = "disabled routing" if not self.config.routable and old_routable else ''
-                changes = ', '.join(i for i in (enabled, disabled) 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)

rootfs/api/models/release.py

@@ -479,3 +479,15 @@ class PodSerializer(serializers.BaseSerializer):
 
     def to_representation(self, obj):
         return obj
+
+
+class AppSettingsSerializer(serializers.ModelSerializer):
+    """Serialize a :class:`~api.models.AppSettings` model."""
+
+    app = serializers.SlugRelatedField(slug_field='id', queryset=models.App.objects.all())
+    owner = serializers.ReadOnlyField(source='owner.username')
+
+    class Meta:
+        """Metadata options for a :class:`AppSettingsSerializer`."""
+        model = models.AppSettings
+        fields = '__all__'