instance.py 42.8 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
import string
6

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

18
from celery.exceptions import TimeLimitExceeded
19
from model_utils.models import TimeStampedModel
20
from taggit.managers import TaggableManager
21

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

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

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


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


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

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


68
class InstanceActiveManager(Manager):
Dudás Ádám committed
69

70 71 72 73 74
    def get_query_set(self):
        return super(InstanceActiveManager,
                     self).get_query_set().filter(destroyed=None)


75
class VirtualMachineDescModel(BaseResourceConfigModel):
76

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

    class Meta:
        abstract = True


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

106 107
    """Virtual machine template.
    """
108 109 110 111 112
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
113 114 115 116 117 118 119 120 121 122
    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.'))
123
    owner = ForeignKey(User)
124 125

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

    def __unicode__(self):
        return self.name

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

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

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

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

163

164
class Instance(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
165

166 167
    """Virtual machine instance.
    """
168 169 170 171 172
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),  # console, networking, change state
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
173
    name = CharField(blank=True, max_length=100, verbose_name=_('name'),
174
                     help_text=_("Human readable name of instance."))
Őry Máté committed
175 176
    description = TextField(blank=True, verbose_name=_('description'))
    template = ForeignKey(InstanceTemplate, blank=True, null=True,
177
                          related_name='instance_set', on_delete=SET_NULL,
178
                          help_text=_("Template the instance derives from."),
Őry Máté committed
179
                          verbose_name=_('template'))
180
    pw = CharField(help_text=_("Original password of the instance."),
Őry Máté committed
181 182 183
                   max_length=20, verbose_name=_('password'))
    time_of_suspend = DateTimeField(blank=True, default=None, null=True,
                                    verbose_name=_('time of suspend'),
184 185
                                    help_text=_("Proposed time of automatic "
                                                "suspension."))
Őry Máté committed
186 187
    time_of_delete = DateTimeField(blank=True, default=None, null=True,
                                   verbose_name=_('time of delete'),
188 189
                                   help_text=_("Proposed time of automatic "
                                               "deletion."))
Őry Máté committed
190
    active_since = DateTimeField(blank=True, null=True,
191 192
                                 help_text=_("Time stamp of successful "
                                             "boot report."),
Őry Máté committed
193 194 195
                                 verbose_name=_('active since'))
    node = ForeignKey(Node, blank=True, null=True,
                      related_name='instance_set',
196
                      help_text=_("Current hypervisor of this instance."),
Őry Máté committed
197 198
                      verbose_name=_('host node'))
    disks = ManyToManyField(Disk, related_name='instance_set',
199
                            help_text=_("Set of mounted disks."),
Őry Máté committed
200
                            verbose_name=_('disks'))
201 202 203
    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
204
    owner = ForeignKey(User)
Dudás Ádám committed
205
    destroyed = DateTimeField(blank=True, null=True,
206 207
                              help_text=_("The virtual machine's time of "
                                          "destruction."))
208 209
    objects = Manager()
    active = InstanceActiveManager()
210 211

    class Meta:
Őry Máté committed
212 213
        app_label = 'vm'
        db_table = 'vm_instance'
214
        ordering = ('pk', )
215 216 217 218 219 220
        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.')),
        )
221 222 223
        verbose_name = _('instance')
        verbose_name_plural = _('instances')

224 225 226 227 228 229 230 231 232 233 234
    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

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

247
    def __unicode__(self):
248
        parts = (self.name, "(" + str(self.id) + ")")
249
        return " ".join(s for s in parts if s != "")
250

251
    @property
252 253 254 255
    def is_console_available(self):
        return self.is_running

    @property
256 257 258 259
    def is_running(self):
        return self.state == 'RUNNING'

    @property
260 261 262
    def state(self):
        """State of the virtual machine instance.
        """
263
        # check special cases
264 265 266 267
        if self.activity_log.filter(activity_code__endswith='migrate',
                                    finished__isnull=True).exists():
            return 'MIGRATING'

268 269 270 271 272 273
        # <<< 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]
274
        try:
275
            act = acts[0]
276
        except IndexError:
277 278 279
            return 'NOSTATE'
        else:
            return act.resultant_state
280

Dudás Ádám committed
281 282 283 284
    @classmethod
    def create(cls, params, disks, networks, req_traits, tags):
        # create instance and do additional setup
        inst = cls(**params)
285

Dudás Ádám committed
286 287 288 289
        # save instance
        inst.full_clean()
        inst.save()
        inst.set_level(inst.owner, 'owner')
290

Dudás Ádám committed
291 292
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
293

Dudás Ádám committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307
        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
308

309
    @classmethod
310
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
311
                             req_traits=None, tags=None, **kwargs):
312 313 314 315 316
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
317 318 319 320 321 322 323 324 325 326 327 328 329 330
        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.
        """
331
        disks = template.disks.all() if disks is None else disks
332

333 334 335 336 337 338 339
        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()

340 341 342
        networks = (template.interface_set.all() if networks is None
                    else networks)

343 344 345 346
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
347 348 349
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

352
        # prepare parameters
Dudás Ádám committed
353 354 355 356 357 358
        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
359 360

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

363 364 365 366 367
        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]
368

Dudás Ádám committed
369 370 371 372
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self._do_renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)
373

Dudás Ádám committed
374 375 376 377 378 379 380 381 382
    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
383

Dudás Ádám committed
384 385 386 387 388 389 390 391
    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:
392 393 394 395
            if new_state == 'STOPPED':
                self.vnc_port = None
                self.node = None
                self.save()
Dudás Ádám committed
396 397 398 399
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
400

Őry Máté committed
401
    @permalink
402
    def get_absolute_url(self):
403
        return ('dashboard.views.detail', None, {'pk': self.id})
404 405

    @property
406 407 408 409 410 411 412 413 414
    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
415
    def mem_dump(self):
416
        """Return the path and datastore for the memory dump.
417 418 419

        It is always on the first hard drive storage named cloud-<id>.dump
        """
420 421 422 423 424 425 426
        try:
            datastore = self.disks.all()[0].datastore
        except:
            return None
        else:
            path = datastore.path + '/' + self.vm_name + '.dump'
            return {'datastore': datastore, 'path': path}
427 428

    @property
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    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):
444 445
        """Primary IPv4 address of the instance.
        """
446 447 448 449
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
450 451
        """Primary IPv6 address of the instance.
        """
452 453 454 455
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
456 457
        """Primary MAC address of the instance.
        """
458 459 460 461 462 463 464 465 466 467 468
        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

469 470 471 472 473 474 475 476 477
    @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

478 479 480 481 482 483 484 485 486 487 488
    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.
        """
489
        return self.activity_log.filter(finished__isnull=True).exists()
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504

    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.
        """
505
        if not self.interface_set.exclude(host=None):
506 507
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
508 509
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
510

511 512 513 514 515 516 517 518 519 520
    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':
521
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=no '
522 523 524 525 526 527
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

528 529 530 531 532 533 534 535 536
    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'
537 538 539
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
540 541 542
        except:
            return

tarokkk committed
543 544
    def get_vm_desc(self):
        return {
545
            'name': self.vm_name,
546
            'vcpu': self.num_cores,
547
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
548
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
549 550 551 552 553
            '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()],
554 555 556 557 558
            '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
559
                'port': self.vnc_port
560
            },
561
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
562
            'raw_data': "" if not self.raw_data else self.raw_data
563
        }
tarokkk committed
564

565 566 567 568
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
569 570 571 572
        if self.node:
            return self.node.get_remote_queue_name(queue_id)
        else:
            raise Node.DoesNotExist()
573

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
    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

611 612 613 614 615 616 617
    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
618 619
        return (self._is_suspend_expiring(threshold) or
                self._is_delete_expiring(threshold))
620 621 622

    def _is_suspend_expiring(self, threshold=0.1):
        interval = self.lease.suspend_interval
Bach Dániel committed
623 624 625
        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()))
626 627 628 629 630 631
            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
632 633 634
        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()))
635 636 637 638
            return limit > self.time_of_delete
        else:
            return False

639 640 641 642 643 644 645
    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)

646 647 648 649 650 651 652 653 654
    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

655
    def renew(self, which='both', base_activity=None, user=None):
Dudás Ádám committed
656 657
        """Renew virtual machine instance leases.
        """
658
        if base_activity is None:
659 660
            act_ctx = instance_activity(code_suffix='renew', instance=self,
                                        user=user)
661
        else:
662 663 664
            act_ctx = base_activity.sub_activity('renew')

        with act_ctx:
665 666
            if which not in ('suspend', 'delete', 'both'):
                raise ValueError('No such expiration type.')
667
            self._do_renew(which)
668
            self.save()
Dudás Ádám committed
669

670 671 672 673 674 675 676 677 678 679 680
    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):
681
            queue = self.get_remote_queue_name("agent")
682 683 684 685 686
            agent_tasks.change_password.apply_async(queue=queue,
                                                    args=(self.vm_name,
                                                          self.pw))
        self.save()

687 688 689 690
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
691

692 693
    def __schedule_vm(self, act):
        """Schedule the virtual machine as part of a higher level activity.
694 695 696 697 698 699 700 701 702

        :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:
703
            self.node = self.select_node()
704 705 706

        self.save()

707
    def __deploy_vm(self, act, timeout=15):
708 709 710 711 712 713 714 715 716
        """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
717 718 719 720
        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)
721 722 723 724 725 726 727 728 729

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

732
        self._do_renew()
733
        self.save()
734

735
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
736 737 738 739 740 741 742 743 744 745 746
        """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
747
        """
748 749 750
        if self.destroyed:
            raise self.InstanceDestroyedError(self)

751 752
        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'
753

754 755 756
        with instance_activity(code_suffix='deploy', instance=self,
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
757

758
            self.__schedule_vm(act)
tarokkk committed
759

760 761
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
762
                devnums = list(string.ascii_lowercase)  # a-z
763
                for disk in self.disks.all():
764 765 766 767 768 769 770
                    # 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
771
                    disk.deploy()
772

773
            self.__deploy_vm(act)
774

775 776 777
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
778 779
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
780 781
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
782

783
    def __destroy_vm(self, act, timeout=15):
784 785 786 787 788 789 790 791 792 793 794 795 796 797
        """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')
798 799
            try:
                vm_tasks.destroy.apply_async(args=[self.vm_name],
800 801
                                             queue=queue_name
                                             ).get(timeout=timeout)
802
            except Exception as e:
803
                if e.libvirtError and "Domain not found" in str(e):
804 805 806 807 808 809
                    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):
810 811 812 813 814 815 816 817
        """Clean up the virtual machine's data after destroy.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        # Delete mem. dump if exists
        try:
818 819
            queue_name = self.mem_dump['datastore'].get_remote_queue_name(
                'storage')
820 821
            from storage.tasks.remote_tasks import delete_dump
            delete_dump.apply_async(args=[self.mem_dump['path']],
822
                                    queue=queue_name).get(timeout=timeout)
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
        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")

861 862 863
    def shut_off(self, user=None, task_uuid=None):
        """Shut off VM. (plug-out)
        """
864 865 866
        def __on_commit(activity):
            activity.resultant_state = 'STOPPED'

867
        with instance_activity(code_suffix='shut_off', instance=self,
868 869
                               task_uuid=task_uuid, user=user,
                               on_commit=__on_commit) as act:
870 871 872 873 874
            # Destroy VM
            if self.node:
                self.__destroy_vm(act)

            self.__cleanup_after_destroy_vm(act)
875
            self.save()
876 877 878 879 880 881 882

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

883
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
884 885 886 887 888 889 890 891 892 893 894
        """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
895
        """
896 897 898
        if self.destroyed:
            return  # already destroyed, nothing to do here

899 900 901
        def __on_commit(activity):
            activity.resultant_state = 'DESTROYED'

902
        with instance_activity(code_suffix='destroy', instance=self,
903 904
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
905

906
            if self.node:
907
                self.__destroy_vm(act)
908 909 910 911 912 913

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

914
            self.__cleanup_after_destroy_vm(act)
915

Dudás Ádám committed
916
            self.destroyed = timezone.now()
917
            self.save()
918 919

    def destroy_async(self, user=None):
Dudás Ádám committed
920
        """Execute destroy asynchronously.
921
        """
922 923
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue="localhost.man")
924

925
    def sleep(self, user=None, task_uuid=None, timeout=60):
926 927
        """Suspend virtual machine with memory dump.
        """
928 929 930
        if self.state not in ['RUNNING']:
            raise self.WrongStateError(self)

931
        def __on_abort(activity, error):
932
            if isinstance(error, TimeLimitExceeded):
933 934 935 936 937 938 939
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

940
        with instance_activity(code_suffix='sleep', instance=self,
941
                               on_abort=__on_abort, on_commit=__on_commit,
942
                               task_uuid=task_uuid, user=user) as act:
943

944 945 946
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
947
                    net.shutdown()
948 949 950 951 952 953

            # 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']],
954 955
                                           queue=queue_name
                                           ).get(timeout=timeout)
956 957
                self.node = None
                self.save()
Guba Sándor committed
958

959
    def sleep_async(self, user=None):
Dudás Ádám committed
960
        """Execute sleep asynchronously.
961
        """
962 963
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
964

965
    def wake_up(self, user=None, task_uuid=None, timeout=60):
966 967 968
        if self.state not in ['SUSPENDED']:
            raise self.WrongStateError(self)

969 970 971 972 973 974
        def __on_abort(activity, error):
            activity.resultant_state = 'ERROR'

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

975
        with instance_activity(code_suffix='wake_up', instance=self,
976
                               on_abort=__on_abort, on_commit=__on_commit,
977
                               task_uuid=task_uuid, user=user) as act:
978

979 980
            # Schedule vm
            self.__schedule_vm(act)
981
            queue_name = self.get_remote_queue_name('vm')
982 983 984 985 986

            # Resume vm
            with act.sub_activity('resuming'):
                vm_tasks.wake_up.apply_async(args=[self.vm_name,
                                                   self.mem_dump['path']],
987 988
                                             queue=queue_name
                                             ).get(timeout=timeout)
989 990 991 992 993

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

995
    def wake_up_async(self, user=None):
Dudás Ádám committed
996
        """Execute wake_up asynchronously.
997
        """
998 999
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
1000

1001
    def shutdown(self, user=None, task_uuid=None, timeout=120):
1002 1003
        """Shutdown virtual machine with ACPI signal.
        """
1004
        def __on_abort(activity, error):
1005
            if isinstance(error, TimeLimitExceeded):
1006 1007 1008 1009 1010 1011 1012
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

1013
        with instance_activity(code_suffix='shutdown', instance=self,
1014
                               on_abort=__on_abort, on_commit=__on_commit,
1015 1016
                               task_uuid=task_uuid, user=user):
            queue_name = self.get_remote_queue_name('vm')
1017 1018
            logger.debug("RPC Shutdown at queue: %s, for vm: %s.",
                         self.vm_name, queue_name)
1019
            vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
1020 1021
                                          queue=queue_name
                                          ).get(timeout=timeout)
1022 1023 1024
            self.node = None
            self.vnc_port = None
            self.save()
Guba Sándor committed
1025

1026 1027
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
1028
        """
1029 1030
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
1031

1032
    def reset(self, user=None, task_uuid=None, timeout=5):
1033 1034
        """Reset virtual machine (reset button)
        """
1035 1036
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
1037

1038
            queue_name = self.get_remote_queue_name('vm')
1039 1040 1041
            vm_tasks.reset.apply_async(args=[self.vm_name],
                                       queue=queue_name
                                       ).get(timeout=timeout)
Guba Sándor committed
1042

1043 1044
    def reset_async(self, user=None):
        """Execute reset asynchronously.
1045
        """
1046 1047
        return local_tasks.reset.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
1048

1049
    def reboot(self, user=None, task_uuid=None, timeout=5):
Dudás Ádám committed
1050
        """Reboot virtual machine with Ctrl+Alt+Del signal.
1051
        """
1052 1053
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
1054

1055 1056
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
1057 1058
                                        queue=queue_name
                                        ).get(timeout=timeout)
1059

1060
    def reboot_async(self, user=None):
1061
        """Execute reboot asynchronously. """
1062 1063
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
1064

1065 1066 1067 1068 1069
    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")

1070
    def migrate(self, to_node, user=None, task_uuid=None, timeout=120):
1071 1072 1073 1074 1075 1076
        """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():
1077
                    net.shutdown()
1078 1079 1080 1081 1082

            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],
1083 1084
                                             queue=queue_name
                                             ).get(timeout=timeout)
1085 1086 1087 1088 1089 1090 1091 1092
            # 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()

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

1097 1098 1099
    def save_as_template(self, name, task_uuid=None, user=None,
                         timeout=300, **kwargs):
        with instance_activity(code_suffix="save_as_template", instance=self,
1100
                               task_uuid=task_uuid, user=user) as act:
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
            # prepare parameters
            kwargs.setdefault('name', name)
            kwargs.setdefault('description', self.description)
            kwargs.setdefault('parent', self.template)
            kwargs.setdefault('num_cores', self.num_cores)
            kwargs.setdefault('ram_size', self.ram_size)
            kwargs.setdefault('max_ram_size', self.max_ram_size)
            kwargs.setdefault('arch', self.arch)
            kwargs.setdefault('priority', self.priority)
            kwargs.setdefault('boot_menu', self.boot_menu)
            kwargs.setdefault('raw_data', self.raw_data)
            kwargs.setdefault('lease', self.lease)
            kwargs.setdefault('access_method', self.access_method)
            kwargs.setdefault('system', self.template.system
                              if self.template else None)

            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
            tmpl = InstanceTemplate(**kwargs)
1125
            tmpl.full_clean()  # Avoiding database errors.
1126
            tmpl.save()
1127 1128 1129 1130
            with act.sub_activity('saving_disks'):
                tmpl.disks.add(*[__try_save_disk(disk)
                               for disk in self.disks.all()])
                # save template
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
            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
1141 1142 1143 1144 1145

    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)