instance.py 37.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright 2014 Budapest University of Technology and Economics (BME IK)
#
# This file is part of CIRCLE Cloud.
#
# CIRCLE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# CIRCLE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with CIRCLE.  If not, see <http://www.gnu.org/licenses/>.

18
from __future__ import absolute_import, unicode_literals
19
from datetime import timedelta
20
from functools import partial
Őry Máté committed
21
from importlib import import_module
Dudás Ádám committed
22
from logging import getLogger
Dudás Ádám committed
23
from string import ascii_lowercase
24
from warnings import warn
25

26 27
from celery.exceptions import TimeoutError
from celery.contrib.abortable import AbortableAsyncResult
28
import django.conf
Őry Máté committed
29 30
from django.contrib.auth.models import User
from django.core import signing
Dudás Ádám committed
31
from django.core.exceptions import PermissionDenied
32 33 34
from django.db.models import (BooleanField, CharField, DateTimeField,
                              IntegerField, ForeignKey, Manager,
                              ManyToManyField, permalink, SET_NULL, TextField)
35
from django.dispatch import Signal
36
from django.utils import timezone
37
from django.utils.translation import ugettext_lazy as _, ugettext_noop
Dudás Ádám committed
38

39 40
from model_utils import Choices
from model_utils.models import TimeStampedModel, StatusModel
41
from taggit.managers import TaggableManager
42

Dudás Ádám committed
43
from acl.models import AclBase
44
from common.models import create_readable
45
from common.operations import OperatedMixin
Dudás Ádám committed
46
from ..tasks import vm_tasks, agent_tasks
47 48
from .activity import (ActivityInProgressError, instance_activity,
                       InstanceActivity)
49
from .common import BaseResourceConfigModel, Lease
50 51
from .network import Interface
from .node import Node, Trait
52

53
logger = getLogger(__name__)
Őry Máté committed
54 55
pre_state_changed = Signal(providing_args=["new_state"])
post_state_changed = Signal(providing_args=["new_state"])
Bach Dániel committed
56 57 58
pwgen = partial(User.objects.make_random_password,
                allowed_chars='abcdefghijklmnopqrstuvwx'
                              'ABCDEFGHIJKLMNOPQRSTUVWX0123456789')
59
scheduler = import_module(name=django.conf.settings.VM_SCHEDULER)
Őry Máté committed
60

61
ACCESS_PROTOCOLS = django.conf.settings.VM_ACCESS_PROTOCOLS
Őry Máté committed
62 63
ACCESS_METHODS = [(key, name) for key, (name, port, transport)
                  in ACCESS_PROTOCOLS.iteritems()]
Bach Dániel committed
64
VNC_PORT_RANGE = (20000, 65536)  # inclusive start, exclusive end
65 66


67 68 69 70 71 72 73 74 75 76 77 78 79 80
def find_unused_port(port_range, used_ports=[]):
    """Find an unused port in the specified range.

    The list of used ports can be specified optionally.

    :param port_range: a tuple representing a port range (w/ exclusive end)
                       e.g. (6000, 7000) represents ports 6000 through 6999
    """
    ports = xrange(*port_range)
    used = set(used_ports)
    unused = (port for port in ports if port not in used)
    return next(unused, None)  # first or None


81
def find_unused_vnc_port():
82 83 84 85 86
    port = find_unused_port(
        port_range=VNC_PORT_RANGE,
        used_ports=Instance.objects.values_list('vnc_port', flat=True))

    if port is None:
87
        raise Exception("No unused port could be found for VNC.")
88 89
    else:
        return port
90 91


92
class InstanceActiveManager(Manager):
Dudás Ádám committed
93

94 95
    def get_query_set(self):
        return super(InstanceActiveManager,
96
                     self).get_query_set().filter(destroyed_at=None)
97 98


99
class VirtualMachineDescModel(BaseResourceConfigModel):
100

101 102 103 104 105 106 107 108
    """Abstract base for virtual machine describing models.
    """
    access_method = CharField(max_length=10, choices=ACCESS_METHODS,
                              verbose_name=_('access method'),
                              help_text=_('Primary remote access method.'))
    boot_menu = BooleanField(verbose_name=_('boot menu'), default=False,
                             help_text=_(
                                 'Show boot device selection menu on boot.'))
Kálmán Viktor committed
109 110
    lease = ForeignKey(Lease, help_text=_("Preferred expiration periods."),
                       verbose_name=_("Lease"))
111 112
    raw_data = TextField(verbose_name=_('raw_data'), blank=True, help_text=_(
        'Additional libvirt domain parameters in XML format.'))
Dudás Ádám committed
113 114 115 116 117
    req_traits = ManyToManyField(Trait, blank=True,
                                 help_text=_("A set of traits required for a "
                                             "node to declare to be suitable "
                                             "for hosting the VM."),
                                 verbose_name=_("required traits"))
118 119 120 121
    system = TextField(verbose_name=_('operating system'),
                       help_text=(_('Name of operating system in '
                                    'format like "%s".') %
                                  'Ubuntu 12.04 LTS Desktop amd64'))
Dudás Ádám committed
122
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
123 124 125 126 127

    class Meta:
        abstract = True


128
class InstanceTemplate(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
129

130 131
    """Virtual machine template.
    """
132 133 134 135 136
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
137
    name = CharField(max_length=100, verbose_name=_('name'),
Őry Máté committed
138 139 140 141
                     help_text=_('Human readable name of template.'))
    description = TextField(verbose_name=_('description'), blank=True)
    parent = ForeignKey('self', null=True, blank=True,
                        verbose_name=_('parent template'),
142
                        on_delete=SET_NULL,
Őry Máté committed
143
                        help_text=_('Template which this one is derived of.'))
Bach Dániel committed
144
    disks = ManyToManyField('storage.Disk', verbose_name=_('disks'),
Őry Máté committed
145 146
                            related_name='template_set',
                            help_text=_('Disks which are to be mounted.'))
147
    owner = ForeignKey(User)
148 149

    class Meta:
Őry Máté committed
150 151
        app_label = 'vm'
        db_table = 'vm_instancetemplate'
152
        ordering = ('name', )
Őry Máté committed
153 154
        permissions = (
            ('create_template', _('Can create an instance template.')),
155 156
            ('create_base_template',
             _('Can create an instance template (base).')),
157 158
            ('change_template_resources',
             _('Can change resources of a template.')),
Őry Máté committed
159
        )
160 161 162 163 164 165
        verbose_name = _('template')
        verbose_name_plural = _('templates')

    def __unicode__(self):
        return self.name

166
    @property
167
    def running_instances(self):
168
        """The number of running instances of the template.
169
        """
170
        return sum(1 for i in self.instance_set.all() if i.is_running)
171 172 173

    @property
    def os_type(self):
174
        """The type of the template's operating system.
175 176
        """
        if self.access_method == 'rdp':
177
            return 'windows'
178
        else:
179
            return 'linux'
180

181 182 183 184
    @property
    def is_ready(self):
        return all(disk.is_ready for disk in self.disks)

185 186 187 188 189 190
    def save(self, *args, **kwargs):
        is_new = getattr(self, "pk", None) is None
        super(InstanceTemplate, self).save(*args, **kwargs)
        if is_new:
            self.set_level(self.owner, 'owner')

191 192 193 194
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.template-detail', None, {'pk': self.pk})

195 196 197
    def remove_disk(self, disk, **kwargs):
        self.disks.remove(disk)

198 199 200 201 202 203
    def destroy_disks(self):
        """Destroy all associated disks.
        """
        for disk in self.disks.all():
            disk.destroy()

204

205
class Instance(AclBase, VirtualMachineDescModel, StatusModel, OperatedMixin,
206
               TimeStampedModel):
tarokkk committed
207

208 209
    """Virtual machine instance.
    """
210 211 212 213 214
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),  # console, networking, change state
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
215 216 217 218 219 220 221 222 223
    STATUS = Choices(
        ('NOSTATE', _('no state')),
        ('RUNNING', _('running')),
        ('STOPPED', _('stopped')),
        ('SUSPENDED', _('suspended')),
        ('ERROR', _('error')),
        ('PENDING', _('pending')),
        ('DESTROYED', _('destroyed')),
    )
Őry Máté committed
224
    name = CharField(blank=True, max_length=100, verbose_name=_('name'),
225
                     help_text=_("Human readable name of instance."))
Őry Máté committed
226 227
    description = TextField(blank=True, verbose_name=_('description'))
    template = ForeignKey(InstanceTemplate, blank=True, null=True,
228
                          related_name='instance_set', on_delete=SET_NULL,
229
                          help_text=_("Template the instance derives from."),
Őry Máté committed
230
                          verbose_name=_('template'))
231
    pw = CharField(help_text=_("Original password of the instance."),
Őry Máté committed
232 233 234
                   max_length=20, verbose_name=_('password'))
    time_of_suspend = DateTimeField(blank=True, default=None, null=True,
                                    verbose_name=_('time of suspend'),
235 236
                                    help_text=_("Proposed time of automatic "
                                                "suspension."))
Őry Máté committed
237 238
    time_of_delete = DateTimeField(blank=True, default=None, null=True,
                                   verbose_name=_('time of delete'),
239 240
                                   help_text=_("Proposed time of automatic "
                                               "deletion."))
Őry Máté committed
241
    active_since = DateTimeField(blank=True, null=True,
242 243
                                 help_text=_("Time stamp of successful "
                                             "boot report."),
Őry Máté committed
244 245 246
                                 verbose_name=_('active since'))
    node = ForeignKey(Node, blank=True, null=True,
                      related_name='instance_set',
247
                      help_text=_("Current hypervisor of this instance."),
Őry Máté committed
248
                      verbose_name=_('host node'))
Bach Dániel committed
249
    disks = ManyToManyField('storage.Disk', related_name='instance_set',
250
                            help_text=_("Set of mounted disks."),
Őry Máté committed
251
                            verbose_name=_('disks'))
252 253 254
    vnc_port = IntegerField(blank=True, default=None, null=True,
                            help_text=_("TCP port where VNC console listens."),
                            unique=True, verbose_name=_('vnc_port'))
255
    is_base = BooleanField(default=False)
Őry Máté committed
256
    owner = ForeignKey(User)
257 258 259
    destroyed_at = DateTimeField(blank=True, null=True,
                                 help_text=_("The virtual machine's time of "
                                             "destruction."))
260 261
    objects = Manager()
    active = InstanceActiveManager()
262 263

    class Meta:
Őry Máté committed
264 265
        app_label = 'vm'
        db_table = 'vm_instance'
266
        ordering = ('pk', )
267 268 269 270
        permissions = (
            ('access_console', _('Can access the graphical console of a VM.')),
            ('change_resources', _('Can change resources of a running VM.')),
            ('set_resources', _('Can change resources of a new VM.')),
271
            ('create_vm', _('Can create a new VM.')),
272
            ('config_ports', _('Can configure port forwards.')),
Bach Dániel committed
273
            ('recover', _('Can recover a destroyed VM.')),
274
            ('emergency_change_state', _('Can change VM state to NOSTATE.')),
275
        )
276 277 278
        verbose_name = _('instance')
        verbose_name_plural = _('instances')

279 280 281 282 283 284 285 286 287 288 289
    class InstanceDestroyedError(Exception):

        def __init__(self, instance, message=None):
            if message is None:
                message = ("The instance (%s) has already been destroyed."
                           % instance)

            Exception.__init__(self, message)

            self.instance = instance

290 291 292 293 294 295
    class WrongStateError(Exception):

        def __init__(self, instance, message=None):
            if message is None:
                message = ("The instance's current state (%s) is "
                           "inappropriate for the invoked operation."
296
                           % instance.status)
297 298 299 300 301

            Exception.__init__(self, message)

            self.instance = instance

302
    def __unicode__(self):
303
        parts = (self.name, "(" + str(self.id) + ")")
304
        return " ".join(s for s in parts if s != "")
305

306
    @property
307 308 309 310
    def is_console_available(self):
        return self.is_running

    @property
311
    def is_running(self):
Guba Sándor committed
312 313
        """Check if VM is in running state.
        """
314
        return self.status == 'RUNNING'
315 316

    @property
317
    def state(self):
318 319 320 321 322 323 324 325 326 327 328 329
        warn('Use Instance.status (or get_status_display) instead.',
             DeprecationWarning)
        return self.status

    def _update_status(self):
        """Set the proper status of the instance to Instance.status.
        """
        old = self.status
        self.status = self._compute_status()
        if old != self.status:
            logger.info('Status of Instance#%d changed to %s',
                        self.pk, self.status)
330
            self.save(update_fields=('status', ))
331 332 333

    def _compute_status(self):
        """Return the proper status of the instance based on activities.
334
        """
335
        # check special cases
336 337 338 339
        if self.activity_log.filter(activity_code__endswith='migrate',
                                    finished__isnull=True).exists():
            return 'MIGRATING'

340 341 342 343 344 345
        # <<< add checks for special cases before this

        # default case
        acts = self.activity_log.filter(finished__isnull=False,
                                        resultant_state__isnull=False
                                        ).order_by('-finished')[:1]
346
        try:
347
            act = acts[0]
348
        except IndexError:
349 350 351
            return 'NOSTATE'
        else:
            return act.resultant_state
352

Dudás Ádám committed
353 354
    @classmethod
    def create(cls, params, disks, networks, req_traits, tags):
Guba Sándor committed
355 356
        """ Create new Instance object.
        """
Dudás Ádám committed
357 358
        # create instance and do additional setup
        inst = cls(**params)
359

Dudás Ádám committed
360 361 362 363
        # save instance
        inst.full_clean()
        inst.save()
        inst.set_level(inst.owner, 'owner')
364

Dudás Ádám committed
365 366
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
367

Dudás Ádám committed
368
        with instance_activity(code_suffix='create', instance=inst,
369
                               readable_name=ugettext_noop("create instance"),
Dudás Ádám committed
370 371 372 373 374 375 376 377 378 379 380 381 382
                               on_commit=__on_commit, user=inst.owner) as act:
            # create related entities
            inst.disks.add(*[disk.get_exclusive() for disk in disks])

            for net in networks:
                Interface.create(instance=inst, vlan=net.vlan,
                                 owner=inst.owner, managed=net.managed,
                                 base_activity=act)

            inst.req_traits.add(*req_traits)
            inst.tags.add(*tags)

            return inst
383

384
    @classmethod
385
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
386
                             req_traits=None, tags=None, **kwargs):
387 388 389 390 391
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
392 393 394 395 396 397 398 399 400 401 402 403 404 405
        insts = cls.mass_create_from_template(template, owner, disks=disks,
                                              networks=networks, tags=tags,
                                              req_traits=req_traits, **kwargs)
        return insts[0]

    @classmethod
    def mass_create_from_template(cls, template, owner, amount=1, disks=None,
                                  networks=None, req_traits=None, tags=None,
                                  **kwargs):
        """Mass-create new instances based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
406
        disks = template.disks.all() if disks is None else disks
407

408 409 410
        networks = (template.interface_set.all() if networks is None
                    else networks)

411 412 413 414
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
415 416 417
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

Dudás Ádám committed
418 419
        tags = template.tags.all() if tags is None else tags

420
        # prepare parameters
Dudás Ádám committed
421 422
        common_fields = ['name', 'description', 'num_cores', 'ram_size',
                         'max_ram_size', 'arch', 'priority', 'boot_menu',
423
                         'raw_data', 'lease', 'access_method', 'system']
Dudás Ádám committed
424 425 426
        params = dict(template=template, owner=owner, pw=pwgen())
        params.update([(f, getattr(template, f)) for f in common_fields])
        params.update(kwargs)  # override defaults w/ user supplied values
427 428

        if amount > 1 and '%d' not in params['name']:
429
            params['name'] += ' %d'
Dudás Ádám committed
430

431 432 433 434 435
        customized_params = (dict(params,
                                  name=params['name'].replace('%d', str(i)))
                             for i in xrange(amount))
        return [cls.create(cps, disks, networks, req_traits, tags)
                for cps in customized_params]
436

Dudás Ádám committed
437
    def clean(self, *args, **kwargs):
438
        self.time_of_suspend, self.time_of_delete = self.get_renew_times()
Dudás Ádám committed
439
        super(Instance, self).clean(*args, **kwargs)
440

Dudás Ádám committed
441 442 443 444
    def vm_state_changed(self, new_state):
        # log state change
        try:
            act = InstanceActivity.create(code_suffix='vm_state_changed',
445 446
                                          instance=self,
                                          readable_name="vm state changed")
Dudás Ádám committed
447 448 449
        except ActivityInProgressError:
            pass  # discard state change if another activity is in progress.
        else:
450 451 452 453
            if new_state == 'STOPPED':
                self.vnc_port = None
                self.node = None
                self.save()
Dudás Ádám committed
454 455 456 457
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
458

Őry Máté committed
459
    @permalink
460
    def get_absolute_url(self):
461
        return ('dashboard.views.detail', None, {'pk': self.id})
462 463

    @property
464 465 466 467 468 469 470 471 472
    def vm_name(self):
        """Name of the VM instance.

        This is a unique identifier as opposed to the 'name' attribute, which
        is just for display.
        """
        return 'cloud-' + str(self.id)

    @property
473
    def mem_dump(self):
474
        """Return the path and datastore for the memory dump.
475 476 477

        It is always on the first hard drive storage named cloud-<id>.dump
        """
478 479 480 481 482 483 484
        try:
            datastore = self.disks.all()[0].datastore
        except:
            return None
        else:
            path = datastore.path + '/' + self.vm_name + '.dump'
            return {'datastore': datastore, 'path': path}
485 486

    @property
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
    def primary_host(self):
        interfaces = self.interface_set.select_related('host')
        hosts = [i.host for i in interfaces if i.host]
        if not hosts:
            return None
        hs = [h for h in hosts if h.ipv6]
        if hs:
            return hs[0]
        hs = [h for h in hosts if not h.shared_ip]
        if hs:
            return hs[0]
        return hosts[0]

    @property
    def ipv4(self):
502 503
        """Primary IPv4 address of the instance.
        """
504 505 506 507
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
508 509
        """Primary IPv6 address of the instance.
        """
510 511 512 513
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
514 515
        """Primary MAC address of the instance.
        """
516 517 518 519 520 521 522 523 524 525 526
        return self.primary_host.mac if self.primary_host else None

    @property
    def uptime(self):
        """Uptime of the instance.
        """
        if self.active_since:
            return timezone.now() - self.active_since
        else:
            return timedelta()  # zero

527 528 529 530 531 532 533 534 535
    @property
    def os_type(self):
        """Get the type of the instance's operating system.
        """
        if self.template is None:
            return "unknown"
        else:
            return self.template.os_type

536 537 538 539 540 541 542 543 544 545 546
    def get_age(self):
        """Deprecated. Use uptime instead.

        Get age of VM in seconds.
        """
        return self.uptime.seconds

    @property
    def waiting(self):
        """Indicates whether the instance's waiting for an operation to finish.
        """
547
        return self.activity_log.filter(finished__isnull=True).exists()
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562

    def get_connect_port(self, use_ipv6=False):
        """Get public port number for default access method.
        """
        port, proto = ACCESS_PROTOCOLS[self.access_method][1:3]
        if self.primary_host:
            endpoints = self.primary_host.get_public_endpoints(port, proto)
            endpoint = endpoints['ipv6'] if use_ipv6 else endpoints['ipv4']
            return endpoint[1] if endpoint else None
        else:
            return None

    def get_connect_host(self, use_ipv6=False):
        """Get public hostname.
        """
563 564
        if not self.primary_host:
            return None
565
        proto = 'ipv6' if use_ipv6 else 'ipv4'
566
        return self.primary_host.get_hostname(proto=proto)
567

568
    def get_connect_command(self, use_ipv6=False):
Guba Sándor committed
569 570
        """Returns a formatted connect string.
        """
571 572 573 574 575 576 577 578 579
        try:
            port = self.get_connect_port(use_ipv6=use_ipv6)
            host = self.get_connect_host(use_ipv6=use_ipv6)
            proto = self.access_method
            if proto == 'rdp':
                return 'rdesktop %(host)s:%(port)d -u cloud -p %(pw)s' % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
            elif proto == 'ssh':
580
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=no '
581 582 583 584 585 586
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

587 588 589 590 591 592 593 594 595
    def get_connect_uri(self, use_ipv6=False):
        """Get access parameters in URI format.
        """
        try:
            port = self.get_connect_port(use_ipv6=use_ipv6)
            host = self.get_connect_host(use_ipv6=use_ipv6)
            proto = self.access_method
            if proto == 'ssh':
                proto = 'sshterm'
596 597 598
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
599 600 601
        except:
            return

tarokkk committed
602
    def get_vm_desc(self):
Guba Sándor committed
603 604
        """Serialize Instance object to vmdriver.
        """
tarokkk committed
605
        return {
606
            'name': self.vm_name,
607
            'vcpu': self.num_cores,
608
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
609
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
610 611 612 613 614
            'cpu_share': self.priority,
            'arch': self.arch,
            'boot_menu': self.boot_menu,
            'network_list': [n.get_vmnetwork_desc()
                             for n in self.interface_set.all()],
615 616 617 618 619
            'disk_list': [d.get_vmdisk_desc() for d in self.disks.all()],
            'graphics': {
                'type': 'vnc',
                'listen': '0.0.0.0',
                'passwd': '',
Guba Sándor committed
620
                'port': self.vnc_port
621
            },
622
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
623
            'raw_data': "" if not self.raw_data else self.raw_data
624
        }
tarokkk committed
625

626
    def get_remote_queue_name(self, queue_id, priority=None):
627 628 629
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
630
        if self.node:
631
            return self.node.get_remote_queue_name(queue_id, priority)
632 633
        else:
            raise Node.DoesNotExist()
634

635
    def _is_notified_about_expiration(self):
636 637 638
        last_activity = self.activity_log.latest('pk')
        return (last_activity.activity_code ==
                'vm.Instance.notification_about_expiration')
639 640 641 642 643 644

    def notify_owners_about_expiration(self, again=False):
        """Notify owners about vm expiring soon if they aren't already.

        :param again: Notify already notified owners.
        """
Bach Dániel committed
645 646 647 648 649 650 651

        notification_msg = ugettext_noop(
            'Your instance <a href="%(url)s">%(instance)s</a> is going to '
            'expire. It will be suspended at %(suspend)s and destroyed at '
            '%(delete)s. Please, either <a href="%(token)s">renew</a> '
            'or <a href="%(url)s">destroy</a> it now.')

652 653 654 655 656
        if not again and self._is_notified_about_expiration():
            return False
        success, failed = [], []

        def on_commit(act):
657 658 659 660 661 662 663 664 665 666 667 668 669 670
            if failed:
                act.result = create_readable(ugettext_noop(
                    "%(failed)s notifications failed and %(success) succeeded."
                    " Failed ones are: %(faileds)s."), ugettext_noop(
                    "%(failed)s notifications failed and %(success) succeeded."
                    " Failed ones are: %(faileds_ex)s."),
                    failed=len(failed), success=len(success),
                    faileds=", ".join(a for a, e in failed),
                    faileds_ex=", ".join("%s (%s)" % (a, unicode(e))
                                         for a, e in failed))
            else:
                act.result = create_readable(ugettext_noop(
                    "%(success)s notifications succeeded."),
                    success=len(success), successes=success)
671 672

        with instance_activity('notification_about_expiration', instance=self,
673 674
                               readable_name=ugettext_noop(
                                   "notify owner about expiration"),
675
                               on_commit=on_commit):
676
            from dashboard.views import VmRenewView, absolute_url
677 678 679 680 681
            level = self.get_level_object("owner")
            for u, ulevel in self.get_users_with_level(level__pk=level.pk):
                try:
                    token = VmRenewView.get_token_url(self, u)
                    u.profile.notify(
Bach Dániel committed
682 683 684 685
                        ugettext_noop('%(instance)s expiring soon'),
                        notification_msg, url=self.get_absolute_url(),
                        instance=self, suspend=self.time_of_suspend,
                        token=token, delete=self.time_of_delete)
686 687 688 689
                except Exception as e:
                    failed.append((u, e))
                else:
                    success.append(u)
690
            if self.status == "RUNNING":
691 692
                token = absolute_url(
                    VmRenewView.get_token_url(self, self.owner))
693 694 695
                queue = self.get_remote_queue_name("agent")
                agent_tasks.send_expiration.apply_async(
                    queue=queue, args=(self.vm_name, token))
696 697
        return True

698 699 700 701 702 703 704
    def is_expiring(self, threshold=0.1):
        """Returns if an instance will expire soon.

        Soon means that the time of suspend or delete comes in 10% of the
        interval what the Lease allows. This rate is configurable with the
        only parameter, threshold (0.1 = 10% by default).
        """
Bach Dániel committed
705 706
        return (self._is_suspend_expiring(threshold) or
                self._is_delete_expiring(threshold))
707 708 709

    def _is_suspend_expiring(self, threshold=0.1):
        interval = self.lease.suspend_interval
Bach Dániel committed
710 711 712
        if self.time_of_suspend is not None and interval is not None:
            limit = timezone.now() + timedelta(seconds=(
                threshold * self.lease.suspend_interval.total_seconds()))
713 714 715 716 717 718
            return limit > self.time_of_suspend
        else:
            return False

    def _is_delete_expiring(self, threshold=0.1):
        interval = self.lease.delete_interval
Bach Dániel committed
719 720 721
        if self.time_of_delete is not None and interval is not None:
            limit = timezone.now() + timedelta(seconds=(
                threshold * self.lease.delete_interval.total_seconds()))
722 723 724 725
            return limit > self.time_of_delete
        else:
            return False

726
    def get_renew_times(self, lease=None):
727 728
        """Returns new suspend and delete times if renew would be called.
        """
729 730
        if lease is None:
            lease = self.lease
731
        return (
732 733
            timezone.now() + lease.suspend_interval,
            timezone.now() + lease.delete_interval)
Dudás Ádám committed
734

735 736 737 738
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
739

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
    def attach_disk(self, disk, timeout=15):
        queue_name = self.get_remote_queue_name('vm', 'fast')
        return vm_tasks.attach_disk.apply_async(
            args=[self.vm_name,
                  disk.get_vmdisk_desc()],
            queue=queue_name
        ).get(timeout=timeout)

    def detach_disk(self, disk, timeout=15):
        try:
            queue_name = self.get_remote_queue_name('vm', 'fast')
            return vm_tasks.detach_disk.apply_async(
                args=[self.vm_name,
                      disk.get_vmdisk_desc()],
                queue=queue_name
            ).get(timeout=timeout)
        except Exception as e:
            if e.libvirtError and "not found" in str(e):
                logger.debug("Disk %s was not found."
                             % disk.name)
            else:
                raise

    def attach_network(self, network, timeout=15):
        queue_name = self.get_remote_queue_name('vm', 'fast')
        return vm_tasks.attach_network.apply_async(
            args=[self.vm_name,
                  network.get_vmnetwork_desc()],
            queue=queue_name
        ).get(timeout=timeout)

    def detach_network(self, network, timeout=15):
        try:
            queue_name = self.get_remote_queue_name('vm', 'fast')
            return vm_tasks.detach_network.apply_async(
                args=[self.vm_name,
                      network.get_vmnetwork_desc()],
                queue=queue_name
            ).get(timeout=timeout)
        except Exception as e:
            if e.libvirtError and "not found" in str(e):
                logger.debug("Interface %s was not found."
                             % (network.__unicode__()))
            else:
                raise

Dudás Ádám committed
786 787
    def deploy_disks(self):
        """Deploy all associated disks.
788
        """
Dudás Ádám committed
789 790 791 792 793 794 795 796 797 798
        devnums = list(ascii_lowercase)  # a-z
        for disk in self.disks.all():
            # assign device numbers
            if disk.dev_num in devnums:
                devnums.remove(disk.dev_num)
            else:
                disk.dev_num = devnums.pop(0)
                disk.save()
            # deploy disk
            disk.deploy()
799

Dudás Ádám committed
800 801
    def destroy_disks(self):
        """Destroy all associated disks.
802
        """
Dudás Ádám committed
803 804
        for disk in self.disks.all():
            disk.destroy()
805

Dudás Ádám committed
806 807
    def deploy_net(self):
        """Deploy all associated network interfaces.
808
        """
Dudás Ádám committed
809 810
        for net in self.interface_set.all():
            net.deploy()
811

Dudás Ádám committed
812 813
    def destroy_net(self):
        """Destroy all associated network interfaces.
814
        """
Dudás Ádám committed
815 816
        for net in self.interface_set.all():
            net.destroy()
817

Dudás Ádám committed
818 819
    def shutdown_net(self):
        """Shutdown all associated network interfaces.
820
        """
Dudás Ádám committed
821 822
        for net in self.interface_set.all():
            net.shutdown()
823

Dudás Ádám committed
824
    def delete_vm(self, timeout=15):
825
        queue_name = self.get_remote_queue_name('vm', 'fast')
826
        try:
Dudás Ádám committed
827 828 829 830 831 832 833
            return vm_tasks.destroy.apply_async(args=[self.vm_name],
                                                queue=queue_name
                                                ).get(timeout=timeout)
        except Exception as e:
            if e.libvirtError and "Domain not found" in str(e):
                logger.debug("Domain %s was not found at %s"
                             % (self.vm_name, queue_name))
834
            else:
Dudás Ádám committed
835
                raise
836

Dudás Ádám committed
837
    def deploy_vm(self, timeout=15):
838
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
839
        return vm_tasks.deploy.apply_async(args=[self.get_vm_desc()],
840 841
                                           queue=queue_name
                                           ).get(timeout=timeout)
Guba Sándor committed
842

Dudás Ádám committed
843
    def migrate_vm(self, to_node, timeout=120):
844
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
845
        return vm_tasks.migrate.apply_async(args=[self.vm_name,
846 847
                                                  to_node.host.hostname,
                                                  True],
Dudás Ádám committed
848 849
                                            queue=queue_name
                                            ).get(timeout=timeout)
850

Dudás Ádám committed
851
    def reboot_vm(self, timeout=5):
852
        queue_name = self.get_remote_queue_name('vm', 'fast')
Dudás Ádám committed
853 854 855
        return vm_tasks.reboot.apply_async(args=[self.vm_name],
                                           queue=queue_name
                                           ).get(timeout=timeout)
856

Dudás Ádám committed
857
    def reset_vm(self, timeout=5):
858
        queue_name = self.get_remote_queue_name('vm', 'fast')
Dudás Ádám committed
859 860 861
        return vm_tasks.reset.apply_async(args=[self.vm_name],
                                          queue=queue_name
                                          ).get(timeout=timeout)
862

Dudás Ádám committed
863
    def resume_vm(self, timeout=15):
864
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
865 866 867
        return vm_tasks.resume.apply_async(args=[self.vm_name],
                                           queue=queue_name
                                           ).get(timeout=timeout)
868

869
    def shutdown_vm(self, task=None, step=5):
870
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
871 872
        logger.debug("RPC Shutdown at queue: %s, for vm: %s.", queue_name,
                     self.vm_name)
873 874 875 876 877 878 879 880
        remote = vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
                                               queue=queue_name)

        while True:
            try:
                return remote.get(timeout=step)
            except TimeoutError:
                if task is not None and task.is_aborted():
881
                    AbortableAsyncResult(remote.id).abort()
882
                    raise Exception("Shutdown aborted by user.")
883

884
    def suspend_vm(self, timeout=230):
885
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
886 887
        return vm_tasks.sleep.apply_async(args=[self.vm_name,
                                                self.mem_dump['path']],
888 889
                                          queue=queue_name
                                          ).get(timeout=timeout)
Guba Sándor committed
890

Dudás Ádám committed
891
    def wake_up_vm(self, timeout=60):
892
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
        return vm_tasks.wake_up.apply_async(args=[self.vm_name,
                                                  self.mem_dump['path']],
                                            queue=queue_name
                                            ).get(timeout=timeout)

    def delete_mem_dump(self, timeout=15):
        queue_name = self.mem_dump['datastore'].get_remote_queue_name(
            'storage')
        from storage.tasks.remote_tasks import delete_dump
        delete_dump.apply_async(args=[self.mem_dump['path']],
                                queue=queue_name).get(timeout=timeout)

    def allocate_node(self):
        if self.node is None:
            self.node = self.select_node()
908 909
            self.save()

Dudás Ádám committed
910 911 912 913
    def yield_node(self):
        if self.node is not None:
            self.node = None
            self.save()
Guba Sándor committed
914

Dudás Ádám committed
915 916 917 918
    def allocate_vnc_port(self):
        if self.vnc_port is None:
            self.vnc_port = find_unused_vnc_port()
            self.save()
919

Dudás Ádám committed
920 921 922 923
    def yield_vnc_port(self):
        if self.vnc_port is not None:
            self.vnc_port = None
            self.save()
924 925 926

    def get_status_icon(self):
        return {
927 928 929 930 931 932 933 934
            'NOSTATE': 'fa-rocket',
            'RUNNING': 'fa-play',
            'STOPPED': 'fa-stop',
            'SUSPENDED': 'fa-pause',
            'ERROR': 'fa-warning',
            'PENDING': 'fa-rocket',
            'DESTROYED': 'fa-trash-o',
            'MIGRATING': 'fa-truck'}.get(self.status, 'fa-question')
935 936 937 938 939

    def get_activities(self, user=None):
        acts = (self.activity_log.filter(parent=None).
                order_by('-started').
                select_related('user').prefetch_related('children'))
940 941 942 943 944
        # Check latest activity for percentage
        for i in acts:
            if i.has_percentage():
                i.has_percent = True
                i.percentage = i.get_percentage()
945 946 947 948
        if user is not None:
            for i in acts:
                i.is_abortable_for_user = partial(i.is_abortable_for,
                                                  user=user)
949
        return acts
950

951
    def get_merged_activities(self, user=None):
952
        whitelist = ("create_disk", "download_disk")
953
        acts = self.get_activities(user)
954 955 956 957 958 959
        merged_acts = []
        latest = None

        for a in acts:
            if (latest == a.activity_code and
                    merged_acts[-1].result == a.result and
960
                    a.finished and merged_acts[-1].finished and
961
                    a.user == merged_acts[-1].user and
962 963
                    (merged_acts[-1].finished - a.finished).days < 7 and
                    not a.activity_code.endswith(whitelist)):
964 965 966 967 968 969 970 971
                merged_acts[-1].times += 1
            else:
                merged_acts.append(a)
                merged_acts[-1].times = 1
            latest = a.activity_code

        return merged_acts

972
    def get_screenshot(self, timeout=5):
Kálmán Viktor committed
973
        queue_name = self.get_remote_queue_name("vm", "fast")
974 975 976
        return vm_tasks.screenshot.apply_async(args=[self.vm_name],
                                               queue=queue_name
                                               ).get(timeout=timeout)