models.py 20.5 KB
Newer Older
1
from datetime import timedelta
tarokkk committed
2

3
import django.conf
Őry Máté committed
4
import logging
5 6 7 8 9 10 11
from django.contrib.auth.models import User
from django.db import models
from django.db.models.signals import pre_delete
from django.dispatch import receiver
from django.utils import timezone
from django.utils.translation import ugettext_lazy as _
from model_utils.models import TimeStampedModel
Őry Máté committed
12
from netaddr import EUI
13

Őry Máté committed
14
from . import tasks
15
from firewall.models import Vlan, Host
Guba Sándor committed
16
from manager import vm_manager, scheduler
17
from storage.models import Disk
18

19 20 21

logger = logging.getLogger(__name__)
pwgen = User.objects.make_random_password
22
ACCESS_PROTOCOLS = django.conf.settings.VM_ACCESS_PROTOCOLS
23 24 25 26
ACCESS_METHODS = [(k, ap[0]) for k, ap in ACCESS_PROTOCOLS.iteritems()]


class BaseResourceConfigModel(models.Model):
tarokkk committed
27

28 29 30 31 32 33 34 35 36
    """Abstract base class for models with base resource configuration
       parameters.
    """
    num_cores = models.IntegerField(help_text=_('Number of CPU cores.'))
    ram_size = models.IntegerField(help_text=_('Mebibytes of memory.'))
    max_ram_size = models.IntegerField(help_text=_('Upper memory size limit '
                                                   'for balloning.'))
    arch = models.CharField(max_length=10, verbose_name=_('architecture'))
    priority = models.IntegerField(help_text=_('instance priority'))
37
    boot_menu = models.BooleanField(default=False)
Guba Sándor committed
38
    raw_data = models.TextField(blank=True)
39 40 41 42 43 44

    class Meta:
        abstract = True


class NamedBaseResourceConfig(BaseResourceConfigModel, TimeStampedModel):
tarokkk committed
45

46 47 48 49 50 51 52 53 54 55
    """Pre-created, named base resource configurations.
    """
    name = models.CharField(max_length=50, unique=True,
                            verbose_name=_('name'))

    def __unicode__(self):
        return self.name


class Node(TimeStampedModel):
tarokkk committed
56

57 58
    """A VM host machine.
    """
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    name = models.CharField(max_length=50, unique=True,
                            verbose_name=_('name'))
    num_cores = models.IntegerField(help_text=_('Number of CPU cores.'))
    ram_size = models.IntegerField(help_text=_('Mebibytes of memory.'))
    priority = models.IntegerField(help_text=_('node usage priority'))
    host = models.ForeignKey(Host)
    enabled = models.BooleanField(default=False,
                                  help_text=_('Indicates whether the node can '
                                              'be used for hosting.'))

    class Meta:
        permissions = ()

    @property
    def online(self):
        """Indicates whether the node is connected and functional.
        """
        pass  # TODO implement check


79 80
class NodeActivity(TimeStampedModel):
    activity_code = models.CharField(max_length=100)
81 82
    task_uuid = models.CharField(blank=True, max_length=50, null=True,
                                 unique=True)
83 84 85 86 87 88 89
    node = models.ForeignKey(Node, related_name='activity_log')
    user = models.ForeignKey(User, blank=True, null=True)
    started = models.DateTimeField(blank=True, null=True)
    finished = models.DateTimeField(blank=True, null=True)
    result = models.TextField(blank=True, null=True)
    status = models.CharField(default='PENDING', max_length=50)

90

91
class Lease(models.Model):
tarokkk committed
92

93 94 95 96 97 98 99 100 101 102
    """Lease times for VM instances.

    Specifies a time duration until suspension and deletion of a VM
    instance.
    """
    name = models.CharField(max_length=100, unique=True,
                            verbose_name=_('name'))
    suspend_interval_seconds = models.IntegerField()
    delete_interval_seconds = models.IntegerField()

103 104 105
    class Meta:
        ordering = ['name', ]

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    @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


class InstanceTemplate(BaseResourceConfigModel, TimeStampedModel):
tarokkk committed
124

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
    """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
    """
    STATES = [('NEW', _('new')),  # template has just been created
              ('SAVING', _('saving')),  # changes are being saved
              ('READY', _('ready'))]  # template is ready for instantiation
    name = models.CharField(max_length=100, unique=True,
                            verbose_name=_('name'))
    description = models.TextField(verbose_name=_('description'),
                                   blank=True)
    parent = models.ForeignKey('self', null=True, blank=True,
                               verbose_name=_('parent template'))
    system = models.TextField(verbose_name=_('operating system'),
                              blank=True,
                              help_text=(_('Name of operating system in '
                                           'format like "%s".') %
                                         'Ubuntu 12.04 LTS Desktop amd64'))
    access_method = models.CharField(max_length=10, choices=ACCESS_METHODS,
                                     verbose_name=_('access method'))
    state = models.CharField(max_length=10, choices=STATES,
                             default='NEW')
    disks = models.ManyToManyField(Disk, verbose_name=_('disks'),
                                   related_name='template_set')
    lease = models.ForeignKey(Lease, related_name='template_set')

    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':
180
            return 'win'
181
        else:
182
            return 'linux'
183 184 185


class InterfaceTemplate(models.Model):
tarokkk committed
186

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    """Network interface template for an instance template.

    If the interface is managed, a host will be created for it.
    """
    vlan = models.ForeignKey(Vlan)
    managed = models.BooleanField(default=True)
    template = models.ForeignKey(InstanceTemplate,
                                 related_name='interface_set')

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


class Instance(BaseResourceConfigModel, TimeStampedModel):
tarokkk committed
203

204 205 206 207 208 209 210 211 212 213 214
    """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
215
      * current state (libvirt domain state)
216 217
      * time of creation and last modification
      * base resource configuration values
218
      * owner and privilege information
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
    """
    STATES = [('NOSTATE', _('nostate')),
              ('RUNNING', _('running')),
              ('BLOCKED', _('blocked')),
              ('PAUSED', _('paused')),
              ('SHUTDOWN', _('shutdown')),
              ('SHUTOFF', _('shutoff')),
              ('CRASHED', _('crashed')),
              ('PMSUSPENDED', _('pmsuspended'))]  # libvirt domain states
    name = models.CharField(blank=True, max_length=100, verbose_name=_('name'))
    description = models.TextField(blank=True, verbose_name=_('description'))
    template = models.ForeignKey(InstanceTemplate, blank=True, null=True,
                                 related_name='instance_set',
                                 verbose_name=_('template'))
    pw = models.CharField(help_text=_('Original password of instance'),
                          max_length=20, verbose_name=_('password'))
    time_of_suspend = models.DateTimeField(blank=True, default=None, null=True,
                                           verbose_name=_('time of suspend'))
    time_of_delete = models.DateTimeField(blank=True, default=None, null=True,
                                          verbose_name=_('time of delete'))
    active_since = models.DateTimeField(blank=True, null=True,
                                        help_text=_('Time stamp of successful '
                                                    'boot report.'),
                                        verbose_name=_('active since'))
    node = models.ForeignKey(Node, blank=True, null=True,
                             related_name='instance_set',
Guba Sándor committed
245
                             verbose_name=_('host node'))
246 247 248 249 250 251
    state = models.CharField(choices=STATES, default='NOSTATE', max_length=20)
    disks = models.ManyToManyField(Disk, related_name='instance_set',
                                   verbose_name=_('disks'))
    lease = models.ForeignKey(Lease)
    access_method = models.CharField(max_length=10, choices=ACCESS_METHODS,
                                     verbose_name=_('access method'))
252
    vnc_port = models.IntegerField()
253 254 255 256 257 258 259 260 261 262 263 264
    owner = models.ForeignKey(User)

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

    def __unicode__(self):
        return self.name

    @classmethod
265
    def create_from_template(cls, template, owner, **kwargs):
266 267 268 269 270 271 272
        """Create a new instance based on an InstanceTemplate.

        Can also specify parameters as keyword arguments which should override
        template settings.
        """
        # prepare parameters
        kwargs['template'] = template
273
        kwargs['owner'] = owner
274 275 276 277 278 279 280 281
        kwargs.setdefault('name', template.name)
        kwargs.setdefault('description', template.description)
        kwargs.setdefault('pw', pwgen())
        kwargs.setdefault('num_cores', template.num_cores)
        kwargs.setdefault('ram_size', template.ram_size)
        kwargs.setdefault('max_ram_size', template.max_ram_size)
        kwargs.setdefault('arch', template.arch)
        kwargs.setdefault('priority', template.priority)
282 283
        kwargs.setdefault('boot_menu', template.boot_menu)
        kwargs.setdefault('raw_data', template.raw_data)
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
        kwargs.setdefault('lease', template.lease)
        kwargs.setdefault('access_method', template.access_method)
        # create instance and do additional setup
        inst = cls(**kwargs)
        for disk in template.disks:
            inst.disks.add(disk.get_exclusive())
        # save instance
        inst.save()
        # create related entities
        for iftmpl in template.interface_set.all():
            i = Interface.create_from_template(instance=inst, template=iftmpl)
            if i.host:
                i.host.enable_net()
                port, proto = ACCESS_PROTOCOLS[i.access_method][1:3]
                i.host.add_port(proto, i.get_port(), port)

        return inst

    @models.permalink
    def get_absolute_url(self):
Bach Dániel committed
304
        return ('dashboard.views.detail', None, {'id': self.id})
305 306

    @property
307 308 309 310 311 312 313 314 315
    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
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
    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):
331 332
        """Primary IPv4 address of the instance.
        """
333 334 335 336
        return self.primary_host.ipv4 if self.primary_host else None

    @property
    def ipv6(self):
337 338
        """Primary IPv6 address of the instance.
        """
339 340 341 342
        return self.primary_host.ipv6 if self.primary_host else None

    @property
    def mac(self):
343 344
        """Primary MAC address of the instance.
        """
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
        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.
        """
367
        return self.activity_log.filter(finished__isnull=True).exists()
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

    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.
        """
        if not self.firewall_host:
            return _('None')
        proto = 'ipv6' if use_ipv6 else 'ipv4'
        return self.firewall_host.get_hostname(proto=proto)

    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'
397 398 399
            return ('%(proto)s:cloud:%(pw)s:%(host)s:%(port)d' %
                    {'port': port, 'proto': proto, 'pw': self.pw,
                     'host': host})
400 401 402
        except:
            return

tarokkk committed
403 404
    def get_vm_desc(self):
        return {
405
            'name': self.vm_name,
406 407 408 409 410 411 412 413
            'vcpu': self.num_cores,
            'memory': self.ram_size,
            'memory_max': self.max_ram_size,
            '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()],
414 415 416 417 418
            '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
419
                'port': self.vnc_port
420
            },
Guba Sándor committed
421
            'raw_data': "" if not self.raw_data else self.raw_data
422
        }
tarokkk committed
423

424 425 426
    def deploy_async(self, user=None):
        """ Launch celery task to handle the job asynchronously.
        """
Guba Sándor committed
427
        vm_manager.deploy.apply_async(self, user, queue="localhost.man")
tarokkk committed
428

429 430
    def deploy(self, user=None, task_uuid=None):
        """ Deploy new virtual machine with network
tarokkk committed
431
        1. Schedule
432 433 434 435 436 437
        """
        act = InstanceActivity(activity_code='vm.Instance.deploy',
                               instance=self, user=user,
                               started=timezone.now(), task_uuid=task_uuid)
        act.save()

tarokkk committed
438 439
        # Schedule
        act.update_state("PENDING")
Guba Sándor committed
440
        self.node = scheduler.get_node(self)
441
        self.save()
tarokkk committed
442 443 444

        # Create virtual images
        act.update_state("PREPARING DISKS")
445
        for disk in self.disks.all():
tarokkk committed
446 447 448 449
            disk.deploy()

        # Deploy VM on remote machine
        act.update_state("DEPLOYING VM")
Guba Sándor committed
450 451
        tasks.create.apply_async(args=[self.get_vm_desc()],
                                 queue=self.node.host.hostname + ".vm").get()
tarokkk committed
452 453 454 455 456 457 458 459

        # Estabilish network connection (vmdriver)
        act.update_state("DEPLOYING NET")
        for net in self.interface_set.all():
            net.deploy()

        # Resume vm
        act.update_state("BOOTING")
Guba Sándor committed
460 461
        tasks.resume.apply_async(args=[self.vm_name],
                                 queue=self.node + ".vm").get()
tarokkk committed
462

463
        act.finish(result='SUCCESS')
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517

    def stop(self):
        # TODO implement
        pass

    def resume(self):
        # TODO implement
        pass

    def poweroff(self):
        # TODO implement
        pass

    def restart(self):
        # TODO implement
        pass

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

    def save_as(self):
        """Save image and shut down."""
        imgname = "template-%d-%d" % (self.template.id, self.id)
        from .tasks import SaveAsTask
        SaveAsTask.delay(one_id=self.one_id, new_img=imgname)
        self._change_state("SHUTDOWN")
        self.save()
        t = self.template
        t.state = 'SAVING'
        t.save()

    def check_if_is_save_as_done(self):
        if self.state != 'DONE':
            return False
        Disk.update(delete=False)
        imgname = "template-%d-%d" % (self.template.id, self.id)
        disks = Disk.objects.filter(name=imgname)
        if len(disks) != 1:
            return False
        self.template.disk_id = disks[0].id
        self.template.state = 'READY'
        self.template.save()
        self.firewall_host_delete()
        return True


518
@receiver(pre_delete, sender=Instance, dispatch_uid='delete_instance_pre')
519 520 521 522 523
def delete_instance_pre(sender, instance, using, **kwargs):
    # TODO implement
    pass


524 525
class InstanceActivity(TimeStampedModel):
    activity_code = models.CharField(max_length=100)
526 527
    task_uuid = models.CharField(blank=True, max_length=50, null=True,
                                 unique=True)
528 529 530 531 532
    instance = models.ForeignKey(Instance, related_name='activity_log')
    user = models.ForeignKey(User, blank=True, null=True)
    started = models.DateTimeField(blank=True, null=True)
    finished = models.DateTimeField(blank=True, null=True)
    result = models.TextField(blank=True, null=True)
533
    state = models.CharField(default='PENDING', max_length=50)
tarokkk committed
534

535 536 537
    def update_state(self, new_state):
        self.state = new_state
        self.save()
tarokkk committed
538

539 540 541 542 543
    def finish(self, result=None):
        if not self.finished:
            self.finished = timezone.now()
            self.result = result
            self.save()
tarokkk committed
544

545

546 547 548 549 550 551 552 553
class Interface(models.Model):

    """Network interface for an instance.
    """
    vlan = models.ForeignKey(Vlan, related_name="vm_interface")
    host = models.ForeignKey(Host, blank=True, null=True)
    instance = models.ForeignKey(Instance, related_name='interface_set')

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
    @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
        return EUI(m)
572 573 574 575 576

    def get_vmnetwork_desc(self):
        return {
            'name': 'cloud-' + self.instance.id + '-' + self.vlan.vid,
            'bridge': 'cloud',
577
            'mac': self.mac,
578 579 580 581 582 583 584 585 586 587 588
            'ipv4': self.host.ipv4 if self.host is not None else None,
            'ipv6': self.host.ipv6 if self.host is not None else None,
            'vlan': self.vlan.vid,
            'managed': self.host is not None
        }

    @classmethod
    def create_from_template(cls, instance, template):
        """Create a new interface for an instance based on an
           InterfaceTemplate.
        """
589 590 591
        host = (Host(vlan=template.vlan, mac=cls.generate_mac(instance,
                                                              template.vlan))
                if template.managed else None)
592 593 594
        iface = cls(vlan=template.vlan, host=host, instance=instance)
        iface.save()
        return iface