instance.py 37.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
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"))
77 78 79 80 81
    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
82
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
83 84 85 86 87

    class Meta:
        abstract = True


88
class InstanceTemplate(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
89

90 91 92 93 94 95 96 97 98 99 100 101 102 103
    """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
    """
104 105 106 107 108
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
109 110 111 112 113 114 115 116 117 118
    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.'))
119
    owner = ForeignKey(User)
120 121

    class Meta:
Őry Máté committed
122 123
        app_label = 'vm'
        db_table = 'vm_instancetemplate'
124
        ordering = ['name', ]
Őry Máté committed
125 126 127
        permissions = (
            ('create_template', _('Can create an instance template.')),
        )
128 129 130 131 132 133 134 135 136
        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.
        """
137 138
        return len([i for i in self.instance_set.all()
                    if i.state == 'RUNNING'])
139 140 141 142 143 144

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

149 150 151 152 153 154
    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')

155

156
class Instance(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
157

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

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

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

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

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

257 258 259 260 261 262 263 264
    @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'

265 266 267 268 269 270
        try:
            act = self.activity_log.filter(finished__isnull=False,
                                           resultant_state__isnull=False
                                           ).order_by('-finished').all()[0]
        except IndexError:
            act = None
271 272
        return 'NOSTATE' if act is None else act.resultant_state

273 274 275
    def is_console_available(self):
        return self.state in ('RUNNING', )

276
    def manual_state_change(self, new_state, reason=None, user=None):
277
        # TODO cancel concurrent activity (if exists)
278 279 280 281 282 283 284 285
        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()

286
    def vm_state_changed(self, new_state):
287
        try:
288 289 290 291 292 293 294
            act = InstanceActivity.create(
                code_suffix='monitor_event_%s' % new_state,
                instance=self)
            if new_state == "STOPPED":
                self.vnc_port = None
                self.node = None
                self.save()
295 296 297 298 299 300 301
        except ActivityInProgressError:
            pass  # discard state change if another activity is in progress.
        else:
            act.finished = act.started
            act.resultant_state = new_state
            act.succeeded = True
            act.save()
302

303 304 305 306 307
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self.renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)

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

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

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

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

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

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

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

351
        # prepare parameters
Dudás Ádám committed
352 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 361 362 363
        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):
364
        # create instance and do additional setup
Dudás Ádám committed
365 366
        inst = cls(**params)

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

372 373
        def __on_commit(activity):
            activity.resultant_state = 'PENDING'
374

375 376 377 378
        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])
379

380 381 382
            for net in networks:
                Interface.create(instance=inst, vlan=net.vlan,
                                 owner=inst.owner, managed=net.managed)
Dudás Ádám committed
383

384 385 386 387
            inst.req_traits.add(*req_traits)
            inst.tags.add(*tags)

            return inst
388

Őry Máté committed
389
    @permalink
390
    def get_absolute_url(self):
391
        return ('dashboard.views.detail', None, {'pk': self.id})
392 393

    @property
394 395 396 397 398 399 400 401 402
    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
403
    def mem_dump(self):
404
        """Return the path and datastore for the memory dump.
405 406 407

        It is always on the first hard drive storage named cloud-<id>.dump
        """
408 409 410
        datastore = self.disks.all()[0].datastore
        path = datastore.path + '/' + self.vm_name + '.dump'
        return {'datastore': datastore, 'path': path}
411 412

    @property
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
    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):
428 429
        """Primary IPv4 address of the instance.
        """
430 431 432 433
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
434 435
        """Primary IPv6 address of the instance.
        """
436 437 438 439
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
440 441
        """Primary MAC address of the instance.
        """
442 443 444 445 446 447 448 449 450 451 452
        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

453 454 455 456 457 458 459 460 461
    @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

462 463 464 465 466 467 468 469 470 471 472
    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.
        """
473
        return self.activity_log.filter(finished__isnull=True).exists()
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

    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.
        """
489
        if not self.interface_set.exclude(host=None):
490 491
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
492 493
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
494

495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
    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

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

tarokkk committed
527 528
    def get_vm_desc(self):
        return {
529
            'name': self.vm_name,
530
            'vcpu': self.num_cores,
531
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
532
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
533 534 535 536 537
            '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()],
538 539 540 541 542
            '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
543
                'port': self.vnc_port
544
            },
545
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
546
            'raw_data': "" if not self.raw_data else self.raw_data
547
        }
tarokkk committed
548

549 550 551 552
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
553 554 555 556
        if self.node:
            return self.node.get_remote_queue_name(queue_id)
        else:
            raise Node.DoesNotExist()
557

Dudás Ádám committed
558 559 560 561 562 563 564 565 566 567 568
    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()

569 570 571 572 573 574 575 576 577 578 579
    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):
580
            queue = self.get_remote_queue_name("agent")
581 582 583 584 585
            agent_tasks.change_password.apply_async(queue=queue,
                                                    args=(self.vm_name,
                                                          self.pw))
        self.save()

586 587 588 589
    def select_node(self):
        """Returns the node the VM should be deployed or migrated to.
        """
        return scheduler.select_node(self, Node.objects.all())
590

591 592
    def __schedule_vm(self, act):
        """Schedule the virtual machine as part of a higher level activity.
593 594 595 596 597 598 599 600 601

        :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:
602
            self.node = self.select_node()
603 604 605

        self.save()

606
    def __deploy_vm(self, act, timeout=15):
607 608 609 610 611 612 613 614 615
        """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
616 617 618 619
        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)
620 621 622 623 624 625 626 627 628

        # 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],
629
                                        queue=queue_name).get(timeout=timeout)
630 631 632

        self.renew('suspend')

633
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
634 635 636 637 638 639 640 641 642 643 644
        """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
645
        """
646 647 648
        if self.destroyed:
            raise self.InstanceDestroyedError(self)

649 650
        def __on_commit(activity):
            activity.resultant_state = 'RUNNING'
651

652 653 654
        with instance_activity(code_suffix='deploy', instance=self,
                               on_commit=__on_commit, task_uuid=task_uuid,
                               user=user) as act:
655

656
            self.__schedule_vm(act)
tarokkk committed
657

658 659
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
660
                devnums = list(string.ascii_lowercase)  # a-z
661
                for disk in self.disks.all():
662 663 664 665 666 667 668
                    # 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
669
                    disk.deploy()
670

671
            self.__deploy_vm(act)
672

673 674 675
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
676 677
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
678 679
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
680

681
    def __destroy_vm(self, act, timeout=15):
682 683 684 685 686 687 688 689 690 691 692 693 694 695
        """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')
696 697
            try:
                vm_tasks.destroy.apply_async(args=[self.vm_name],
698 699
                                             queue=queue_name
                                             ).get(timeout=timeout)
700
            except Exception as e:
701 702 703 704 705 706 707 708
                if e.libvirtError is True and "Domain not found" in str(e):
                    logger.debug("Domain %s was not found at %s"
                                 % (self.vm_name, queue_name))
                    pass
                else:
                    raise

    def __cleanup_after_destroy_vm(self, act, timeout=15):
709 710 711 712 713 714 715 716 717 718
        """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:
719 720
            from storage.tasks.remote_tasks import delete_dump
            delete_dump.apply_async(args=[self.mem_dump['path']],
721
                                    queue=queue_name).get(timeout=timeout)
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
        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")

760
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
761 762 763 764 765 766 767 768 769 770 771
        """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
772
        """
773 774 775
        if self.destroyed:
            return  # already destroyed, nothing to do here

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

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

783
            if self.node:
784
                self.__destroy_vm(act)
785 786 787 788 789 790

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

791
            self.__cleanup_after_destroy_vm(act)
792

Dudás Ádám committed
793
            self.destroyed = timezone.now()
794
            self.save()
795 796

    def destroy_async(self, user=None):
Dudás Ádám committed
797
        """Execute destroy asynchronously.
798
        """
799 800
        return local_tasks.destroy.apply_async(args=[self, user],
                                               queue="localhost.man")
801

802
    def sleep(self, user=None, task_uuid=None, timeout=60):
803 804
        """Suspend virtual machine with memory dump.
        """
805 806 807
        if self.state not in ['RUNNING']:
            raise self.WrongStateError(self)

808
        def __on_abort(activity, error):
809
            if isinstance(error, TimeLimitExceeded):
810 811 812 813 814 815 816
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

817
        with instance_activity(code_suffix='sleep', instance=self,
818
                               on_abort=__on_abort, on_commit=__on_commit,
819
                               task_uuid=task_uuid, user=user) as act:
820

821 822 823 824 825 826 827 828 829 830
            # Destroy networks
            with act.sub_activity('destroying_net'):
                for net in self.interface_set.all():
                    net.destroy(delete_host=False)

            # 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']],
831 832
                                           queue=queue_name
                                           ).get(timeout=timeout)
833 834 835
                self.node = None
                self.vnc_port = None
                self.save()
Guba Sándor committed
836

837
    def sleep_async(self, user=None):
Dudás Ádám committed
838
        """Execute sleep asynchronously.
839
        """
840 841
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
842

843
    def wake_up(self, user=None, task_uuid=None, timeout=60):
844 845 846
        if self.state not in ['SUSPENDED']:
            raise self.WrongStateError(self)

847 848 849 850 851 852
        def __on_abort(activity, error):
            activity.resultant_state = 'ERROR'

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

853
        with instance_activity(code_suffix='wake_up', instance=self,
854
                               on_abort=__on_abort, on_commit=__on_commit,
855
                               task_uuid=task_uuid, user=user) as act:
856

857 858
            # Schedule vm
            self.__schedule_vm(act)
859
            queue_name = self.get_remote_queue_name('vm')
860 861 862 863 864

            # Resume vm
            with act.sub_activity('resuming'):
                vm_tasks.wake_up.apply_async(args=[self.vm_name,
                                                   self.mem_dump['path']],
865 866
                                             queue=queue_name
                                             ).get(timeout=timeout)
867 868 869 870 871

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

873
    def wake_up_async(self, user=None):
Dudás Ádám committed
874
        """Execute wake_up asynchronously.
875
        """
876 877
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
878

879
    def shutdown(self, user=None, task_uuid=None, timeout=120):
880 881
        """Shutdown virtual machine with ACPI signal.
        """
882
        def __on_abort(activity, error):
883
            if isinstance(error, TimeLimitExceeded):
884 885 886 887 888 889 890
                activity.resultant_state = None
            else:
                activity.resultant_state = 'ERROR'

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

891
        with instance_activity(code_suffix='shutdown', instance=self,
892
                               on_abort=__on_abort, on_commit=__on_commit,
893 894
                               task_uuid=task_uuid, user=user):
            queue_name = self.get_remote_queue_name('vm')
895 896
            logger.debug("RPC Shutdown at queue: %s, for vm: %s.",
                         self.vm_name, queue_name)
897
            vm_tasks.shutdown.apply_async(kwargs={'name': self.vm_name},
898 899
                                          queue=queue_name
                                          ).get(timeout=timeout)
900 901 902
            self.node = None
            self.vnc_port = None
            self.save()
Guba Sándor committed
903

904 905
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
906
        """
907 908
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
909

910
    def reset(self, user=None, task_uuid=None, timeout=5):
911 912
        """Reset virtual machine (reset button)
        """
913 914
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
915

916
            queue_name = self.get_remote_queue_name('vm')
917 918 919
            vm_tasks.reset.apply_async(args=[self.vm_name],
                                       queue=queue_name
                                       ).get(timeout=timeout)
Guba Sándor committed
920

921 922
    def reset_async(self, user=None):
        """Execute reset asynchronously.
923
        """
924 925
        return local_tasks.reset.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
926

927
    def reboot(self, user=None, task_uuid=None, timeout=5):
Dudás Ádám committed
928
        """Reboot virtual machine with Ctrl+Alt+Del signal.
929
        """
930 931
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
932

933 934
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
935 936
                                        queue=queue_name
                                        ).get(timeout=timeout)
937

938
    def reboot_async(self, user=None):
939
        """Execute reboot asynchronously. """
940 941
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
942

943 944 945 946 947
    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")

948
    def migrate(self, to_node, user=None, task_uuid=None, timeout=120):
949 950 951 952 953 954
        """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():
955
                    net.destroy(delete_host=False)
956 957 958 959 960

            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],
961 962
                                             queue=queue_name
                                             ).get(timeout=timeout)
963 964 965 966 967 968 969 970
            # 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()

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
    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)
987 988

        def __try_save_disk(disk):
989
            try:
990
                return disk.save_as()  # can do in parallel
991
            except Disk.WrongDiskTypeError:
992
                return disk
993

994 995 996
        # copy disks
        disks = [__try_save_disk(disk) for disk in self.disks.all()]
        kwargs.setdefault('disks', disks)
997

998 999
        # create template and do additional setup
        tmpl = InstanceTemplate(**kwargs)
1000

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
        # save template
        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
1012 1013 1014 1015 1016

    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)