instance.py 38.9 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.db import IntegrityError
36
from django.dispatch import Signal
37
from django.utils import timezone
38
from django.utils.translation import ugettext_lazy as _, ugettext_noop
Dudás Ádám committed
39

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

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

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

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


70 71 72 73 74 75 76 77 78 79 80 81 82 83
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


84
def find_unused_vnc_port():
85 86 87 88 89
    port = find_unused_port(
        port_range=VNC_PORT_RANGE,
        used_ports=Instance.objects.values_list('vnc_port', flat=True))

    if port is None:
90
        raise Exception("No unused port could be found for VNC.")
91 92
    else:
        return port
93 94


95
class InstanceActiveManager(Manager):
Dudás Ádám committed
96

97 98
    def get_query_set(self):
        return super(InstanceActiveManager,
99
                     self).get_query_set().filter(destroyed_at=None)
100 101


102
class VirtualMachineDescModel(BaseResourceConfigModel):
103

104 105 106 107 108 109 110 111
    """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
112 113
    lease = ForeignKey(Lease, help_text=_("Preferred expiration periods."),
                       verbose_name=_("Lease"))
114 115
    raw_data = TextField(verbose_name=_('raw_data'), blank=True, help_text=_(
        'Additional libvirt domain parameters in XML format.'))
Dudás Ádám committed
116 117 118 119 120
    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"))
121 122 123 124
    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
125
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
126 127 128 129
    has_agent = BooleanField(verbose_name=_('has agent'), default=True,
                             help_text=_(
                                 'If the machine has agent installed, and '
                                 'the manager should wait for its start.'))
130 131 132 133 134

    class Meta:
        abstract = True


135
class InstanceTemplate(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
136

137 138
    """Virtual machine template.
    """
139 140 141 142 143
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
144
    name = CharField(max_length=100, verbose_name=_('name'),
Őry Máté committed
145 146 147 148
                     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'),
149
                        on_delete=SET_NULL,
Őry Máté committed
150
                        help_text=_('Template which this one is derived of.'))
Bach Dániel committed
151
    disks = ManyToManyField('storage.Disk', verbose_name=_('disks'),
Őry Máté committed
152 153
                            related_name='template_set',
                            help_text=_('Disks which are to be mounted.'))
154
    owner = ForeignKey(User)
155 156

    class Meta:
Őry Máté committed
157 158
        app_label = 'vm'
        db_table = 'vm_instancetemplate'
159
        ordering = ('name', )
Őry Máté committed
160 161
        permissions = (
            ('create_template', _('Can create an instance template.')),
162 163
            ('create_base_template',
             _('Can create an instance template (base).')),
164 165
            ('change_template_resources',
             _('Can change resources of a template.')),
Őry Máté committed
166
        )
167 168 169 170 171 172
        verbose_name = _('template')
        verbose_name_plural = _('templates')

    def __unicode__(self):
        return self.name

173
    @property
174
    def running_instances(self):
175
        """The number of running instances of the template.
176
        """
177
        return sum(1 for i in self.instance_set.all() if i.is_running)
178 179 180

    @property
    def os_type(self):
181
        """The type of the template's operating system.
182 183
        """
        if self.access_method == 'rdp':
184
            return 'windows'
185
        else:
186
            return 'linux'
187

188 189 190 191
    @property
    def is_ready(self):
        return all(disk.is_ready for disk in self.disks)

192 193 194 195 196 197
    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')

198 199 200 201
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.template-detail', None, {'pk': self.pk})

202 203 204
    def remove_disk(self, disk, **kwargs):
        self.disks.remove(disk)

205 206 207 208 209 210
    def destroy_disks(self):
        """Destroy all associated disks.
        """
        for disk in self.disks.all():
            disk.destroy()

211 212 213
    def get_running_instances(self):
        return Instance.active.filter(template=self, status="RUNNING")

214

215
class Instance(AclBase, VirtualMachineDescModel, StatusModel, OperatedMixin,
216
               TimeStampedModel):
tarokkk committed
217

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

    class Meta:
Őry Máté committed
270 271
        app_label = 'vm'
        db_table = 'vm_instance'
272
        ordering = ('pk', )
273 274 275 276
        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.')),
277
            ('create_vm', _('Can create a new VM.')),
278
            ('config_ports', _('Can configure port forwards.')),
Bach Dániel committed
279
            ('recover', _('Can recover a destroyed VM.')),
280
            ('emergency_change_state', _('Can change VM state to NOSTATE.')),
281
        )
282 283 284
        verbose_name = _('instance')
        verbose_name_plural = _('instances')

285
    class InstanceError(HumanReadableException):
286

287 288 289 290 291
        def __init__(self, instance, params=None, level=None, **kwargs):
            kwargs.update(params or {})
            self.instance = kwargs["instance"] = instance
            super(Instance.InstanceError, self).__init__(
                level, self.message, self.message, kwargs)
292

293 294 295
    class InstanceDestroyedError(InstanceError):
        message = ugettext_noop(
            "Instance %(instance)s has already been destroyed.")
296

Őry Máté committed
297 298 299 300
    class NoAgentError(InstanceError):
        message = ugettext_noop(
            "No agent software is running on instance %(instance)s.")

301 302 303 304
    class WrongStateError(InstanceError):
        message = ugettext_noop(
            "Current state (%(state)s) of instance %(instance)s is "
            "inappropriate for the invoked operation.")
305

306 307 308
        def __init__(self, instance, params=None, **kwargs):
            super(Instance.WrongStateError, self).__init__(
                instance, params, state=instance.status)
309

310
    def __unicode__(self):
311
        parts = (self.name, "(" + str(self.id) + ")")
312
        return " ".join(s for s in parts if s != "")
313

314
    @property
315 316 317 318
    def is_console_available(self):
        return self.is_running

    @property
319
    def is_running(self):
Guba Sándor committed
320 321
        """Check if VM is in running state.
        """
322
        return self.status == 'RUNNING'
323 324

    @property
325
    def state(self):
326 327 328 329 330 331 332 333 334 335 336 337
        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)
338
            self.save(update_fields=('status', ))
339 340 341

    def _compute_status(self):
        """Return the proper status of the instance based on activities.
342
        """
343
        # check special cases
344 345 346 347
        if self.activity_log.filter(activity_code__endswith='migrate',
                                    finished__isnull=True).exists():
            return 'MIGRATING'

348 349 350 351 352 353
        # <<< 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]
354
        try:
355
            act = acts[0]
356
        except IndexError:
357 358 359
            return 'NOSTATE'
        else:
            return act.resultant_state
360

Dudás Ádám committed
361 362
    @classmethod
    def create(cls, params, disks, networks, req_traits, tags):
Guba Sándor committed
363 364
        """ Create new Instance object.
        """
Dudás Ádám committed
365 366
        # create instance and do additional setup
        inst = cls(**params)
367

Dudás Ádám committed
368 369 370 371
        # save instance
        inst.full_clean()
        inst.save()
        inst.set_level(inst.owner, 'owner')
372

Dudás Ádám committed
373 374
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
375

Dudás Ádám committed
376
        with instance_activity(code_suffix='create', instance=inst,
377
                               readable_name=ugettext_noop("create instance"),
Dudás Ádám committed
378 379 380 381 382 383 384 385 386 387 388 389 390
                               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
391

392
    @classmethod
393
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
394
                             req_traits=None, tags=None, **kwargs):
395 396 397 398 399
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
400 401 402 403 404 405 406 407 408 409 410 411 412 413
        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.
        """
414
        disks = template.disks.all() if disks is None else disks
415

416 417 418
        networks = (template.interface_set.all() if networks is None
                    else networks)

419 420 421 422
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
423 424 425
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

428
        # prepare parameters
Dudás Ádám committed
429 430
        common_fields = ['name', 'description', 'num_cores', 'ram_size',
                         'max_ram_size', 'arch', 'priority', 'boot_menu',
431 432
                         'raw_data', 'lease', 'access_method', 'system',
                         'has_agent']
Dudás Ádám committed
433 434 435
        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
436 437

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

440 441 442 443 444
        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]
445

Dudás Ádám committed
446
    def clean(self, *args, **kwargs):
447
        self.time_of_suspend, self.time_of_delete = self.get_renew_times()
Dudás Ádám committed
448
        super(Instance, self).clean(*args, **kwargs)
449

450 451 452
    def vm_state_changed(self, new_state, new_node=False):
        if new_node is False:  # None would be a valid value
            new_node = self.node
Dudás Ádám committed
453 454
        # log state change
        try:
455 456 457
            act = InstanceActivity.create(
                code_suffix='vm_state_changed',
                readable_name=create_readable(
458 459
                    ugettext_noop("vm state changed to %(state)s on %(node)s"),
                    state=new_state, node=new_node),
460
                instance=self)
Dudás Ádám committed
461 462 463
        except ActivityInProgressError:
            pass  # discard state change if another activity is in progress.
        else:
464 465 466
            if self.node != new_node:
                self.node = new_node
                self.save()
Dudás Ádám committed
467 468 469 470
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
471

Őry Máté committed
472
    @permalink
473
    def get_absolute_url(self):
474
        return ('dashboard.views.detail', None, {'pk': self.id})
475 476

    @property
477 478 479 480 481 482 483 484 485
    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
486
    def mem_dump(self):
487
        """Return the path and datastore for the memory dump.
488 489 490

        It is always on the first hard drive storage named cloud-<id>.dump
        """
491 492
        try:
            datastore = self.disks.all()[0].datastore
493 494 495 496 497 498
        except IndexError:
            from storage.models import DataStore
            datastore = DataStore.objects.get()

        path = datastore.path + '/' + self.vm_name + '.dump'
        return {'datastore': datastore, 'path': path}
499 500

    @property
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
    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):
516 517
        """Primary IPv4 address of the instance.
        """
518 519 520 521 522
        # return self.primary_host.ipv4 if self.primary_host else None
        for i in self.interface_set.all():
            if i.host:
                return i.host.ipv4
        return None
523 524 525

    @property
    def ipv6(self):
526 527
        """Primary IPv6 address of the instance.
        """
528 529 530 531
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
532 533
        """Primary MAC address of the instance.
        """
534 535 536
        return self.primary_host.mac if self.primary_host else None

    @property
537 538 539 540 541 542 543 544
    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

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

    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.
        """
565 566
        if not self.primary_host:
            return None
567
        proto = 'ipv6' if use_ipv6 else 'ipv4'
568
        return self.primary_host.get_hostname(proto=proto)
569

570
    def get_connect_command(self, use_ipv6=False):
Guba Sándor committed
571 572
        """Returns a formatted connect string.
        """
573 574 575 576 577 578 579 580 581
        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':
582
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=no '
583 584 585 586 587 588
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

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
596
            return ('circle:%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
597 598
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
599 600 601
        except:
            return

602 603 604 605 606 607 608
    @property
    def short_hostname(self):
        try:
            return self.primary_host.hostname
        except AttributeError:
            return self.vm_name

tarokkk committed
609
    def get_vm_desc(self):
Guba Sándor committed
610 611
        """Serialize Instance object to vmdriver.
        """
tarokkk committed
612
        return {
613
            'name': self.vm_name,
614
            'vcpu': self.num_cores,
615
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
616
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
617 618 619 620 621
            '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()],
622 623 624 625 626
            '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
627
                'port': self.vnc_port
628
            },
629
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
630
            'raw_data': "" if not self.raw_data else self.raw_data
631
        }
tarokkk committed
632

633
    def get_remote_queue_name(self, queue_id, priority=None):
634 635 636
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
637
        if self.node:
638
            return self.node.get_remote_queue_name(queue_id, priority)
639 640
        else:
            raise Node.DoesNotExist()
641

642
    def _is_notified_about_expiration(self):
643 644 645
        last_activity = self.activity_log.latest('pk')
        return (last_activity.activity_code ==
                'vm.Instance.notification_about_expiration')
646 647 648 649 650 651

    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
652 653 654 655 656 657 658

        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.')

659 660 661 662 663
        if not again and self._is_notified_about_expiration():
            return False
        success, failed = [], []

        def on_commit(act):
664 665 666 667 668 669 670 671 672 673 674 675 676 677
            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)
678 679

        with instance_activity('notification_about_expiration', instance=self,
680 681
                               readable_name=ugettext_noop(
                                   "notify owner about expiration"),
682
                               on_commit=on_commit):
683
            from dashboard.views import VmRenewView, absolute_url
684 685 686 687 688
            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
689 690 691 692
                        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)
693 694 695 696
                except Exception as e:
                    failed.append((u, e))
                else:
                    success.append(u)
697
            if self.status == "RUNNING":
698 699
                token = absolute_url(
                    VmRenewView.get_token_url(self, self.owner))
700 701 702
                queue = self.get_remote_queue_name("agent")
                agent_tasks.send_expiration.apply_async(
                    queue=queue, args=(self.vm_name, token))
703 704
        return True

705 706 707 708 709 710 711
    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
712 713
        return (self._is_suspend_expiring(threshold) or
                self._is_delete_expiring(threshold))
714 715 716

    def _is_suspend_expiring(self, threshold=0.1):
        interval = self.lease.suspend_interval
Bach Dániel committed
717 718 719
        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()))
720 721 722 723 724 725
            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
726 727 728
        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()))
729 730 731 732
            return limit > self.time_of_delete
        else:
            return False

733
    def get_renew_times(self, lease=None):
734 735
        """Returns new suspend and delete times if renew would be called.
        """
736 737
        if lease is None:
            lease = self.lease
738
        return (
739 740
            timezone.now() + lease.suspend_interval,
            timezone.now() + lease.delete_interval)
Dudás Ádám committed
741

742 743 744 745
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
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 786 787 788 789 790 791 792
    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

793
    def resize_disk_live(self, disk, size, timeout=15):
794 795 796 797 798 799
        queue_name = self.get_remote_queue_name('vm', 'slow')
        return vm_tasks.resize_disk.apply_async(
            args=[self.vm_name, disk.path, size],
            queue=queue_name).get(timeout=timeout)
        disk.size = size
        disk.save()
800

Dudás Ádám committed
801 802
    def deploy_disks(self):
        """Deploy all associated disks.
803
        """
Dudás Ádám committed
804 805 806 807 808 809 810 811 812 813
        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()
814

Dudás Ádám committed
815 816
    def destroy_disks(self):
        """Destroy all associated disks.
817
        """
Dudás Ádám committed
818 819
        for disk in self.disks.all():
            disk.destroy()
820

Dudás Ádám committed
821 822
    def deploy_net(self):
        """Deploy all associated network interfaces.
823
        """
Dudás Ádám committed
824 825
        for net in self.interface_set.all():
            net.deploy()
826

Dudás Ádám committed
827 828
    def destroy_net(self):
        """Destroy all associated network interfaces.
829
        """
Dudás Ádám committed
830 831
        for net in self.interface_set.all():
            net.destroy()
832

Dudás Ádám committed
833 834
    def shutdown_net(self):
        """Shutdown all associated network interfaces.
835
        """
Dudás Ádám committed
836 837
        for net in self.interface_set.all():
            net.shutdown()
838

Dudás Ádám committed
839
    def delete_vm(self, timeout=15):
840
        queue_name = self.get_remote_queue_name('vm', 'fast')
841
        try:
Dudás Ádám committed
842 843 844 845 846 847 848
            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))
849
            else:
Dudás Ádám committed
850
                raise
851

Dudás Ádám committed
852
    def deploy_vm(self, timeout=15):
853
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
854
        return vm_tasks.deploy.apply_async(args=[self.get_vm_desc()],
855 856
                                           queue=queue_name
                                           ).get(timeout=timeout)
Guba Sándor committed
857

Dudás Ádám committed
858
    def migrate_vm(self, to_node, timeout=120):
859
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
860
        return vm_tasks.migrate.apply_async(args=[self.vm_name,
861 862
                                                  to_node.host.hostname,
                                                  True],
Dudás Ádám committed
863 864
                                            queue=queue_name
                                            ).get(timeout=timeout)
865

Dudás Ádám committed
866
    def reboot_vm(self, timeout=5):
867
        queue_name = self.get_remote_queue_name('vm', 'fast')
Dudás Ádám committed
868 869 870
        return vm_tasks.reboot.apply_async(args=[self.vm_name],
                                           queue=queue_name
                                           ).get(timeout=timeout)
871

Dudás Ádám committed
872
    def reset_vm(self, timeout=5):
873
        queue_name = self.get_remote_queue_name('vm', 'fast')
Dudás Ádám committed
874 875 876
        return vm_tasks.reset.apply_async(args=[self.vm_name],
                                          queue=queue_name
                                          ).get(timeout=timeout)
877

Dudás Ádám committed
878
    def resume_vm(self, timeout=15):
879
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
880 881 882
        return vm_tasks.resume.apply_async(args=[self.vm_name],
                                           queue=queue_name
                                           ).get(timeout=timeout)
883

884
    def shutdown_vm(self, task=None, step=5):
885
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
886 887
        logger.debug("RPC Shutdown at queue: %s, for vm: %s.", queue_name,
                     self.vm_name)
888 889 890 891 892 893
        remote = vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
                                               queue=queue_name)

        while True:
            try:
                return remote.get(timeout=step)
894
            except TimeoutError as e:
895
                if task is not None and task.is_aborted():
896
                    AbortableAsyncResult(remote.id).abort()
897 898
                    raise humanize_exception(ugettext_noop(
                        "Operation aborted by user."), e)
899

900
    def suspend_vm(self, timeout=230):
901
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
902 903
        return vm_tasks.sleep.apply_async(args=[self.vm_name,
                                                self.mem_dump['path']],
904 905
                                          queue=queue_name
                                          ).get(timeout=timeout)
Guba Sándor committed
906

Dudás Ádám committed
907
    def wake_up_vm(self, timeout=60):
908
        queue_name = self.get_remote_queue_name('vm', 'slow')
Dudás Ádám committed
909 910 911 912 913 914 915
        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(
916 917
            'storage', 'fast')
        from storage.tasks.storage_tasks import delete_dump
Dudás Ádám committed
918 919 920 921 922 923
        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()
924 925
            self.save()

Dudás Ádám committed
926 927 928 929
    def yield_node(self):
        if self.node is not None:
            self.node = None
            self.save()
Guba Sándor committed
930

Dudás Ádám committed
931 932
    def allocate_vnc_port(self):
        if self.vnc_port is None:
933 934 935 936 937 938 939 940 941 942
            while True:
                try:
                    self.vnc_port = find_unused_vnc_port()
                    self.save()
                except IntegrityError:
                    # Another thread took this port get another one
                    logger.debug("Port %s is in use.", self.vnc_port)
                    pass
                else:
                    break
943

Dudás Ádám committed
944 945 946 947
    def yield_vnc_port(self):
        if self.vnc_port is not None:
            self.vnc_port = None
            self.save()
948 949 950

    def get_status_icon(self):
        return {
951 952 953 954 955 956 957
            'NOSTATE': 'fa-rocket',
            'RUNNING': 'fa-play',
            'STOPPED': 'fa-stop',
            'SUSPENDED': 'fa-pause',
            'ERROR': 'fa-warning',
            'PENDING': 'fa-rocket',
            'DESTROYED': 'fa-trash-o',
958 959
            'MIGRATING': 'fa-truck migrating-icon'
        }.get(self.status, 'fa-question')
960 961 962 963 964

    def get_activities(self, user=None):
        acts = (self.activity_log.filter(parent=None).
                order_by('-started').
                select_related('user').prefetch_related('children'))
965 966 967 968 969
        # Check latest activity for percentage
        for i in acts:
            if i.has_percentage():
                i.has_percent = True
                i.percentage = i.get_percentage()
970 971 972 973
        if user is not None:
            for i in acts:
                i.is_abortable_for_user = partial(i.is_abortable_for,
                                                  user=user)
974
        return acts
975

976
    def get_merged_activities(self, user=None):
977
        whitelist = ("create_disk", "download_disk")
978
        acts = self.get_activities(user)
979 980 981 982 983
        merged_acts = []
        latest = None

        for a in acts:
            if (latest == a.activity_code and
984
                    merged_acts[-1].result_data == a.result_data and
985
                    a.finished and merged_acts[-1].finished and
986
                    a.user == merged_acts[-1].user and
987 988
                    (merged_acts[-1].finished - a.finished).days < 7 and
                    not a.activity_code.endswith(whitelist)):
989 990 991 992 993 994 995 996
                merged_acts[-1].times += 1
            else:
                merged_acts.append(a)
                merged_acts[-1].times = 1
            latest = a.activity_code

        return merged_acts

997
    def get_screenshot(self, timeout=5):
Kálmán Viktor committed
998
        queue_name = self.get_remote_queue_name("vm", "fast")
999 1000 1001
        return vm_tasks.screenshot.apply_async(args=[self.vm_name],
                                               queue=queue_name
                                               ).get(timeout=timeout)
1002 1003 1004 1005

    def get_latest_activity_in_progress(self):
        try:
            return InstanceActivity.objects.filter(
1006
                instance=self, succeeded=None, parent=None).latest("started")
1007 1008
        except InstanceActivity.DoesNotExist:
            return None
1009 1010 1011 1012 1013

    def is_in_status_change(self):
        latest = self.get_latest_activity_in_progress()
        return (latest and latest.resultant_state is not None
                and self.status != latest.resultant_state)