instance.py 34.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 Queue import Empty, Full, Queue
6
import string
7

8
import django.conf
9 10 11
from django.db.models import (BooleanField, CharField, DateTimeField,
                              IntegerField, ForeignKey, Manager,
                              ManyToManyField, permalink, TextField)
Őry Máté committed
12 13
from django.contrib.auth.models import User
from django.core import signing
Dudás Ádám committed
14
from django.core.exceptions import PermissionDenied
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 TimeoutError
20
from model_utils.models import TimeStampedModel
21
from taggit.managers import TaggableManager
22

Dudás Ádám committed
23
from acl.models import AclBase
24
from storage.models import Disk
25
from ..tasks import local_tasks, vm_tasks, agent_tasks
Őry Máté committed
26
from .activity import instance_activity
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
def find_unused_vnc_port():
44
    used = set(Instance.objects.values_list('vnc_port', flat=True))
45 46 47 48 49 50 51
    for p in xrange(*VNC_PORT_RANGE):
        if p not in used:
            return p
    else:
        raise Exception("No unused port could be found for VNC.")


52
class InstanceActiveManager(Manager):
Dudás Ádám committed
53

54 55 56 57 58
    def get_query_set(self):
        return super(InstanceActiveManager,
                     self).get_query_set().filter(destroyed=None)


59
class VirtualMachineDescModel(BaseResourceConfigModel):
60

61 62 63 64 65 66 67 68
    """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.'))
69
    lease = ForeignKey(Lease, help_text=_("Preferred expiration periods."))
70 71
    raw_data = TextField(verbose_name=_('raw_data'), blank=True, help_text=_(
        'Additional libvirt domain parameters in XML format.'))
Dudás Ádám committed
72 73 74 75 76
    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"))
Dudás Ádám committed
77
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
78 79 80 81 82

    class Meta:
        abstract = True


83
class InstanceTemplate(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
84

85 86 87 88 89 90 91 92 93 94 95 96 97 98
    """Virtual machine template.

    Every template has:
      * a name and a description
      * an optional parent template
      * state of the template
      * an OS name/description
      * a method of access to the system
      * default values of base resource configuration
      * list of attached images
      * set of interfaces
      * lease times (suspension & deletion)
      * time of creation and last modification
    """
99 100 101 102 103
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
104
    STATES = [('NEW', _('new')),        # template has just been created
105
              ('SAVING', _('saving')),  # changes are being saved
Őry Máté committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
              ('READY', _('ready'))]    # template is ready for instantiation
    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.'))
    system = TextField(verbose_name=_('operating system'),
                       blank=True,
                       help_text=(_('Name of operating system in '
                                    'format like "%s".') %
                                  'Ubuntu 12.04 LTS Desktop amd64'))
    state = CharField(max_length=10, choices=STATES, default='NEW')
    disks = ManyToManyField(Disk, verbose_name=_('disks'),
                            related_name='template_set',
                            help_text=_('Disks which are to be mounted.'))
123 124

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

    def __unicode__(self):
        return self.name

    def running_instances(self):
        """Returns the number of running instances of the template.
        """
140 141
        return len([i for i in self.instance_set.all()
                    if i.state == 'RUNNING'])
142 143 144 145 146 147

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


153
class Instance(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
154

155 156 157 158 159 160 161 162 163 164 165
    """Virtual machine instance.

    Every instance has:
      * a name and a description
      * an optional parent template
      * associated share
      * a generated password for login authentication
      * time of deletion and time of suspension
      * lease times (suspension & deletion)
      * last boot timestamp
      * host node
166
      * current state (libvirt domain state)
167 168
      * time of creation and last modification
      * base resource configuration values
169
      * owner and privilege information
170
    """
171 172 173 174 175
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),  # console, networking, change state
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
176
    name = CharField(blank=True, max_length=100, verbose_name=_('name'),
177
                     help_text=_("Human readable name of instance."))
Őry Máté committed
178 179 180
    description = TextField(blank=True, verbose_name=_('description'))
    template = ForeignKey(InstanceTemplate, blank=True, null=True,
                          related_name='instance_set',
181
                          help_text=_("Template the instance derives from."),
Őry Máté committed
182
                          verbose_name=_('template'))
183
    pw = CharField(help_text=_("Original password of the instance."),
Őry Máté committed
184 185 186
                   max_length=20, verbose_name=_('password'))
    time_of_suspend = DateTimeField(blank=True, default=None, null=True,
                                    verbose_name=_('time of suspend'),
187 188
                                    help_text=_("Proposed time of automatic "
                                                "suspension."))
Őry Máté committed
189 190
    time_of_delete = DateTimeField(blank=True, default=None, null=True,
                                   verbose_name=_('time of delete'),
191 192
                                   help_text=_("Proposed time of automatic "
                                               "deletion."))
Őry Máté committed
193
    active_since = DateTimeField(blank=True, null=True,
194 195
                                 help_text=_("Time stamp of successful "
                                             "boot report."),
Őry Máté committed
196 197 198
                                 verbose_name=_('active since'))
    node = ForeignKey(Node, blank=True, null=True,
                      related_name='instance_set',
199
                      help_text=_("Current hypervisor of this instance."),
Őry Máté committed
200 201
                      verbose_name=_('host node'))
    disks = ManyToManyField(Disk, related_name='instance_set',
202
                            help_text=_("Set of mounted disks."),
Őry Máté committed
203
                            verbose_name=_('disks'))
204 205 206
    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
207
    owner = ForeignKey(User)
Dudás Ádám committed
208
    destroyed = DateTimeField(blank=True, null=True,
209 210
                              help_text=_("The virtual machine's time of "
                                          "destruction."))
211 212
    objects = Manager()
    active = InstanceActiveManager()
213
    libvirt_state_queue = Queue(maxsize=10)
214 215

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

228 229 230 231 232 233 234 235 236 237 238
    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

239 240 241 242 243 244 245 246 247 248 249 250
    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

251
    def __unicode__(self):
252 253
        parts = [self.name, "(" + str(self.id) + ")"]
        return " ".join([s for s in parts if s != ""])
254

255 256 257 258 259 260 261
    def __clear_libvirt_state_queue(self):
        while True:
            try:
                self.libvirt_state_queue.get_nowait()
            except Empty:
                break

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

270 271 272 273 274 275
        try:
            act = self.activity_log.filter(finished__isnull=False,
                                           resultant_state__isnull=False
                                           ).order_by('-finished').all()[0]
        except IndexError:
            act = None
276 277
        return 'NOSTATE' if act is None else act.resultant_state

278
    def state_changed(self, state):
279 280 281 282 283
        try:
            self.libvirt_state_queue.put_nowait(state)
        except Full:
            pass

284 285 286 287 288
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self.renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)

289
    @classmethod
290
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
291
                             req_traits=None, tags=None, **kwargs):
292 293 294 295 296
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
297 298 299 300 301 302 303 304 305 306 307 308 309 310
        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.
        """
311
        disks = template.disks.all() if disks is None else disks
312

313 314 315 316 317 318 319
        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()

320 321 322
        networks = (template.interface_set.all() if networks is None
                    else networks)

323 324 325 326
        for network in networks:
            if not network.vlan.has_level(owner, 'user'):
                raise PermissionDenied()

Dudás Ádám committed
327 328 329
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

332
        # prepare parameters
Dudás Ádám committed
333 334 335 336 337 338 339
        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

340 341 342 343 344
        return [cls.__create_instance(params, disks, networks, req_traits,
                                      tags) for i in xrange(amount)]

    @classmethod
    def __create_instance(cls, params, disks, networks, req_traits, tags):
345
        # create instance and do additional setup
Dudás Ádám committed
346 347
        inst = cls(**params)

348
        # save instance
349
        inst.clean()
350
        inst.save()
351
        inst.set_level(inst.owner, 'owner')
Dudás Ádám committed
352

353 354
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
355

356 357 358 359
        with instance_activity(code_suffix='create', instance=inst,
                               on_commit=__on_commit, user=inst.owner):
            # create related entities
            inst.disks.add(*[disk.get_exclusive() for disk in disks])
360

361 362 363
            for net in networks:
                Interface.create(instance=inst, vlan=net.vlan,
                                 owner=inst.owner, managed=net.managed)
Dudás Ádám committed
364

365 366 367 368
            inst.req_traits.add(*req_traits)
            inst.tags.add(*tags)

            return inst
369

Őry Máté committed
370
    @permalink
371
    def get_absolute_url(self):
372
        return ('dashboard.views.detail', None, {'pk': self.id})
373 374

    @property
375 376 377 378 379 380 381 382 383
    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
384
    def mem_dump(self):
385
        """Return the path and datastore for the memory dump.
386 387 388

        It is always on the first hard drive storage named cloud-<id>.dump
        """
389 390 391
        datastore = self.disks.all()[0].datastore
        path = datastore.path + '/' + self.vm_name + '.dump'
        return {'datastore': datastore, 'path': path}
392 393

    @property
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
    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):
409 410
        """Primary IPv4 address of the instance.
        """
411 412 413 414
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
415 416
        """Primary IPv6 address of the instance.
        """
417 418 419 420
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
421 422
        """Primary MAC address of the instance.
        """
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
        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

    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.
        """
445
        return self.activity_log.filter(finished__isnull=True).exists()
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

    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.
        """
461
        if not self.interface_set.exclude(host=None):
462 463
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
464 465
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
466

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
    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':
                return ('sshpass -p %(pw)s ssh -o StrictHostKeyChecking=n '
                        'cloud@%(host)s -p %(port)d') % {
                    'port': port, 'proto': proto, 'pw': self.pw,
                    'host': host}
        except:
            return

484 485 486 487 488 489 490 491 492
    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'
493 494 495
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
496 497 498
        except:
            return

tarokkk committed
499 500
    def get_vm_desc(self):
        return {
501
            'name': self.vm_name,
502
            'vcpu': self.num_cores,
503
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
504
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
505 506 507 508 509
            '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()],
510 511 512 513 514
            '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
515
                'port': self.vnc_port
516
            },
517
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
518
            'raw_data': "" if not self.raw_data else self.raw_data
519
        }
tarokkk committed
520

521 522 523 524
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
525
        return self.node.get_remote_queue_name(queue_id) if self.node else None
526

Dudás Ádám committed
527 528 529 530 531 532 533 534 535 536 537
    def renew(self, which='both'):
        """Renew virtual machine instance leases.
        """
        if which not in ['suspend', 'delete', 'both']:
            raise ValueError('No such expiration type.')
        if which in ['suspend', 'both']:
            self.time_of_suspend = timezone.now() + self.lease.suspend_interval
        if which in ['delete', 'both']:
            self.time_of_delete = timezone.now() + self.lease.delete_interval
        self.save()

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
    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):
            queue = "%s.agent" % self.node.host.hostname
            agent_tasks.change_password.apply_async(queue=queue,
                                                    args=(self.vm_name,
                                                          self.pw))
        self.save()

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 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
    def __schedule_vm(self, act):
        """Schedule the virtual machine.

        :param self: The virtual machine.

        :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:
            self.node = scheduler.select_node(self, Node.objects.all())

        self.save()

    def __deploy_vm(self, act):
        """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
        with act.sub_activity('deploying_vm'):
            vm_tasks.deploy.apply_async(args=[self.get_vm_desc()],
                                        queue=queue_name).get()

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

        self.renew('suspend')

598
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
599 600 601 602 603 604 605 606 607 608 609
        """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
610
        """
611 612 613
        if self.destroyed:
            raise self.InstanceDestroyedError(self)

614 615
        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'
616

617 618 619
        with instance_activity(code_suffix='deploy', instance=self,
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
620

621
            self.__schedule_vm(act)
tarokkk committed
622

623 624
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
625
                devnums = list(string.ascii_lowercase)  # a-z
626
                for disk in self.disks.all():
627 628 629 630 631 632 633
                    # 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
634
                    disk.deploy()
635

636
            self.__deploy_vm(act)
637

638 639 640
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
641 642
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
643 644
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
645

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
    def __destroy_vm(self, act):
        """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')
            vm_tasks.destroy.apply_async(args=[self.vm_name],
                                         queue=queue_name).get()

    def __cleanup_after_destroy_vm(self, act):
        """Clean up the virtual machine's data after destroy.

        :param self: The virtual machine.

        :param act: Parent activity.
        """
        # Delete mem. dump if exists
        queue_name = self.mem_dump['datastore'].get_remote_queue_name(
            'storage')
        try:
            from storage.tasks.remote_tasks import delete
            delete.apply_async(args=[self.mem_dump['path']],
                               queue=queue_name).get()
        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")

716
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
717 718 719 720 721 722 723 724 725 726 727
        """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
728
        """
729 730 731
        if self.destroyed:
            return  # already destroyed, nothing to do here

732 733 734
        def __on_commit(activity):
            activity.resultant_state = 'DESTROYED'

735
        with instance_activity(code_suffix='destroy', instance=self,
736 737
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
738

739
            if self.node:
740
                self.__destroy_vm(act)
741 742 743 744 745 746

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

747
            self.__cleanup_after_destroy_vm(act)
748

Dudás Ádám committed
749
            self.destroyed = timezone.now()
750
            self.save()
751 752

    def destroy_async(self, user=None):
Dudás Ádám committed
753
        """Execute destroy asynchronously.
754
        """
755 756
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue="localhost.man")
757 758 759 760

    def sleep(self, user=None, task_uuid=None):
        """Suspend virtual machine with memory dump.
        """
761 762 763
        if self.state not in ['RUNNING']:
            raise self.WrongStateError(self)

764 765 766 767 768 769 770 771 772
        def __on_abort(activity, error):
            if isinstance(error, TimeoutError):
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

773
        with instance_activity(code_suffix='sleep', instance=self,
774
                               on_abort=__on_abort, on_commit=__on_commit,
775
                               task_uuid=task_uuid, user=user):
776

777
            queue_name = self.get_remote_queue_name('vm')
778 779
            vm_tasks.sleep.apply_async(args=[self.vm_name,
                                             self.mem_dump['path']],
780
                                       queue=queue_name).get()
Guba Sándor committed
781

782
    def sleep_async(self, user=None):
Dudás Ádám committed
783
        """Execute sleep asynchronously.
784
        """
785 786
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
787

788
    def wake_up(self, user=None, task_uuid=None):
789 790 791
        if self.state not in ['SUSPENDED']:
            raise self.WrongStateError(self)

792 793 794 795 796 797
        def __on_abort(activity, error):
            activity.resultant_state = 'ERROR'

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

798
        with instance_activity(code_suffix='wake_up', instance=self,
799
                               on_abort=__on_abort, on_commit=__on_commit,
800
                               task_uuid=task_uuid, user=user):
801

802 803 804
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.resume.apply_async(args=[self.vm_name, self.dump_mem],
                                        queue=queue_name).get()
805

806
    def wake_up_async(self, user=None):
Dudás Ádám committed
807
        """Execute wake_up asynchronously.
808
        """
809 810
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
811

812 813 814
    def shutdown(self, user=None, task_uuid=None):
        """Shutdown virtual machine with ACPI signal.
        """
815 816 817 818 819 820 821 822 823
        def __on_abort(activity, error):
            if isinstance(error, TimeoutError):
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

824
        with instance_activity(code_suffix='shutdown', instance=self,
825
                               on_abort=__on_abort, on_commit=__on_commit,
826
                               task_uuid=task_uuid, user=user):
827

828
            queue_name = self.get_remote_queue_name('vm')
829
            self.__clear_libvirt_state_queue()
830 831
            vm_tasks.shutdown.apply_async(args=[self.vm_name],
                                          queue=queue_name).get()
832 833 834 835 836 837 838 839 840 841 842
            i = 2
            while i > 0:
                try:
                    libvirt_state = self.libvirt_state_queue.get(True, 60)
                except Empty:
                    raise TimeoutError()
                else:
                    if libvirt_state == 'MISSING':
                        break
                    else:
                        i -= 1
Guba Sándor committed
843

844 845
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
846
        """
847 848
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
849

850 851 852
    def reset(self, user=None, task_uuid=None):
        """Reset virtual machine (reset button)
        """
853 854
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
855

856 857 858
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.restart.apply_async(args=[self.vm_name],
                                         queue=queue_name).get()
Guba Sándor committed
859

860 861
    def reset_async(self, user=None):
        """Execute reset asynchronously.
862
        """
863 864
        return local_tasks.restart.apply_async(args=[self, user],
                                               queue="localhost.man")
Guba Sándor committed
865

866
    def reboot(self, user=None, task_uuid=None):
Dudás Ádám committed
867
        """Reboot virtual machine with Ctrl+Alt+Del signal.
868
        """
869 870
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
871

872 873 874
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
                                        queue=queue_name).get()
875

876
    def reboot_async(self, user=None):
877
        """Execute reboot asynchronously. """
878 879
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
880

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    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")

    def migrate(self, to_node, user=None, task_uuid=None):
        """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():
                    net.destroy()

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

908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
    def save_as_template(self, name, **kwargs):
        # 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)
        # create template and do additional setup
        tmpl = InstanceTemplate(**kwargs)
        # save template
        tmpl.save()
        # create related entities
        for disk in self.disks.all():
            try:
                d = disk.save_as()
            except Disk.WrongDiskTypeError:
                d = disk

            tmpl.disks.add(d)

        for i in self.interface_set.all():
            i.save_as_template(tmpl)

        return tmpl