import logging from django.conf import settings from django.db import models from django.contrib.auth import get_user_model from api.utils import dict_diff from api.exceptions import DryccException, AlreadyExists from scheduler import KubeHTTPException from .base import UuidAuditedModel User = get_user_model() logger = logging.getLogger(__name__) class Release(UuidAuditedModel): """ Software release deployed by the application platform Releases contain a :class:`Build` and a :class:`Config`. """ owner = models.ForeignKey(User, on_delete=models.PROTECT) app = models.ForeignKey('App', on_delete=models.CASCADE) version = models.PositiveIntegerField() summary = models.TextField(blank=True, null=True) failed = models.BooleanField(default=False) canary = models.BooleanField(default=False) exception = models.TextField(blank=True, null=True) config = models.ForeignKey('Config', on_delete=models.CASCADE) build = models.ForeignKey('Build', null=True, on_delete=models.CASCADE) class Meta: get_latest_by = 'created' ordering = ['-created'] unique_together = (('app', 'version'),) def __str__(self): return "{0}-v{1}".format(self.app.id, self.version) @property def image(self): return self.build.image def new(self, user, config, build, summary=None, canary=False): """ Create a new application release using the provided Build and Config on behalf of a user. Releases start at v1 and auto-increment. """ # construct fully-qualified target image new_version = self.app.release_set.latest().version + 1 # create new release and auto-increment version return Release.objects.create( owner=user, app=self.app, config=config, build=build, version=new_version, summary=summary, canary=canary ) def get_port(self): """ Get application port for a given release. If pulling from private registry then use default port or read from ENV var, otherwise attempt to pull from the container image """ try: envs = self.config.values creds = self.get_registry_auth() if self.build.type == "buildpack": self.app.log('buildpack type detected. Defaulting to $PORT 5000') return 5000 # application has registry auth - $PORT is required if (creds is not None) or (settings.REGISTRY_LOCATION != 'on-cluster'): if envs.get('PORT', None) is None: if not self.app.appsettings_set.latest().routable: return None raise DryccException( 'PORT needs to be set in the application config ' 'when using a private registry' ) # User provided PORT return int(envs.get('PORT')) # If the user provides PORT return int(envs.get('PORT', 5000)) except Exception as e: raise DryccException(str(e)) from e def get_registry_auth(self): """ Gather login information for private registry if needed """ auth = None registry = self.config.registry if registry.get('username', None): auth = { 'username': registry.get('username', None), 'password': registry.get('password', None), 'email': self.owner.email } return auth def previous(self): """ Return the previous Release to this one. :return: the previous :class:`Release`, or None """ releases = self.app.release_set if self.pk: releases = releases.exclude(pk=self.pk) try: # Get the Release previous to this one prev_release = releases.filter(failed=False).latest() except Release.DoesNotExist: prev_release = None return prev_release def rollback(self, user, version=None): try: # if no version is provided then grab version from object version = (self.version - 1) if version is None else int(version) if version < 1: raise DryccException('version cannot be below 0') elif version == 1: raise DryccException('Cannot roll back to initial release.') prev = self.app.release_set.get(version=version) if prev.failed: raise DryccException('Cannot roll back to failed release.') app_settings = self.app.appsettings_set.latest() latest_version = self.app.release_set.latest().version new_release = self.new( user, build=prev.build, config=prev.config, summary="{} rolled back to v{}".format(user, version), canary=len(app_settings.canaries) > 0, ) if self.build is not None: self.app.deploy(new_release, force_deploy=True) return new_release except Exception as e: # check if the exception is during create or publish if ('new_release' not in locals() and 'latest_version' in locals() and self.app.release_set.latest().version == latest_version+1): new_release = self.app.release_set.latest() if 'new_release' in locals(): new_release.failed = True new_release.summary = "{} performed roll back to a release that failed".format(self.owner) # noqa # Get the exception that has occured new_release.exception = "error: {}".format(str(e)) new_release.save() raise DryccException(str(e)) from e def cleanup_old(self): # noqa """ Cleanup any old resources from Kubernetes This includes any RSs that are no longer considered the latest release (just a safety net) Secrets no longer tied to any ReplicaSet Stray pods no longer relevant to the latest release """ latest_version = 'v{}'.format(self.version) self.app.log( 'Cleaning up RSs for releases older than {} (latest)'.format(latest_version), level=logging.DEBUG ) # Cleanup controllers labels = {'heritage': 'drycc'} replica_sets_removal = [] replica_sets = self._scheduler.rs.get(self.app.id, labels=labels).json()['items'] if not replica_sets: replica_sets = [] for replica_set in replica_sets: current_version = replica_set['metadata']['labels']['version'] # skip the latest release if current_version == latest_version: continue # aggregate versions together to removal all at once if current_version not in replica_sets_removal: replica_sets_removal.append(current_version) if replica_sets_removal: self.app.log( 'Found the following versions to cleanup: {}'.format(', '.join(replica_sets_removal)), # noqa level=logging.DEBUG ) # this is RC related for version in replica_sets_removal: self._delete_release_in_scheduler(self.app.id, version) # handle Deployments specific cleanups self._cleanup_deployment_secrets_and_configs(self.app.id) # Remove stray pods labels = {'heritage': 'drycc'} pods = self._scheduler.pod.get(self.app.id, labels=labels).json()['items'] if not pods: pods = [] for pod in pods: if self._scheduler.pod.deleted(pod): continue current_version = pod['metadata']['labels']['version'] # skip the latest release if current_version == latest_version: continue try: self._scheduler.pod.delete(self.app.id, pod['metadata']['name']) except KubeHTTPException as e: # Sometimes k8s will manage to remove the pod from under us if e.response.status_code == 404: continue def _cleanup_deployment_secrets_and_configs(self, namespace): """ Clean up any environment secrets (and in the future ConfigMaps) that are tied to a release Deployments no longer track This is done by checking the available ReplicaSets and only removing objects not attached to anything. This will allow releases done outside of Drycc Controller """ # Find all ReplicaSets versions = [] labels = {'heritage': 'drycc', 'app': namespace} replicasets = self._scheduler.rs.get(namespace, labels=labels).json()['items'] if not replicasets: replicasets = [] for replicaset in replicasets: if ( 'version' not in replicaset['metadata']['labels'] or replicaset['metadata']['labels']['version'] in versions ): continue versions.append(replicaset['metadata']['labels']['version']) # find all env secrets not owned by any replicaset labels = { 'heritage': 'drycc', 'app': namespace, 'type': 'env', # http://kubernetes.io/docs/user-guide/labels/#set-based-requirement 'version__notin': versions } self.app.log('Cleaning up orphaned env var secrets for application {}'.format(namespace), level=logging.DEBUG) # noqa secrets = self._scheduler.secret.get(namespace, labels=labels).json()['items'] if not secrets: secrets = [] for secret in secrets: self._scheduler.secret.delete(namespace, secret['metadata']['name']) def _delete_release_in_scheduler(self, namespace, version): """ Deletes a specific release in k8s based on ReplicationController Scale RSs to 0 then delete RSs and the version specific secret that container the env var """ labels = { 'heritage': 'drycc', 'app': namespace, 'version': version } # see if the app config has deploy timeout preference, otherwise use global timeout = self.config.values.get('DRYCC_DEPLOY_TIMEOUT', settings.DRYCC_DEPLOY_TIMEOUT) replica_sets = self._scheduler.rs.get(namespace, labels=labels).json()['items'] if not replica_sets: replica_sets = [] for replica_set in replica_sets: # Deployment takes care of this in the API, RS does not # Have the RS scale down pods and delete itself self._scheduler.rs.scale(namespace, replica_set['metadata']['name'], 0, timeout) self._scheduler.rs.delete(namespace, replica_set['metadata']['name']) def save(self, *args, **kwargs): # noqa if not self.summary: self.summary = '' prev_release = self.previous() # compare this build to the previous build old_build = prev_release.build if prev_release else None old_config = prev_release.config if prev_release else None # if the build changed, log it and who pushed it if self.version == 1: self.summary += "{} created initial release".format(self.app.owner) elif self.build != old_build: if self.build.sha: self.summary += "{} deployed {}".format(self.build.owner, self.build.sha[:7]) else: self.summary += "{} deployed {}".format(self.build.owner, self.build.image) # if the config data changed, log the dict diff if self.config != old_config: # if env vars change, log the dict diff dict1 = self.config.values dict2 = old_config.values if old_config else {} diff = dict_diff(dict1, dict2) # try to be as succinct as possible added = ', '.join(k for k in diff.get('added', {})) added = 'added ' + added if added else '' changed = ', '.join(k for k in diff.get('changed', {})) changed = 'changed ' + changed if changed else '' deleted = ', '.join(k for k in diff.get('deleted', {})) deleted = 'deleted ' + 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 the limits changed (memory or cpu), log the dict diff changes = [] old_mem = old_config.memory if old_config else {} diff = dict_diff(self.config.memory, old_mem) if diff.get('added') or diff.get('changed') or diff.get('deleted'): changes.append('memory') old_cpu = old_config.cpu if old_config else {} diff = dict_diff(self.config.cpu, old_cpu) if diff.get('added') or diff.get('changed') or diff.get('deleted'): changes.append('cpu') if changes: changes = 'changed limits for '+', '.join(changes) self.summary += "{} {}".format(self.config.owner, changes) # if the lifecycle_post_start hooks changed, log the dict diff changes = [] old_lifecycle_post_start = old_config.lifecycle_post_start if old_config else {} diff = dict_diff(self.config.lifecycle_post_start, old_lifecycle_post_start) # try to be as succinct as possible added = ', '.join(k for k in diff.get('added', {})) added = 'added lifecycle_post_start ' + added if added else '' changed = ', '.join(k for k in diff.get('changed', {})) changed = 'changed lifecycle_post_start ' + changed if changed else '' deleted = ', '.join(k for k in diff.get('deleted', {})) deleted = 'deleted lifecycle_post_start ' + 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 the lifecycle_pre_stop hooks changed, log the dict diff changes = [] old_lifecycle_pre_stop = old_config.lifecycle_pre_stop if old_config else {} diff = dict_diff(self.config.lifecycle_pre_stop, old_lifecycle_pre_stop) # try to be as succinct as possible added = ', '.join(k for k in diff.get('added', {})) added = 'added lifecycle_pre_stop ' + added if added else '' changed = ', '.join(k for k in diff.get('changed', {})) changed = 'changed lifecycle_pre_stop ' + changed if changed else '' deleted = ', '.join(k for k in diff.get('deleted', {})) deleted = 'deleted lifecycle_pre_stop ' + deleted if deleted else '' changes = ', '.join(i for i in (added, changed, deleted) if i) if changes: if self.summary: self.summary += ' and ' # if the timeouts changed, log the dict diff changes = [] old_timeout = old_config.termination_grace_period if old_config else {} diff = dict_diff(self.config.termination_grace_period, old_timeout) if diff.get('added') or diff.get('changed') or diff.get('deleted'): changes.append('termination_grace_period') if changes: changes = 'changed timeouts 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 the registry information changed, log the dict diff changes = [] old_registry = old_config.registry if old_config else {} diff = dict_diff(self.config.registry, old_registry) # try to be as succinct as possible added = ', '.join(k for k in diff.get('added', {})) added = 'added registry info ' + added if added else '' changed = ', '.join(k for k in diff.get('changed', {})) changed = 'changed registry info ' + changed if changed else '' deleted = ', '.join(k for k in diff.get('deleted', {})) deleted = 'deleted registry info ' + 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 the healthcheck information changed, log the dict diff changes = [] old_healthcheck = old_config.healthcheck if old_config else {} diff = dict_diff(self.config.healthcheck, old_healthcheck) # try to be as succinct as possible added = ', '.join(list(map(lambda x: 'default' if x == '' else x, [k for k in diff.get('added', {})]))) # noqa added = 'added healthcheck info for proc type ' + added if added else '' changed = ', '.join(list(map(lambda x: 'default' if x == '' else x, [k for k in diff.get('changed', {})]))) # noqa changed = 'changed healthcheck info for proc type ' + changed if changed else '' deleted = ', '.join(list(map(lambda x: 'default' if x == '' else x, [k for k in diff.get('deleted', {})]))) # noqa deleted = 'deleted healthcheck info for proc type ' + 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) else: # There were no changes to this release raise AlreadyExists("{} changed nothing - release stopped".format(self.owner)) super(Release, self).save(*args, **kwargs)