models.py 38.7 KB
Newer Older
1
from contextlib import contextmanager
2
from datetime import timedelta
3
from importlib import import_module
4
from logging import getLogger
Dudás Ádám committed
5
from netaddr import EUI, mac_unix
6

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

17
from celery.exceptions import TimeoutError
18
from model_utils.models import TimeStampedModel
19
from taggit.managers import TaggableManager
20

Dudás Ádám committed
21
from acl.models import AclBase
22
from common.models import ActivityModel, activitycontextimpl, method_cache
23 24
from firewall.models import Vlan, Host
from storage.models import Disk
25
from .tasks import local_tasks, vm_tasks, net_tasks
26

27
logger = getLogger(__name__)
28
pwgen = User.objects.make_random_password
29
scheduler = import_module(name=django.conf.settings.VM_SCHEDULER)
30
ACCESS_PROTOCOLS = django.conf.settings.VM_ACCESS_PROTOCOLS
Őry Máté committed
31 32 33 34
ACCESS_METHODS = [(key, name) for key, (name, port, transport)
                  in ACCESS_PROTOCOLS.iteritems()]
ARCHITECTURES = (('x86_64', 'x86-64 (64 bit)'),
                 ('i686', 'x86 (32 bit)'))
35
VNC_PORT_RANGE = (2000, 65536)  # inclusive start, exclusive end
36

37 38 39
pre_state_changed = Signal(providing_args=["new_state"])
post_state_changed = Signal(providing_args=["new_state"])

40

41 42 43 44 45 46
class InstanceActiveManager(Manager):
    def get_query_set(self):
        return super(InstanceActiveManager,
                     self).get_query_set().filter(destroyed=None)


Őry Máté committed
47
class BaseResourceConfigModel(Model):
tarokkk committed
48

49
    """Abstract base for models with base resource configuration parameters.
50
    """
Őry Máté committed
51 52 53 54 55 56 57 58 59 60 61 62
    num_cores = IntegerField(verbose_name=_('number of cores'),
                             help_text=_('Number of virtual CPU cores '
                                         'available to the virtual machine.'))
    ram_size = IntegerField(verbose_name=_('RAM size'),
                            help_text=_('Mebibytes of memory.'))
    max_ram_size = IntegerField(verbose_name=_('maximal RAM size'),
                                help_text=_('Upper memory size limit '
                                            'for balloning.'))
    arch = CharField(max_length=10, verbose_name=_('architecture'),
                     choices=ARCHITECTURES)
    priority = IntegerField(verbose_name=_('priority'),
                            help_text=_('CPU priority.'))
63 64 65 66 67 68

    class Meta:
        abstract = True


class NamedBaseResourceConfig(BaseResourceConfigModel, TimeStampedModel):
tarokkk committed
69

70 71
    """Pre-created, named base resource configurations.
    """
Őry Máté committed
72 73 74
    name = CharField(max_length=50, unique=True,
                     verbose_name=_('name'), help_text=
                     _('Name of base resource configuration.'))
75 76 77 78 79

    def __unicode__(self):
        return self.name


Dudás Ádám committed
80 81 82 83 84 85 86
class Trait(Model):
    name = CharField(max_length=50, verbose_name=_('name'))

    def __unicode__(self):
        return self.name


87
class VirtualMachineDescModel(BaseResourceConfigModel):
88

89 90 91 92 93 94 95 96 97 98
    """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.'))
    raw_data = TextField(verbose_name=_('raw_data'), blank=True, help_text=_(
        'Additional libvirt domain parameters in XML format.'))
Dudás Ádám committed
99 100 101 102 103
    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
104
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
105 106 107 108 109

    class Meta:
        abstract = True


110
class Node(TimeStampedModel):
tarokkk committed
111

Őry Máté committed
112
    """A VM host machine, a hypervisor.
113
    """
Őry Máté committed
114 115 116 117 118 119 120 121 122 123
    name = CharField(max_length=50, unique=True,
                     verbose_name=_('name'),
                     help_text=_('Human readable name of node.'))
    priority = IntegerField(verbose_name=_('priority'),
                            help_text=_('Node usage priority.'))
    host = ForeignKey(Host, verbose_name=_('host'),
                      help_text=_('Host in firewall.'))
    enabled = BooleanField(verbose_name=_('enabled'), default=False,
                           help_text=_('Indicates whether the node can '
                                       'be used for hosting.'))
Dudás Ádám committed
124 125 126
    traits = ManyToManyField(Trait, blank=True,
                             help_text=_("Declared traits."),
                             verbose_name=_('traits'))
Dudás Ádám committed
127
    tags = TaggableManager(blank=True, verbose_name=_("tags"))
128 129 130
    overcommit = FloatField(default=1.0, verbose_name=_("overcommit ratio"),
                            help_text=_("The ratio of total memory with "
                                        "to without overcommit."))
131 132 133 134 135

    class Meta:
        permissions = ()

    @property
136
    @method_cache(10, 5)
137
    def online(self):
138

Őry Máté committed
139
        return self.remote_query(vm_tasks.get_core_num, timeout=1,
140
                                 default=False)
141

142 143 144 145 146
    @property
    @method_cache(300)
    def num_cores(self):
        """Number of CPU threads available to the virtual machines."""

Őry Máté committed
147
        return self.remote_query(vm_tasks.get_core_num)
148 149 150 151 152 153 154 155

    @property
    @method_cache(300)
    def ram_size(self):
        """Bytes of total memory in the node."""

        return self.remote_query(vm_tasks.get_ram_size)

156 157 158 159 160 161
    @property
    def ram_size_with_overcommit(self):
        """Bytes of total memory including overcommit margin.
        """
        return self.ram_size * self.overcommit

162 163 164
    def get_remote_queue_name(self, queue_id):
        return self.host.hostname + "." + queue_id

Guba Sándor committed
165
    def remote_query(self, task, timeout=30, raise_=False, default=None):
166 167 168 169 170
        """Query the given task, and get the result.

        If the result is not ready in timeout secs, return default value or
        raise a TimeoutError."""
        r = task.apply_async(
171
            queue=self.get_remote_queue_name('vm'), expires=timeout + 60)
172 173 174 175 176 177 178 179
        try:
            return r.get(timeout=timeout)
        except TimeoutError:
            if raise_:
                raise
            else:
                return default

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
    def update_vm_states(self):
        domains = {}
        for i in self.remote_query(vm_tasks.list_domains_info, timeout=5):
            # [{'name': 'cloud-1234', 'state': 'RUNNING', ...}, ...]
            try:
                id = int(i['name'].split('-')[1])
            except:
                pass  # name format doesn't match
            else:
                domains[id] = i['state']

        instances = self.instance_set.order_by('id').values('id', 'state')
        for i in instances:
            try:
                d = domains[i['id']]
            except KeyError:
                logger.info('Node %s update: instance %s missing from '
                            'libvirt', self, i['id'])
            else:
                if d != i['state']:
                    logger.info('Node %s update: instance %s state changed '
                                '(libvirt: %s, db: %s)',
                                self, i['id'], d, i['state'])
                    Instance.objects.get(id=i['id']).state_changed(d)

                del domains[i['id']]
        for i in domains.keys():
            logger.info('Node %s update: domain %s in libvirt but not in db.',
                        self, i)

210 211 212
    def __unicode__(self):
        return self.name

213

214 215 216 217
class NodeActivity(ActivityModel):
    node = ForeignKey(Node, related_name='activity_log',
                      help_text=_('Node this activity works on.'),
                      verbose_name=_('node'))
218

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    @classmethod
    def create(cls, code_suffix, node, task_uuid=None, user=None):
        act = cls(activity_code='vm.Node.' + code_suffix,
                  node=node, parent=None, started=timezone.now(),
                  task_uuid=task_uuid, user=user)
        act.save()
        return act

    def create_sub(self, code_suffix, task_uuid=None):
        act = NodeActivity(
            activity_code=self.activity_code + '.' + code_suffix,
            node=self.node, parent=self, started=timezone.now(),
            task_uuid=task_uuid, user=self.user)
        act.save()
        return act

    @contextmanager
    def sub_activity(self, code_suffix, task_uuid=None):
        act = self.create_sub(code_suffix, task_uuid)
238
        return activitycontextimpl(act)
239 240 241 242 243


@contextmanager
def node_activity(code_suffix, node, task_uuid=None, user=None):
    act = InstanceActivity.create(code_suffix, node, task_uuid, user)
244
    return activitycontextimpl(act)
245

Őry Máté committed
246 247

class Lease(Model):
tarokkk committed
248

249 250 251 252 253
    """Lease times for VM instances.

    Specifies a time duration until suspension and deletion of a VM
    instance.
    """
Őry Máté committed
254 255 256 257
    name = CharField(max_length=100, unique=True,
                     verbose_name=_('name'))
    suspend_interval_seconds = IntegerField(verbose_name=_('suspend interval'))
    delete_interval_seconds = IntegerField(verbose_name=_('delete interval'))
258

259 260 261
    class Meta:
        ordering = ['name', ]

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
    @property
    def suspend_interval(self):
        return timedelta(seconds=self.suspend_interval_seconds)

    @suspend_interval.setter
    def suspend_interval(self, value):
        self.suspend_interval_seconds = value.seconds

    @property
    def delete_interval(self):
        return timedelta(seconds=self.delete_interval_seconds)

    @delete_interval.setter
    def delete_interval(self, value):
        self.delete_interval_seconds = value.seconds

278 279 280
    def __unicode__(self):
        return self.name

281

282
class InstanceTemplate(VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
283

284 285 286 287 288 289 290 291 292 293 294 295 296 297
    """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
    """
Őry Máté committed
298
    STATES = [('NEW', _('new')),        # template has just been created
299
              ('SAVING', _('saving')),  # changes are being saved
Őry Máté committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
              ('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.'))
    lease = ForeignKey(Lease, related_name='template_set',
                       verbose_name=_('lease'),
                       help_text=_('Expiration times.'))
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339

    class Meta:
        ordering = ['name', ]
        permissions = ()
        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.
        """
        return self.instance_set.filter(state='RUNNING').count()

    @property
    def os_type(self):
        """Get the type of the template's operating system.
        """
        if self.access_method == 'rdp':
340
            return 'win'
341
        else:
342
            return 'linux'
343 344


Őry Máté committed
345
class InterfaceTemplate(Model):
tarokkk committed
346

347 348 349 350
    """Network interface template for an instance template.

    If the interface is managed, a host will be created for it.
    """
Őry Máté committed
351 352 353 354 355 356 357
    vlan = ForeignKey(Vlan, verbose_name=_('vlan'),
                      help_text=_('Network the interface belongs to.'))
    managed = BooleanField(verbose_name=_('managed'), default=True,
                           help_text=_('If a firewall host (i.e. IP address '
                                       'association) should be generated.'))
    template = ForeignKey(InstanceTemplate, verbose_name=_('template'),
                          related_name='interface_set',
358 359
                          help_text=_('Template the interface '
                                      'template belongs to.'))
360 361 362 363 364 365 366

    class Meta:
        permissions = ()
        verbose_name = _('interface template')
        verbose_name_plural = _('interface templates')


367
class Instance(AclBase, VirtualMachineDescModel, TimeStampedModel):
tarokkk committed
368

369 370 371 372 373 374 375 376 377 378 379
    """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
380
      * current state (libvirt domain state)
381 382
      * time of creation and last modification
      * base resource configuration values
383
      * owner and privilege information
384 385 386 387 388 389 390 391 392
    """
    STATES = [('NOSTATE', _('nostate')),
              ('RUNNING', _('running')),
              ('BLOCKED', _('blocked')),
              ('PAUSED', _('paused')),
              ('SHUTDOWN', _('shutdown')),
              ('SHUTOFF', _('shutoff')),
              ('CRASHED', _('crashed')),
              ('PMSUSPENDED', _('pmsuspended'))]  # libvirt domain states
393 394 395 396 397
    ACL_LEVELS = (
        ('user', _('user')),          # see all details
        ('operator', _('operator')),  # console, networking, change state
        ('owner', _('owner')),        # superuser, can delete, delegate perms
    )
Őry Máté committed
398
    name = CharField(blank=True, max_length=100, verbose_name=_('name'),
399
                     help_text=_("Human readable name of instance."))
Őry Máté committed
400 401 402
    description = TextField(blank=True, verbose_name=_('description'))
    template = ForeignKey(InstanceTemplate, blank=True, null=True,
                          related_name='instance_set',
403
                          help_text=_("Template the instance derives from."),
Őry Máté committed
404
                          verbose_name=_('template'))
405
    pw = CharField(help_text=_("Original password of the instance."),
Őry Máté committed
406 407 408
                   max_length=20, verbose_name=_('password'))
    time_of_suspend = DateTimeField(blank=True, default=None, null=True,
                                    verbose_name=_('time of suspend'),
409 410
                                    help_text=_("Proposed time of automatic "
                                                "suspension."))
Őry Máté committed
411 412
    time_of_delete = DateTimeField(blank=True, default=None, null=True,
                                   verbose_name=_('time of delete'),
413 414
                                   help_text=_("Proposed time of automatic "
                                               "deletion."))
Őry Máté committed
415
    active_since = DateTimeField(blank=True, null=True,
416 417
                                 help_text=_("Time stamp of successful "
                                             "boot report."),
Őry Máté committed
418 419 420
                                 verbose_name=_('active since'))
    node = ForeignKey(Node, blank=True, null=True,
                      related_name='instance_set',
421
                      help_text=_("Current hypervisor of this instance."),
Őry Máté committed
422 423 424
                      verbose_name=_('host node'))
    state = CharField(choices=STATES, default='NOSTATE', max_length=20)
    disks = ManyToManyField(Disk, related_name='instance_set',
425
                            help_text=_("Set of mounted disks."),
Őry Máté committed
426
                            verbose_name=_('disks'))
427
    lease = ForeignKey(Lease, help_text=_("Preferred expiration periods."))
428 429 430
    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
431
    owner = ForeignKey(User)
Dudás Ádám committed
432
    destroyed = DateTimeField(blank=True, null=True,
433 434
                              help_text=_("The virtual machine's time of "
                                          "destruction."))
435 436
    objects = Manager()
    active = InstanceActiveManager()
437 438 439 440 441 442 443

    class Meta:
        ordering = ['pk', ]
        verbose_name = _('instance')
        verbose_name_plural = _('instances')

    def __unicode__(self):
444 445
        parts = [self.name, "(" + str(self.id) + ")"]
        return " ".join([s for s in parts if s != ""])
446

447 448 449 450 451
    def clean(self, *args, **kwargs):
        if self.time_of_delete is None:
            self.renew(which='delete')
        super(Instance, self).clean(*args, **kwargs)

452
    @classmethod
453
    def create_from_template(cls, template, owner, disks=None, networks=None,
Dudás Ádám committed
454
                             req_traits=None, tags=None, **kwargs):
455 456 457 458 459
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
460
        disks = template.disks.all() if disks is None else disks
461

462 463 464
        networks = (template.interface_set.all() if networks is None
                    else networks)

Dudás Ádám committed
465 466 467
        req_traits = (template.req_traits.all() if req_traits is None
                      else req_traits)

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

470
        # prepare parameters
Dudás Ádám committed
471 472 473 474 475 476 477
        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

478
        # create instance and do additional setup
Dudás Ádám committed
479 480
        inst = cls(**params)

481
        # save instance
482
        inst.clean()
483
        inst.save()
Dudás Ádám committed
484

485
        # create related entities
Dudás Ádám committed
486
        inst.disks.add(*[disk.get_exclusive() for disk in disks])
487

488
        for net in networks:
489 490
            i = Interface.create(instance=inst, vlan=net.vlan, owner=owner,
                                 managed=net.managed)
491 492
            if i.host:
                i.host.enable_net()
493 494 495
                port, proto = ACCESS_PROTOCOLS[i.instance.access_method][1:3]
                # TODO fix this port fw
                i.host.add_port(proto, private=port)
496

Dudás Ádám committed
497
        inst.req_traits.add(*req_traits)
Dudás Ádám committed
498 499
        inst.tags.add(*tags)

500 501
        return inst

Őry Máté committed
502
    @permalink
503
    def get_absolute_url(self):
504
        return ('dashboard.views.detail', None, {'pk': self.id})
505 506

    @property
507 508 509 510 511 512 513 514 515
    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
516 517 518 519 520 521
    def mem_dump(self):
        """Return the path for the memory dump.

        It is always on the first hard drive storage named cloud-<id>.dump
        """
        path = self.disks.all()[0].datastore.path
Dudás Ádám committed
522
        return path + '/' + self.vm_name + '.dump'
523 524

    @property
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
    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):
540 541
        """Primary IPv4 address of the instance.
        """
542 543 544 545
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
546 547
        """Primary IPv6 address of the instance.
        """
548 549 550 551
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
552 553
        """Primary MAC address of the instance.
        """
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
        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.
        """
576
        return self.activity_log.filter(finished__isnull=True).exists()
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591

    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.
        """
592
        if not self.interface_set.exclude(host=None):
593 594
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
595 596
        return self.interface_set.exclude(host=None)[0].host.get_hostname(
            proto=proto)
597 598 599 600 601 602 603 604 605 606

    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'
607 608 609
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
610 611 612
        except:
            return

tarokkk committed
613 614
    def get_vm_desc(self):
        return {
615
            'name': self.vm_name,
616
            'vcpu': self.num_cores,
617
            'memory': int(self.ram_size) * 1024,  # convert from MiB to KiB
Őry Máté committed
618
            'memory_max': int(self.max_ram_size) * 1024,  # convert MiB to KiB
619 620 621 622 623
            '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()],
624 625 626 627 628
            '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
629
                'port': self.vnc_port
630
            },
631
            'boot_token': signing.dumps(self.id, salt='activate'),
Guba Sándor committed
632
            'raw_data': "" if not self.raw_data else self.raw_data
633
        }
tarokkk committed
634

635 636 637 638
    def get_remote_queue_name(self, queue_id):
        """Get the remote worker queue name of this instance with the specified
           queue ID.
        """
639
        return self.node.get_remote_queue_name(queue_id)
640

Dudás Ádám committed
641 642 643 644 645 646 647 648 649 650 651
    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()

652
    def deploy(self, user=None, task_uuid=None):
Dudás Ádám committed
653 654 655 656 657 658 659 660 661 662 663
        """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
664
        """
665 666
        with instance_activity(code_suffix='deploy', instance=self,
                               task_uuid=task_uuid, user=user) as act:
667

668 669 670 671 672 673 674 675 676 677
            # Find unused port for VNC
            if self.vnc_port is None:
                used = Instance.objects.values_list('vnc_port', flat=True)
                for p in xrange(*VNC_PORT_RANGE):
                    if p not in used:
                        self.vnc_port = p
                        break
                else:
                    raise Exception("No unused port could be found for VNC.")

678
            # Schedule
679 680
            if self.node is None:
                self.node = scheduler.get_node(self, Node.objects.all())
681
            self.save()
tarokkk committed
682

683 684 685 686
            # Deploy virtual images
            with act.sub_activity('deploying_disks'):
                for disk in self.disks.all():
                    disk.deploy()
687

688 689 690
            queue_name = self.get_remote_queue_name('vm')
            # Deploy VM on remote machine
            with act.sub_activity('deploying_vm'):
691
                vm_tasks.deploy.apply_async(args=[self.get_vm_desc()],
692
                                            queue=queue_name).get()
tarokkk committed
693

694 695 696 697
            # Estabilish network connection (vmdriver)
            with act.sub_activity('deploying_net'):
                for net in self.interface_set.all():
                    net.deploy()
tarokkk committed
698

699 700 701
            # Generate context
            # TODO

702 703 704 705
            # Resume vm
            with act.sub_activity('booting'):
                vm_tasks.resume.apply_async(args=[self.vm_name],
                                            queue=queue_name).get()
706

707 708
            self.renew('suspend')

709 710 711
    def deploy_async(self, user=None):
        """Execute deploy asynchronously.
        """
712 713
        logger.debug('Calling async local_tasks.deploy(%s, %s)',
                     unicode(self), unicode(user))
714 715
        return local_tasks.deploy.apply_async(args=[self, user],
                                              queue="localhost.man")
716

717
    def destroy(self, user=None, task_uuid=None):
Dudás Ádám committed
718 719 720 721 722 723 724 725 726 727 728
        """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
729
        """
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
        with instance_activity(code_suffix='destroy', 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()

            # 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()

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

749 750 751 752
            # Clear node and VNC port association
            self.node = None
            self.vnc_port = None

Dudás Ádám committed
753
            self.destroyed = timezone.now()
754
            self.save()
755 756

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

    def sleep(self, user=None, task_uuid=None):
        """Suspend virtual machine with memory dump.
        """
765 766
        with instance_activity(code_suffix='sleep', instance=self,
                               task_uuid=task_uuid, user=user):
767

768 769 770
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.sleep.apply_async(args=[self.vm_name, self.mem_dump],
                                       queue=queue_name).get()
Guba Sándor committed
771

772
    def sleep_async(self, user=None):
Dudás Ádám committed
773
        """Execute sleep asynchronously.
774
        """
775 776
        return local_tasks.sleep.apply_async(args=[self, user],
                                             queue="localhost.man")
Guba Sándor committed
777

778
    def wake_up(self, user=None, task_uuid=None):
779 780
        with instance_activity(code_suffix='wake_up', instance=self,
                               task_uuid=task_uuid, user=user):
781

782 783 784
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.resume.apply_async(args=[self.vm_name, self.dump_mem],
                                        queue=queue_name).get()
785

786
    def wake_up_async(self, user=None):
Dudás Ádám committed
787
        """Execute wake_up asynchronously.
788
        """
789 790
        return local_tasks.wake_up.apply_async(args=[self, user],
                                               queue="localhost.man")
791

792 793 794
    def shutdown(self, user=None, task_uuid=None):
        """Shutdown virtual machine with ACPI signal.
        """
795 796
        with instance_activity(code_suffix='shutdown', instance=self,
                               task_uuid=task_uuid, user=user):
797

798 799 800
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.shutdown.apply_async(args=[self.vm_name],
                                          queue=queue_name).get()
Guba Sándor committed
801

802 803
    def shutdown_async(self, user=None):
        """Execute shutdown asynchronously.
804
        """
805 806
        return local_tasks.shutdown.apply_async(args=[self, user],
                                                queue="localhost.man")
Guba Sándor committed
807

808 809 810
    def reset(self, user=None, task_uuid=None):
        """Reset virtual machine (reset button)
        """
811 812
        with instance_activity(code_suffix='reset', instance=self,
                               task_uuid=task_uuid, user=user):
813

814 815 816
            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
817

818 819
    def reset_async(self, user=None):
        """Execute reset asynchronously.
820
        """
821 822
        return local_tasks.restart.apply_async(args=[self, user],
                                               queue="localhost.man")
Guba Sándor committed
823

824
    def reboot(self, user=None, task_uuid=None):
Dudás Ádám committed
825
        """Reboot virtual machine with Ctrl+Alt+Del signal.
826
        """
827 828
        with instance_activity(code_suffix='reboot', instance=self,
                               task_uuid=task_uuid, user=user):
829

830 831 832
            queue_name = self.get_remote_queue_name('vm')
            vm_tasks.reboot.apply_async(args=[self.vm_name],
                                        queue=queue_name).get()
833

834
    def reboot_async(self, user=None):
835
        """Execute reboot asynchronously. """
836 837
        return local_tasks.reboot.apply_async(args=[self, user],
                                              queue="localhost.man")
838

839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
    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()

866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
    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
tarokkk committed
899

900 901 902 903
    def state_changed(self, new_state):
        logger.debug('Instance %s state changed '
                     '(db: %s, new: %s)',
                     self, self.state, new_state)
904 905 906 907 908 909 910 911 912
        try:
            pre_state_changed.send(sender=self, new_state=new_state)
        except Exception as e:
            logger.info('Instance %s state change ignored: %s',
                        unicode(self), unicode(e))
        else:
            self.state = new_state
            self.save()
            post_state_changed.send(sender=self, new_state=new_state)
913

914

915 916 917 918 919
class InstanceActivity(ActivityModel):
    instance = ForeignKey(Instance, related_name='activity_log',
                          help_text=_('Instance this activity works on.'),
                          verbose_name=_('instance'))

920 921 922
    class Meta:
        ordering = ['-started', 'instance', '-id']

923 924
    def __unicode__(self):
        if self.parent:
Őry Máté committed
925
            return '{}({})->{}'.format(self.parent.activity_code,
926
                                       self.instance,
Őry Máté committed
927
                                       self.activity_code)
928
        else:
Őry Máté committed
929
            return '{}({})'.format(self.activity_code,
930
                                   self.instance)
931

932 933 934
    def get_readable_name(self):
        return self.activity_code.split('.')[-1].replace('_', ' ').capitalize()

935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    @classmethod
    def create(cls, code_suffix, instance, task_uuid=None, user=None):
        act = cls(activity_code='vm.Instance.' + code_suffix,
                  instance=instance, parent=None, started=timezone.now(),
                  task_uuid=task_uuid, user=user)
        act.save()
        return act

    def create_sub(self, code_suffix, task_uuid=None):
        act = InstanceActivity(
            activity_code=self.activity_code + '.' + code_suffix,
            instance=self.instance, parent=self, started=timezone.now(),
            task_uuid=task_uuid, user=self.user)
        act.save()
        return act

    @contextmanager
    def sub_activity(self, code_suffix, task_uuid=None):
        act = self.create_sub(code_suffix, task_uuid)
954
        return activitycontextimpl(act)
955 956 957 958 959


@contextmanager
def instance_activity(code_suffix, instance, task_uuid=None, user=None):
    act = InstanceActivity.create(code_suffix, instance, task_uuid, user)
960
    return activitycontextimpl(act)
tarokkk committed
961

962

Őry Máté committed
963
class Interface(Model):
964 965 966

    """Network interface for an instance.
    """
Őry Máté committed
967 968 969 970 971
    vlan = ForeignKey(Vlan, verbose_name=_('vlan'),
                      related_name="vm_interface")
    host = ForeignKey(Host, verbose_name=_('host'),  blank=True, null=True)
    instance = ForeignKey(Instance, verbose_name=_('instance'),
                          related_name='interface_set')
972

973 974 975
    def __unicode__(self):
        return 'cloud-' + str(self.instance.id) + '-' + str(self.vlan.vid)

976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
    @property
    def mac(self):
        try:
            return self.host.mac
        except:
            return Interface.generate_mac(self.instance, self.vlan)

    @classmethod
    def generate_mac(cls, instance, vlan):
        """Generate MAC address for a VM instance on a VLAN.
        """
        # MAC 02:XX:XX:XX:XX:XX
        #        \________/\__/
        #           VM ID   VLAN ID
        i = instance.id & 0xfffffff
        v = vlan.vid & 0xfff
        m = (0x02 << 40) | (i << 12) | v
993
        return EUI(m, dialect=mac_unix)
994 995 996

    def get_vmnetwork_desc(self):
        return {
Dudás Ádám committed
997
            'name': self.__unicode__(),
998
            'bridge': 'cloud',
999
            'mac': str(self.mac),
1000 1001
            'ipv4': str(self.host.ipv4) if self.host is not None else None,
            'ipv6': str(self.host.ipv6) if self.host is not None else None,
1002 1003 1004 1005
            'vlan': self.vlan.vid,
            'managed': self.host is not None
        }

1006 1007 1008
    def deploy(self, user=None, task_uuid=None):
        net_tasks.create.apply_async(
            args=[self.get_vmnetwork_desc()],
1009
            queue=self.instance.get_remote_queue_name('net'))
1010

1011 1012
    def destroy(self, user=None, task_uuid=None):
        net_tasks.destroy.apply_async(
1013
            args=[self.get_vmnetwork_desc()],
1014
            queue=self.instance.get_remote_queue_name('net'))
Guba Sándor committed
1015

1016
    @classmethod
1017 1018
    def create(cls, instance, vlan, managed, owner=None):
        """Create a new interface for a VM instance to the specified VLAN.
1019
        """
1020
        if managed:
1021
            host = Host()
1022
            host.vlan = vlan
1023
            # TODO change Host's mac field's type to EUI in firewall
1024
            host.mac = str(cls.generate_mac(instance, vlan))
1025
            host.hostname = instance.vm_name
1026
            # Get adresses from firewall
1027
            addresses = vlan.get_new_address()
1028 1029
            host.ipv4 = addresses['ipv4']
            host.ipv6 = addresses['ipv6']
1030
            host.owner = owner
1031 1032 1033
            host.save()
        else:
            host = None
1034

1035
        iface = cls(vlan=vlan, host=host, instance=instance)
1036 1037
        iface.save()
        return iface
1038 1039 1040 1041 1042 1043 1044 1045

    def save_as_template(self, instance_template):
        """Create a template based on this interface.
        """
        i = InterfaceTemplate(vlan=self.vlan, managed=self.host is not None,
                              template=instance_template)
        i.save()
        return i