instance.py 44.9 KB
Newer Older
1
from __future__ import absolute_import, unicode_literals
2
from datetime import timedelta
3
from logging import getLogger
Őry Máté committed
4
from importlib import import_module
5
from warnings import warn
6
import string
7

8
import django.conf
Őry Máté committed
9 10
from django.contrib.auth.models import User
from django.core import signing
Dudás Ádám committed
11
from django.core.exceptions import PermissionDenied
12 13 14
from django.db.models import (BooleanField, CharField, DateTimeField,
                              IntegerField, ForeignKey, Manager,
                              ManyToManyField, permalink, SET_NULL, TextField)
15
from django.dispatch import Signal
16 17
from django.utils import timezone
from django.utils.translation import ugettext_lazy as _
Dudás Ádám committed
18

19
from celery.exceptions import TimeLimitExceeded
20 21
from model_utils import Choices
from model_utils.models import TimeStampedModel, StatusModel
22
from taggit.managers import TaggableManager
23

Dudás Ádám committed
24
from acl.models import AclBase
25
from storage.models import Disk
26
from ..tasks import local_tasks, vm_tasks, agent_tasks
27 28
from .activity import (ActivityInProgressError, instance_activity,
                       InstanceActivity)
29
from .common import BaseResourceConfigModel, Lease
30 31
from .network import Interface
from .node import Node, Trait
32

33
logger = getLogger(__name__)
Őry Máté committed
34 35
pre_state_changed = Signal(providing_args=["new_state"])
post_state_changed = Signal(providing_args=["new_state"])
36
pwgen = User.objects.make_random_password
37
scheduler = import_module(name=django.conf.settings.VM_SCHEDULER)
Őry Máté committed
38

39
ACCESS_PROTOCOLS = django.conf.settings.VM_ACCESS_PROTOCOLS
Őry Máté committed
40 41
ACCESS_METHODS = [(key, name) for key, (name, port, transport)
                  in ACCESS_PROTOCOLS.iteritems()]
Bach Dániel committed
42
VNC_PORT_RANGE = (20000, 65536)  # inclusive start, exclusive end
43 44


45 46 47 48 49 50 51 52 53 54 55 56 57 58
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


59
def find_unused_vnc_port():
60 61 62 63 64
    port = find_unused_port(
        port_range=VNC_PORT_RANGE,
        used_ports=Instance.objects.values_list('vnc_port', flat=True))

    if port is None:
65
        raise Exception("No unused port could be found for VNC.")
66 67
    else:
        return port
68 69


70
class InstanceActiveManager(Manager):
Dudás Ádám committed
71

72 73
    def get_query_set(self):
        return super(InstanceActiveManager,
74
                     self).get_query_set().filter(destroyed_at=None)
75 76


77
class VirtualMachineDescModel(BaseResourceConfigModel):
78

79 80 81 82 83 84 85 86
    """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.'))
87
    lease = ForeignKey(Lease, help_text=_("Preferred expiration periods."))
88 89
    raw_data = TextField(verbose_name=_('raw_data'), blank=True, help_text=_(
        'Additional libvirt domain parameters in XML format.'))
Dudás Ádám committed
90 91 92 93 94
    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"))
95 96 97 98
    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
99
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
100 101 102 103 104

    class Meta:
        abstract = True


105
class InstanceTemplate(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
106

107 108
    """Virtual machine template.
    """
109 110 111 112 113
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
114 115 116 117 118 119 120 121 122 123
    name = CharField(max_length=100, unique=True,
                     verbose_name=_('name'),
                     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'),
                        help_text=_('Template which this one is derived of.'))
    disks = ManyToManyField(Disk, verbose_name=_('disks'),
                            related_name='template_set',
                            help_text=_('Disks which are to be mounted.'))
124
    owner = ForeignKey(User)
125 126

    class Meta:
Őry Máté committed
127 128
        app_label = 'vm'
        db_table = 'vm_instancetemplate'
129
        ordering = ('name', )
Őry Máté committed
130 131 132
        permissions = (
            ('create_template', _('Can create an instance template.')),
        )
133 134 135 136 137 138
        verbose_name = _('template')
        verbose_name_plural = _('templates')

    def __unicode__(self):
        return self.name

139
    @property
140
    def running_instances(self):
141
        """The number of running instances of the template.
142
        """
143
        return sum(1 for i in self.instance_set.all() if i.is_running)
144 145 146

    @property
    def os_type(self):
147
        """The type of the template's operating system.
148 149
        """
        if self.access_method == 'rdp':
150
            return 'windows'
151
        else:
152
            return 'linux'
153

154 155 156 157 158 159
    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')

160 161 162 163
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.template-detail', None, {'pk': self.pk})

164

165 166
class Instance(AclBase, VirtualMachineDescModel, StatusModel,
               TimeStampedModel):
tarokkk committed
167

168 169
    """Virtual machine instance.
    """
170 171 172 173 174
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),  # console, networking, change state
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
175 176 177 178 179 180 181 182 183
    STATUS = Choices(
        ('NOSTATE', _('no state')),
        ('RUNNING', _('running')),
        ('STOPPED', _('stopped')),
        ('SUSPENDED', _('suspended')),
        ('ERROR', _('error')),
        ('PENDING', _('pending')),
        ('DESTROYED', _('destroyed')),
    )
Őry Máté committed
184
    name = CharField(blank=True, max_length=100, verbose_name=_('name'),
185
                     help_text=_("Human readable name of instance."))
Őry Máté committed
186 187
    description = TextField(blank=True, verbose_name=_('description'))
    template = ForeignKey(InstanceTemplate, blank=True, null=True,
188
                          related_name='instance_set', on_delete=SET_NULL,
189
                          help_text=_("Template the instance derives from."),
Őry Máté committed
190
                          verbose_name=_('template'))
191
    pw = CharField(help_text=_("Original password of the instance."),
Őry Máté committed
192 193 194
                   max_length=20, verbose_name=_('password'))
    time_of_suspend = DateTimeField(blank=True, default=None, null=True,
                                    verbose_name=_('time of suspend'),
195 196
                                    help_text=_("Proposed time of automatic "
                                                "suspension."))
Őry Máté committed
197 198
    time_of_delete = DateTimeField(blank=True, default=None, null=True,
                                   verbose_name=_('time of delete'),
199 200
                                   help_text=_("Proposed time of automatic "
                                               "deletion."))
Őry Máté committed
201
    active_since = DateTimeField(blank=True, null=True,
202 203
                                 help_text=_("Time stamp of successful "
                                             "boot report."),
Őry Máté committed
204 205 206
                                 verbose_name=_('active since'))
    node = ForeignKey(Node, blank=True, null=True,
                      related_name='instance_set',
207
                      help_text=_("Current hypervisor of this instance."),
Őry Máté committed
208 209
                      verbose_name=_('host node'))
    disks = ManyToManyField(Disk, related_name='instance_set',
210
                            help_text=_("Set of mounted disks."),
Őry Máté committed
211
                            verbose_name=_('disks'))
212 213 214
    vnc_port = IntegerField(blank=True, default=None, null=True,
                            help_text=_("TCP port where VNC console listens."),
                            unique=True, verbose_name=_('vnc_port'))
Őry Máté committed
215
    owner = ForeignKey(User)
216 217 218
    destroyed_at = DateTimeField(blank=True, null=True,
                                 help_text=_("The virtual machine's time of "
                                             "destruction."))
219 220
    objects = Manager()
    active = InstanceActiveManager()
221 222

    class Meta:
Őry Máté committed
223 224
        app_label = 'vm'
        db_table = 'vm_instance'
225
        ordering = ('pk', )
226 227 228 229 230 231
        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.')),
            ('config_ports', _('Can configure port forwards.')),
        )
232 233 234
        verbose_name = _('instance')
        verbose_name_plural = _('instances')

235 236 237 238 239 240 241 242 243 244 245
    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

246 247 248 249 250 251
    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."
252
                           % instance.status)
253 254 255 256 257

            Exception.__init__(self, message)

            self.instance = instance

258
    def __unicode__(self):
259
        parts = (self.name, "(" + str(self.id) + ")")
260
        return " ".join(s for s in parts if s != "")
261

262
    @property
263 264 265 266
    def is_console_available(self):
        return self.is_running

    @property
267
    def is_running(self):
Guba Sándor committed
268 269
        """Check if VM is in running state.
        """
270
        return self.status == 'RUNNING'
271 272

    @property
273
    def state(self):
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
        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)
            self.save()

    def _compute_status(self):
        """Return the proper status of the instance based on activities.
290
        """
291
        # check special cases
292 293 294 295
        if self.activity_log.filter(activity_code__endswith='migrate',
                                    finished__isnull=True).exists():
            return 'MIGRATING'

296 297 298 299 300 301
        # <<< 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]
302
        try:
303
            act = acts[0]
304
        except IndexError:
305 306 307
            return 'NOSTATE'
        else:
            return act.resultant_state
308

Dudás Ádám committed
309 310
    @classmethod
    def create(cls, params, disks, networks, req_traits, tags):
Guba Sándor committed
311 312
        """ Create new Instance object.
        """
Dudás Ádám committed
313 314
        # create instance and do additional setup
        inst = cls(**params)
315

Dudás Ádám committed
316 317 318 319
        # save instance
        inst.full_clean()
        inst.save()
        inst.set_level(inst.owner, 'owner')
320

Dudás Ádám committed
321 322
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
323

Dudás Ádám committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337
        with instance_activity(code_suffix='create', instance=inst,
                               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
338

339
    @classmethod
340
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
341
                             req_traits=None, tags=None, **kwargs):
342 343 344 345 346
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
347 348 349 350 351 352 353 354 355 356 357 358 359 360
        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.
        """
361
        disks = template.disks.all() if disks is None else disks
362

363 364 365 366 367 368 369
        for disk in disks:
            if not disk.has_level(owner, 'user'):
                raise PermissionDenied()
            elif (disk.type == 'qcow2-snap'
                  and not disk.has_level(owner, 'owner')):
                raise PermissionDenied()

370 371 372
        networks = (template.interface_set.all() if networks is None
                    else networks)

373 374 375 376
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
377 378 379
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

382
        # prepare parameters
Dudás Ádám committed
383 384
        common_fields = ['name', 'description', 'num_cores', 'ram_size',
                         'max_ram_size', 'arch', 'priority', 'boot_menu',
385
                         'raw_data', 'lease', 'access_method', 'system']
Dudás Ádám committed
386 387 388
        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
389 390

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

393 394 395 396 397
        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]
398

Dudás Ádám committed
399 400 401 402
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self._do_renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)
403

Guba Sándor committed
404 405 406 407 408
    def manual_state_change(self, new_state="NOSTATE", reason=None, user=None):
        """ Manually change state of an Instance.

        Can be used to recover VM after administrator fixed problems.
        """
Dudás Ádám committed
409 410 411 412 413 414 415 416
        # TODO cancel concurrent activity (if exists)
        act = InstanceActivity.create(code_suffix='manual_state_change',
                                      instance=self, user=user)
        act.finished = act.started
        act.result = reason
        act.resultant_state = new_state
        act.succeeded = True
        act.save()
Dudás Ádám committed
417

Dudás Ádám committed
418 419 420 421 422 423 424 425
    def vm_state_changed(self, new_state):
        # log state change
        try:
            act = InstanceActivity.create(code_suffix='vm_state_changed',
                                          instance=self)
        except ActivityInProgressError:
            pass  # discard state change if another activity is in progress.
        else:
426 427 428 429
            if new_state == 'STOPPED':
                self.vnc_port = None
                self.node = None
                self.save()
Dudás Ádám committed
430 431 432 433
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
434

Őry Máté committed
435
    @permalink
436
    def get_absolute_url(self):
437
        return ('dashboard.views.detail', None, {'pk': self.id})
438 439

    @property
440 441 442 443 444 445 446 447 448
    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
449
    def mem_dump(self):
450
        """Return the path and datastore for the memory dump.
451 452 453

        It is always on the first hard drive storage named cloud-<id>.dump
        """
454 455 456 457 458 459 460
        try:
            datastore = self.disks.all()[0].datastore
        except:
            return None
        else:
            path = datastore.path + '/' + self.vm_name + '.dump'
            return {'datastore': datastore, 'path': path}
461 462

    @property
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
    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):
478 479
        """Primary IPv4 address of the instance.
        """
480 481 482 483
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
484 485
        """Primary IPv6 address of the instance.
        """
486 487 488 489
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
490 491
        """Primary MAC address of the instance.
        """
492 493 494 495 496 497 498 499 500 501 502
        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

503 504 505 506 507 508 509 510 511
    @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

512 513 514 515 516 517 518 519 520 521 522
    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.
        """
523
        return self.activity_log.filter(finished__isnull=True).exists()
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538

    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.
        """
539
        if not self.interface_set.exclude(host=None):
540 541
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
542 543
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
544

545
    def get_connect_command(self, use_ipv6=False):
Guba Sándor committed
546 547
        """Returns a formatted connect string.
        """
548 549 550 551 552 553 554 555 556
        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':
557
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=no '
558 559 560 561 562 563
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

564 565 566 567 568 569 570 571 572
    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'
573 574 575
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
576 577 578
        except:
            return

tarokkk committed
579
    def get_vm_desc(self):
Guba Sándor committed
580 581
        """Serialize Instance object to vmdriver.
        """
tarokkk committed
582
        return {
583
            'name': self.vm_name,
584
            'vcpu': self.num_cores,
585
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
586
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
587 588 589 590 591
            '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()],
592 593 594 595 596
            '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
597
                'port': self.vnc_port
598
            },
599
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
600
            'raw_data': "" if not self.raw_data else self.raw_data
601
        }
tarokkk committed
602

603 604 605 606
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
607 608 609 610
        if self.node:
            return self.node.get_remote_queue_name(queue_id)
        else:
            raise Node.DoesNotExist()
611

612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
    def _is_notified_about_expiration(self):
        renews = self.activity_log.filter(activity_code__endswith='renew')
        cond = {'activity_code__endswith': 'notification_about_expiration'}
        if len(renews) > 0:
            cond['finished__gt'] = renews[0].started
        return self.activity_log.filter(**cond).exists()

    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.
        """
        if not again and self._is_notified_about_expiration():
            return False
        success, failed = [], []

        def on_commit(act):
            act.result = {'failed': failed, 'success': success}

        with instance_activity('notification_about_expiration', instance=self,
                               on_commit=on_commit):
            from dashboard.views import VmRenewView
            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(
                        _('%s expiring soon') % unicode(self),
                        'dashboard/notifications/vm-expiring.html',
                        {'instance': self, 'token': token}, valid_until=min(
                            self.time_of_delete, self.time_of_suspend))
                except Exception as e:
                    failed.append((u, e))
                else:
                    success.append(u)
        return True

649 650 651 652 653 654 655
    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
656 657
        return (self._is_suspend_expiring(threshold) or
                self._is_delete_expiring(threshold))
658 659 660

    def _is_suspend_expiring(self, threshold=0.1):
        interval = self.lease.suspend_interval
Bach Dániel committed
661 662 663
        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()))
664 665 666 667 668 669
            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
670 671 672
        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()))
673 674 675 676
            return limit > self.time_of_delete
        else:
            return False

677 678 679 680 681 682 683
    def get_renew_times(self):
        """Returns new suspend and delete times if renew would be called.
        """
        return (
            timezone.now() + self.lease.suspend_interval,
            timezone.now() + self.lease.delete_interval)

684 685 686 687 688 689 690 691 692
    def _do_renew(self, which='both'):
        """Set expiration times to renewed values.
        """
        time_of_suspend, time_of_delete = self.get_renew_times()
        if which in ('suspend', 'both'):
            self.time_of_suspend = time_of_suspend
        if which in ('delete', 'both'):
            self.time_of_delete = time_of_delete

693
    def renew(self, which='both', base_activity=None, user=None):
Dudás Ádám committed
694 695
        """Renew virtual machine instance leases.
        """
696
        if base_activity is None:
697 698
            act_ctx = instance_activity(code_suffix='renew', instance=self,
                                        user=user)
699
        else:
700 701 702
            act_ctx = base_activity.sub_activity('renew')

        with act_ctx:
703 704
            if which not in ('suspend', 'delete', 'both'):
                raise ValueError('No such expiration type.')
705
            self._do_renew(which)
706
            self.save()
Dudás Ádám committed
707

708 709 710 711 712 713 714 715 716 717 718
    def change_password(self, user=None):
        """Generate new password for the vm

        :param self: The virtual machine.

        :param user: The user who's issuing the command.
        """

        self.pw = pwgen()
        with instance_activity(code_suffix='change_password', instance=self,
                               user=user):
719
            queue = self.get_remote_queue_name("agent")
720 721 722 723 724
            agent_tasks.change_password.apply_async(queue=queue,
                                                    args=(self.vm_name,
                                                          self.pw))
        self.save()

725 726 727 728
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
729

730 731
    def __schedule_vm(self, act):
        """Schedule the virtual machine as part of a higher level activity.
732 733 734 735 736 737 738 739 740

        :param act: Parent activity.
        """
        # Find unused port for VNC
        if self.vnc_port is None:
            self.vnc_port = find_unused_vnc_port()

        # Schedule
        if self.node is None:
741
            self.node = self.select_node()
742 743 744

        self.save()

745
    def __deploy_vm(self, act, timeout=15):
746 747 748 749 750 751 752 753 754
        """Deploy the virtual machine.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        queue_name = self.get_remote_queue_name('vm')

        # Deploy VM on remote machine
755 756 757 758
        with act.sub_activity('deploying_vm') as deploy_act:
            deploy_act.result = vm_tasks.deploy.apply_async(
                args=[self.get_vm_desc()],
                queue=queue_name).get(timeout=timeout)
759 760 761 762 763 764 765 766 767

        # Estabilish network connection (vmdriver)
        with act.sub_activity('deploying_net'):
            for net in self.interface_set.all():
                net.deploy()

        # Resume vm
        with act.sub_activity('booting'):
            vm_tasks.resume.apply_async(args=[self.vm_name],
768
                                        queue=queue_name).get(timeout=timeout)
769

770
        self.renew(which='both', base_activity=act)
771

772
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
773 774 775 776 777 778 779 780 781 782 783
        """Deploy new virtual machine with network

        :param self: The virtual machine to deploy.
        :type self: vm.models.Instance

        :param user: The user who's issuing the command.
        :type user: django.contrib.auth.models.User

        :param task_uuid: The task's UUID, if the command is being executed
                          asynchronously.
        :type task_uuid: str
784
        """
785
        if self.destroyed_at:
786 787
            raise self.InstanceDestroyedError(self)

788 789
        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'
790

791 792 793
        with instance_activity(code_suffix='deploy', instance=self,
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
794

795
            self.__schedule_vm(act)
tarokkk committed
796

797 798
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
799
                devnums = list(string.ascii_lowercase)  # a-z
800
                for disk in self.disks.all():
801 802 803 804 805 806 807
                    # 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
808
                    disk.deploy()
809

810
            self.__deploy_vm(act)
811

812 813 814
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
815 816
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
817 818
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
819

820
    def __destroy_vm(self, act, timeout=15):
821 822 823 824 825 826 827 828 829 830 831 832 833 834
        """Destroy the virtual machine and its associated networks.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        # Destroy networks
        with act.sub_activity('destroying_net'):
            for net in self.interface_set.all():
                net.destroy()

        # Destroy virtual machine
        with act.sub_activity('destroying_vm'):
            queue_name = self.get_remote_queue_name('vm')
835 836
            try:
                vm_tasks.destroy.apply_async(args=[self.vm_name],
837 838
                                             queue=queue_name
                                             ).get(timeout=timeout)
839
            except Exception as e:
840
                if e.libvirtError and "Domain not found" in str(e):
841 842 843 844 845 846
                    logger.debug("Domain %s was not found at %s"
                                 % (self.vm_name, queue_name))
                else:
                    raise

    def __cleanup_after_destroy_vm(self, act, timeout=15):
847 848 849 850 851 852 853 854
        """Clean up the virtual machine's data after destroy.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        # Delete mem. dump if exists
        try:
855 856
            queue_name = self.mem_dump['datastore'].get_remote_queue_name(
                'storage')
857 858
            from storage.tasks.remote_tasks import delete_dump
            delete_dump.apply_async(args=[self.mem_dump['path']],
859
                                    queue=queue_name).get(timeout=timeout)
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
        except:
            pass

        # Clear node and VNC port association
        self.node = None
        self.vnc_port = None

    def redeploy(self, user=None, task_uuid=None):
        """Redeploy virtual machine with network

        :param self: The virtual machine to redeploy.

        :param user: The user who's issuing the command.
        :type user: django.contrib.auth.models.User

        :param task_uuid: The task's UUID, if the command is being executed
                          asynchronously.
        :type task_uuid: str
        """
        with instance_activity(code_suffix='redeploy', instance=self,
                               task_uuid=task_uuid, user=user) as act:
            # Destroy VM
            if self.node:
                self.__destroy_vm(act)

            self.__cleanup_after_destroy_vm(act)

            # Deploy VM
            self.__schedule_vm(act)

            self.__deploy_vm(act)

    def redeploy_async(self, user=None):
        """Execute redeploy asynchronously.
        """
        return local_tasks.redeploy.apply_async(args=[self, user],
                                                queue="localhost.man")

898 899 900
    def shut_off(self, user=None, task_uuid=None):
        """Shut off VM. (plug-out)
        """
901 902 903
        def __on_commit(activity):
            activity.resultant_state = 'STOPPED'

904
        with instance_activity(code_suffix='shut_off', instance=self,
905 906
                               task_uuid=task_uuid, user=user,
                               on_commit=__on_commit) as act:
907 908 909 910 911
            # Destroy VM
            if self.node:
                self.__destroy_vm(act)

            self.__cleanup_after_destroy_vm(act)
912
            self.save()
913 914 915 916 917 918 919

    def shut_off_async(self, user=None):
        """Shut off VM. (plug-out)
        """
        return local_tasks.shut_off.apply_async(args=[self, user],
                                                queue="localhost.man")

920
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
921 922 923 924 925 926 927 928 929 930 931
        """Remove virtual machine and its networks.

        :param self: The virtual machine to destroy.
        :type self: vm.models.Instance

        :param user: The user who's issuing the command.
        :type user: django.contrib.auth.models.User

        :param task_uuid: The task's UUID, if the command is being executed
                          asynchronously.
        :type task_uuid: str
932
        """
933
        if self.destroyed_at:
934 935
            return  # already destroyed, nothing to do here

936 937 938
        def __on_commit(activity):
            activity.resultant_state = 'DESTROYED'

939
        with instance_activity(code_suffix='destroy', instance=self,
940 941
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
942

943
            if self.node:
944
                self.__destroy_vm(act)
945 946 947 948 949 950

            # Destroy disks
            with act.sub_activity('destroying_disks'):
                for disk in self.disks.all():
                    disk.destroy()

951
            self.__cleanup_after_destroy_vm(act)
952

953
            self.destroyed_at = timezone.now()
954
            self.save()
955 956

    def destroy_async(self, user=None):
Dudás Ádám committed
957
        """Execute destroy asynchronously.
958
        """
959 960
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue="localhost.man")
961

962
    def sleep(self, user=None, task_uuid=None, timeout=60):
963 964
        """Suspend virtual machine with memory dump.
        """
965
        if self.status not in ['RUNNING']:
966 967
            raise self.WrongStateError(self)

968
        def __on_abort(activity, error):
969
            if isinstance(error, TimeLimitExceeded):
970 971 972 973 974 975 976
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

        def __on_commit(activity):
            activity.resultant_state = 'SUSPENDED'

977
        with instance_activity(code_suffix='sleep', instance=self,
978
                               on_abort=__on_abort, on_commit=__on_commit,
979
                               task_uuid=task_uuid, user=user) as act:
980

981 982 983
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
984
                    net.shutdown()
985 986 987 988 989 990

            # Suspend vm
            with act.sub_activity('suspending'):
                queue_name = self.get_remote_queue_name('vm')
                vm_tasks.sleep.apply_async(args=[self.vm_name,
                                                 self.mem_dump['path']],
991 992
                                           queue=queue_name
                                           ).get(timeout=timeout)
993 994
                self.node = None
                self.save()
Guba Sándor committed
995

996
    def sleep_async(self, user=None):
Dudás Ádám committed
997
        """Execute sleep asynchronously.
998
        """
999 1000
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
1001

1002
    def wake_up(self, user=None, task_uuid=None, timeout=60):
Guba Sándor committed
1003 1004 1005 1006
        """ Wake up Virtual Machine from SUSPENDED state.

        Power on Virtual Machine and load its memory from dump.
        """
1007
        if self.status not in ['SUSPENDED']:
1008 1009
            raise self.WrongStateError(self)

1010 1011 1012 1013 1014 1015
        def __on_abort(activity, error):
            activity.resultant_state = 'ERROR'

        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'

1016
        with instance_activity(code_suffix='wake_up', instance=self,
1017
                               on_abort=__on_abort, on_commit=__on_commit,
1018
                               task_uuid=task_uuid, user=user) as act:
1019

1020 1021
            # Schedule vm
            self.__schedule_vm(act)
1022
            queue_name = self.get_remote_queue_name('vm')
1023 1024 1025 1026 1027

            # Resume vm
            with act.sub_activity('resuming'):
                vm_tasks.wake_up.apply_async(args=[self.vm_name,
                                                   self.mem_dump['path']],
1028 1029
                                             queue=queue_name
                                             ).get(timeout=timeout)
1030 1031 1032 1033 1034

            # Estabilish network connection (vmdriver)
            with act.sub_activity('deploying_net'):
                for net in self.interface_set.all():
                    net.deploy()
1035

Bach Dániel committed
1036 1037 1038
            # Renew vm
            self.renew(which='both', base_activity=act)

1039
    def wake_up_async(self, user=None):
Dudás Ádám committed
1040
        """Execute wake_up asynchronously.
1041
        """
1042 1043
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
1044

1045
    def shutdown(self, user=None, task_uuid=None, timeout=120):
1046 1047
        """Shutdown virtual machine with ACPI signal.
        """
1048
        def __on_abort(activity, error):
1049
            if isinstance(error, TimeLimitExceeded):
1050 1051 1052 1053 1054 1055 1056
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

        def __on_commit(activity):
            activity.resultant_state = 'STOPPED'

1057
        with instance_activity(code_suffix='shutdown', instance=self,
1058
                               on_abort=__on_abort, on_commit=__on_commit,
1059 1060
                               task_uuid=task_uuid, user=user):
            queue_name = self.get_remote_queue_name('vm')
1061 1062
            logger.debug("RPC Shutdown at queue: %s, for vm: %s.",
                         self.vm_name, queue_name)
1063
            vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
1064 1065
                                          queue=queue_name
                                          ).get(timeout=timeout)
1066 1067 1068
            self.node = None
            self.vnc_port = None
            self.save()
Guba Sándor committed
1069

1070 1071
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
1072
        """
1073 1074
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
1075

1076
    def reset(self, user=None, task_uuid=None, timeout=5):
1077 1078
        """Reset virtual machine (reset button)
        """
1079 1080
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
1081

1082
            queue_name = self.get_remote_queue_name('vm')
1083 1084 1085
            vm_tasks.reset.apply_async(args=[self.vm_name],
                                       queue=queue_name
                                       ).get(timeout=timeout)
Guba Sándor committed
1086

1087 1088
    def reset_async(self, user=None):
        """Execute reset asynchronously.
1089
        """
1090 1091
        return local_tasks.reset.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
1092

1093
    def reboot(self, user=None, task_uuid=None, timeout=5):
Dudás Ádám committed
1094
        """Reboot virtual machine with Ctrl+Alt+Del signal.
1095
        """
1096 1097
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
1098

1099 1100
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
1101 1102
                                        queue=queue_name
                                        ).get(timeout=timeout)
1103

1104
    def reboot_async(self, user=None):
1105
        """Execute reboot asynchronously. """
1106 1107
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
1108

1109 1110 1111 1112 1113
    def migrate_async(self, to_node, user=None):
        """Execute migrate asynchronously. """
        return local_tasks.migrate.apply_async(args=[self, to_node, user],
                                               queue="localhost.man")

1114
    def migrate(self, to_node=None, user=None, task_uuid=None, timeout=120):
1115 1116 1117
        """Live migrate running vm to another node. """
        with instance_activity(code_suffix='migrate', instance=self,
                               task_uuid=task_uuid, user=user) as act:
1118 1119 1120 1121 1122
            if not to_node:
                with act.sub_activity('scheduling') as sa:
                    to_node = self.select_node()
                    sa.result = to_node

1123 1124 1125
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
1126
                    net.shutdown()
1127 1128 1129 1130 1131

            with act.sub_activity('migrate_vm'):
                queue_name = self.get_remote_queue_name('vm')
                vm_tasks.migrate.apply_async(args=[self.vm_name,
                                             to_node.host.hostname],
1132 1133
                                             queue=queue_name
                                             ).get(timeout=timeout)
1134 1135 1136 1137 1138 1139 1140 1141
            # Refresh node information
            self.node = to_node
            self.save()
            # Estabilish network connection (vmdriver)
            with act.sub_activity('deploying_net'):
                for net in self.interface_set.all():
                    net.deploy()

1142
    def save_as_template_async(self, name, user=None, **kwargs):
Guba Sándor committed
1143 1144
        """ Save as template asynchronusly.
        """
1145 1146
        return local_tasks.save_as_template.apply_async(
            args=[self, name, user, kwargs], queue="localhost.man")
1147

1148 1149
    def save_as_template(self, name, task_uuid=None, user=None,
                         timeout=300, **kwargs):
Guba Sándor committed
1150 1151 1152 1153 1154
        """ Save Virtual Machine as a Template.

        Template can be shared with groups and users.
        Users can instantiate Virtual Machines from Templates.
        """
1155
        with instance_activity(code_suffix="save_as_template", instance=self,
1156
                               task_uuid=task_uuid, user=user) as act:
1157
            # prepare parameters
Guba Sándor committed
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
            params = {
                'access_method': self.access_method,
                'arch': self.arch,
                'boot_menu': self.boot_menu,
                'description': self.description,
                'lease': self.lease,  # Can be problem in new VM
                'max_ram_size': self.max_ram_size,
                'name': name,
                'num_cores': self.num_cores,
                'owner': user,
                'parent': self.template,  # Can be problem
                'priority': self.priority,
                'ram_size': self.ram_size,
                'raw_data': self.raw_data,
1172
                'system': self.system,
Guba Sándor committed
1173 1174
            }
            params.update(kwargs)
1175 1176 1177 1178 1179 1180 1181 1182

            def __try_save_disk(disk):
                try:
                    return disk.save_as()  # can do in parallel
                except Disk.WrongDiskTypeError:
                    return disk

            # create template and do additional setup
Guba Sándor committed
1183
            tmpl = InstanceTemplate(**params)
1184
            tmpl.full_clean()  # Avoiding database errors.
1185 1186
            tmpl.save()
            try:
1187 1188 1189
                with act.sub_activity('saving_disks'):
                    tmpl.disks.add(*[__try_save_disk(disk)
                                   for disk in self.disks.all()])
1190 1191 1192 1193 1194 1195 1196 1197
                # create interface templates
                for i in self.interface_set.all():
                    i.save_as_template(tmpl)
            except:
                tmpl.delete()
                raise
            else:
                return tmpl
1198 1199 1200 1201 1202

    def shutdown_and_save_as_template(self, name, user=None, task_uuid=None,
                                      **kwargs):
        self.shutdown(user, task_uuid)
        self.save_as_template(name, **kwargs)
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213

    def get_status_icon(self):
        return {
            'NOSTATE': 'icon-rocket',
            'RUNNING': 'icon-play',
            'STOPPED': 'icon-stop',
            'SUSPENDED': 'icon-pause',
            'ERROR': 'icon-warning_sign',
            'PENDING': 'icon-rocket',
            'DESTROYED': 'icon-trash',
            'MIGRATING': 'icon-truck'}.get(self.status, 'icon-question-sign')