instance.py 43.7 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()]
42
VNC_PORT_RANGE = (2000, 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 252 253 254 255 256 257
    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."
                           % instance.state)

            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 268 269 270
    def is_running(self):
        return self.state == 'RUNNING'

    @property
271
    def state(self):
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
        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.
288
        """
289
        # check special cases
290 291 292 293
        if self.activity_log.filter(activity_code__endswith='migrate',
                                    finished__isnull=True).exists():
            return 'MIGRATING'

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

Dudás Ádám committed
307 308 309 310
    @classmethod
    def create(cls, params, disks, networks, req_traits, tags):
        # create instance and do additional setup
        inst = cls(**params)
311

Dudás Ádám committed
312 313 314 315
        # save instance
        inst.full_clean()
        inst.save()
        inst.set_level(inst.owner, 'owner')
316

Dudás Ádám committed
317 318
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
319

Dudás Ádám committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333
        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
334

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

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

359 360 361 362 363 364 365
        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()

366 367 368
        networks = (template.interface_set.all() if networks is None
                    else networks)

369 370 371 372
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
373 374 375
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

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

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

389 390 391 392 393
        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]
394

Dudás Ádám committed
395 396 397 398
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self._do_renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)
399

Dudás Ádám committed
400 401 402 403 404 405 406 407 408
    def manual_state_change(self, new_state, reason=None, user=None):
        # 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
409

Dudás Ádám committed
410 411 412 413 414 415 416 417
    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:
418 419 420 421
            if new_state == 'STOPPED':
                self.vnc_port = None
                self.node = None
                self.save()
Dudás Ádám committed
422 423 424 425
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
426

Őry Máté committed
427
    @permalink
428
    def get_absolute_url(self):
429
        return ('dashboard.views.detail', None, {'pk': self.id})
430 431

    @property
432 433 434 435 436 437 438 439 440
    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
441
    def mem_dump(self):
442
        """Return the path and datastore for the memory dump.
443 444 445

        It is always on the first hard drive storage named cloud-<id>.dump
        """
446 447 448 449 450 451 452
        try:
            datastore = self.disks.all()[0].datastore
        except:
            return None
        else:
            path = datastore.path + '/' + self.vm_name + '.dump'
            return {'datastore': datastore, 'path': path}
453 454

    @property
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
    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):
470 471
        """Primary IPv4 address of the instance.
        """
472 473 474 475
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
476 477
        """Primary IPv6 address of the instance.
        """
478 479 480 481
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
482 483
        """Primary MAC address of the instance.
        """
484 485 486 487 488 489 490 491 492 493 494
        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

495 496 497 498 499 500 501 502 503
    @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

504 505 506 507 508 509 510 511 512 513 514
    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.
        """
515
        return self.activity_log.filter(finished__isnull=True).exists()
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

    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.
        """
531
        if not self.interface_set.exclude(host=None):
532 533
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
534 535
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
536

537 538 539 540 541 542 543 544 545 546
    def get_connect_command(self, use_ipv6=False):
        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':
547
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=no '
548 549 550 551 552 553
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

554 555 556 557 558 559 560 561 562
    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'
563 564 565
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
566 567 568
        except:
            return

tarokkk committed
569 570
    def get_vm_desc(self):
        return {
571
            'name': self.vm_name,
572
            'vcpu': self.num_cores,
573
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
574
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
575 576 577 578 579
            '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()],
580 581 582 583 584
            '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
585
                'port': self.vnc_port
586
            },
587
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
588
            'raw_data': "" if not self.raw_data else self.raw_data
589
        }
tarokkk committed
590

591 592 593 594
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
595 596 597 598
        if self.node:
            return self.node.get_remote_queue_name(queue_id)
        else:
            raise Node.DoesNotExist()
599

600 601 602 603 604 605 606 607 608 609 610 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
    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

637 638 639 640 641 642 643
    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
644 645
        return (self._is_suspend_expiring(threshold) or
                self._is_delete_expiring(threshold))
646 647 648

    def _is_suspend_expiring(self, threshold=0.1):
        interval = self.lease.suspend_interval
Bach Dániel committed
649 650 651
        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()))
652 653 654 655 656 657
            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
658 659 660
        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()))
661 662 663 664
            return limit > self.time_of_delete
        else:
            return False

665 666 667 668 669 670 671
    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)

672 673 674 675 676 677 678 679 680
    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

681
    def renew(self, which='both', base_activity=None, user=None):
Dudás Ádám committed
682 683
        """Renew virtual machine instance leases.
        """
684
        if base_activity is None:
685 686
            act_ctx = instance_activity(code_suffix='renew', instance=self,
                                        user=user)
687
        else:
688 689 690
            act_ctx = base_activity.sub_activity('renew')

        with act_ctx:
691 692
            if which not in ('suspend', 'delete', 'both'):
                raise ValueError('No such expiration type.')
693
            self._do_renew(which)
694
            self.save()
Dudás Ádám committed
695

696 697 698 699 700 701 702 703 704 705 706
    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):
707
            queue = self.get_remote_queue_name("agent")
708 709 710 711 712
            agent_tasks.change_password.apply_async(queue=queue,
                                                    args=(self.vm_name,
                                                          self.pw))
        self.save()

713 714 715 716
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
717

718 719
    def __schedule_vm(self, act):
        """Schedule the virtual machine as part of a higher level activity.
720 721 722 723 724 725 726 727 728

        :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:
729
            self.node = self.select_node()
730 731 732

        self.save()

733
    def __deploy_vm(self, act, timeout=15):
734 735 736 737 738 739 740 741 742
        """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
743 744 745 746
        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)
747 748 749 750 751 752 753 754 755

        # 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],
756
                                        queue=queue_name).get(timeout=timeout)
757

758
        self.renew(which='both', base_activity=act)
759

760
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
761 762 763 764 765 766 767 768 769 770 771
        """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
772
        """
773
        if self.destroyed_at:
774 775
            raise self.InstanceDestroyedError(self)

776 777
        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'
778

779 780 781
        with instance_activity(code_suffix='deploy', instance=self,
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
782

783
            self.__schedule_vm(act)
tarokkk committed
784

785 786
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
787
                devnums = list(string.ascii_lowercase)  # a-z
788
                for disk in self.disks.all():
789 790 791 792 793 794 795
                    # 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
796
                    disk.deploy()
797

798
            self.__deploy_vm(act)
799

800 801 802
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
803 804
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
805 806
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
807

808
    def __destroy_vm(self, act, timeout=15):
809 810 811 812 813 814 815 816 817 818 819 820 821 822
        """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')
823 824
            try:
                vm_tasks.destroy.apply_async(args=[self.vm_name],
825 826
                                             queue=queue_name
                                             ).get(timeout=timeout)
827
            except Exception as e:
828
                if e.libvirtError and "Domain not found" in str(e):
829 830 831 832 833 834
                    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):
835 836 837 838 839 840 841 842
        """Clean up the virtual machine's data after destroy.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        # Delete mem. dump if exists
        try:
843 844
            queue_name = self.mem_dump['datastore'].get_remote_queue_name(
                'storage')
845 846
            from storage.tasks.remote_tasks import delete_dump
            delete_dump.apply_async(args=[self.mem_dump['path']],
847
                                    queue=queue_name).get(timeout=timeout)
848 849 850 851 852 853 854 855 856 857 858 859 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
        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")

886 887 888
    def shut_off(self, user=None, task_uuid=None):
        """Shut off VM. (plug-out)
        """
889 890 891
        def __on_commit(activity):
            activity.resultant_state = 'STOPPED'

892
        with instance_activity(code_suffix='shut_off', instance=self,
893 894
                               task_uuid=task_uuid, user=user,
                               on_commit=__on_commit) as act:
895 896 897 898 899
            # Destroy VM
            if self.node:
                self.__destroy_vm(act)

            self.__cleanup_after_destroy_vm(act)
900
            self.save()
901 902 903 904 905 906 907

    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")

908
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
909 910 911 912 913 914 915 916 917 918 919
        """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
920
        """
921
        if self.destroyed_at:
922 923
            return  # already destroyed, nothing to do here

924 925 926
        def __on_commit(activity):
            activity.resultant_state = 'DESTROYED'

927
        with instance_activity(code_suffix='destroy', instance=self,
928 929
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
930

931
            if self.node:
932
                self.__destroy_vm(act)
933 934 935 936 937 938

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

939
            self.__cleanup_after_destroy_vm(act)
940

941
            self.destroyed_at = timezone.now()
942
            self.save()
943 944

    def destroy_async(self, user=None):
Dudás Ádám committed
945
        """Execute destroy asynchronously.
946
        """
947 948
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue="localhost.man")
949

950
    def sleep(self, user=None, task_uuid=None, timeout=60):
951 952
        """Suspend virtual machine with memory dump.
        """
953 954 955
        if self.state not in ['RUNNING']:
            raise self.WrongStateError(self)

956
        def __on_abort(activity, error):
957
            if isinstance(error, TimeLimitExceeded):
958 959 960 961 962 963 964
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

965
        with instance_activity(code_suffix='sleep', instance=self,
966
                               on_abort=__on_abort, on_commit=__on_commit,
967
                               task_uuid=task_uuid, user=user) as act:
968

969 970 971
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
972
                    net.shutdown()
973 974 975 976 977 978

            # 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']],
979 980
                                           queue=queue_name
                                           ).get(timeout=timeout)
981 982
                self.node = None
                self.save()
Guba Sándor committed
983

984
    def sleep_async(self, user=None):
Dudás Ádám committed
985
        """Execute sleep asynchronously.
986
        """
987 988
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
989

990
    def wake_up(self, user=None, task_uuid=None, timeout=60):
991 992 993
        if self.state not in ['SUSPENDED']:
            raise self.WrongStateError(self)

994 995 996 997 998 999
        def __on_abort(activity, error):
            activity.resultant_state = 'ERROR'

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

1000
        with instance_activity(code_suffix='wake_up', instance=self,
1001
                               on_abort=__on_abort, on_commit=__on_commit,
1002
                               task_uuid=task_uuid, user=user) as act:
1003

1004 1005
            # Schedule vm
            self.__schedule_vm(act)
1006
            queue_name = self.get_remote_queue_name('vm')
1007 1008 1009 1010 1011

            # Resume vm
            with act.sub_activity('resuming'):
                vm_tasks.wake_up.apply_async(args=[self.vm_name,
                                                   self.mem_dump['path']],
1012 1013
                                             queue=queue_name
                                             ).get(timeout=timeout)
1014 1015 1016 1017 1018

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

Bach Dániel committed
1020 1021 1022
            # Renew vm
            self.renew(which='both', base_activity=act)

1023
    def wake_up_async(self, user=None):
Dudás Ádám committed
1024
        """Execute wake_up asynchronously.
1025
        """
1026 1027
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
1028

1029
    def shutdown(self, user=None, task_uuid=None, timeout=120):
1030 1031
        """Shutdown virtual machine with ACPI signal.
        """
1032
        def __on_abort(activity, error):
1033
            if isinstance(error, TimeLimitExceeded):
1034 1035 1036 1037 1038 1039 1040
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

1041
        with instance_activity(code_suffix='shutdown', instance=self,
1042
                               on_abort=__on_abort, on_commit=__on_commit,
1043 1044
                               task_uuid=task_uuid, user=user):
            queue_name = self.get_remote_queue_name('vm')
1045 1046
            logger.debug("RPC Shutdown at queue: %s, for vm: %s.",
                         self.vm_name, queue_name)
1047
            vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
1048 1049
                                          queue=queue_name
                                          ).get(timeout=timeout)
1050 1051 1052
            self.node = None
            self.vnc_port = None
            self.save()
Guba Sándor committed
1053

1054 1055
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
1056
        """
1057 1058
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
1059

1060
    def reset(self, user=None, task_uuid=None, timeout=5):
1061 1062
        """Reset virtual machine (reset button)
        """
1063 1064
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
1065

1066
            queue_name = self.get_remote_queue_name('vm')
1067 1068 1069
            vm_tasks.reset.apply_async(args=[self.vm_name],
                                       queue=queue_name
                                       ).get(timeout=timeout)
Guba Sándor committed
1070

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

1077
    def reboot(self, user=None, task_uuid=None, timeout=5):
Dudás Ádám committed
1078
        """Reboot virtual machine with Ctrl+Alt+Del signal.
1079
        """
1080 1081
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
1082

1083 1084
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
1085 1086
                                        queue=queue_name
                                        ).get(timeout=timeout)
1087

1088
    def reboot_async(self, user=None):
1089
        """Execute reboot asynchronously. """
1090 1091
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
1092

1093 1094 1095 1096 1097
    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")

1098
    def migrate(self, to_node, user=None, task_uuid=None, timeout=120):
1099 1100 1101 1102 1103 1104
        """Live migrate running vm to another node. """
        with instance_activity(code_suffix='migrate', instance=self,
                               task_uuid=task_uuid, user=user) as act:
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
1105
                    net.shutdown()
1106 1107 1108 1109 1110

            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],
1111 1112
                                             queue=queue_name
                                             ).get(timeout=timeout)
1113 1114 1115 1116 1117 1118 1119 1120
            # 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()

1121 1122 1123
    def save_as_template_async(self, name, user=None, **kwargs):
        return local_tasks.save_as_template.apply_async(
            args=[self, name, user, kwargs], queue="localhost.man")
1124

1125 1126 1127
    def save_as_template(self, name, task_uuid=None, user=None,
                         timeout=300, **kwargs):
        with instance_activity(code_suffix="save_as_template", instance=self,
1128
                               task_uuid=task_uuid, user=user) as act:
1129
            # prepare parameters
Guba Sándor committed
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
            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,
                'system': self.template.system if self.template else "",
            }
            params.update(kwargs)
1147 1148 1149 1150 1151 1152 1153 1154

            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
1155
            tmpl = InstanceTemplate(**params)
1156
            tmpl.full_clean()  # Avoiding database errors.
1157
            tmpl.save()
1158 1159 1160 1161
            with act.sub_activity('saving_disks'):
                tmpl.disks.add(*[__try_save_disk(disk)
                               for disk in self.disks.all()])
                # save template
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
            tmpl.save()
            try:
                # create interface templates
                for i in self.interface_set.all():
                    i.save_as_template(tmpl)
            except:
                tmpl.delete()
                raise
            else:
                return tmpl
1172 1173 1174 1175 1176

    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)