operations.py 61.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright 2014 Budapest University of Technology and Economics (BME IK)
#
# This file is part of CIRCLE Cloud.
#
# CIRCLE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# CIRCLE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with CIRCLE.  If not, see <http://www.gnu.org/licenses/>.

18
from __future__ import absolute_import, unicode_literals
Bach Dániel committed
19 20
from base64 import encodestring
from hashlib import md5
Dudás Ádám committed
21
from logging import getLogger
Bach Dániel committed
22
import os
23
from re import search
Őry Máté committed
24
from string import ascii_lowercase
Bach Dániel committed
25 26 27
from StringIO import StringIO
from tarfile import TarFile, TarInfo
import time
Kálmán Viktor committed
28
from urlparse import urlsplit
Dudás Ádám committed
29

30
from django.core.exceptions import PermissionDenied, SuspiciousOperation
31
from django.core.urlresolvers import reverse
Dudás Ádám committed
32
from django.utils import timezone
33
from django.utils.translation import ugettext_lazy as _, ugettext_noop
Kálmán Viktor committed
34
from django.conf import settings
Bach Dániel committed
35
from django.db.models import Q
Dudás Ádám committed
36

37 38
from sizefield.utils import filesizeformat

39 40
from celery.contrib.abortable import AbortableAsyncResult
from celery.exceptions import TimeLimitExceeded, TimeoutError
41

42 43 44
from common.models import (
    create_readable, humanize_exception, HumanReadableException
)
45
from common.operations import Operation, register_operation, SubOperationMixin
Bach Dániel committed
46
from manager.scheduler import SchedulerError
47 48 49
from .tasks.local_tasks import (
    abortable_async_instance_operation, abortable_async_node_operation,
)
50
from .models import (
51
    Instance, InstanceActivity, InstanceTemplate, Interface, Node,
52
    NodeActivity, pwgen
53
)
Bach Dániel committed
54
from .tasks import agent_tasks, vm_tasks
Dudás Ádám committed
55

Kálmán Viktor committed
56
from dashboard.store_api import Store, NoStoreException
Bach Dániel committed
57 58
from firewall.models import Host
from monitor.client import Client
59
from storage.tasks import storage_tasks
Kálmán Viktor committed
60

Dudás Ádám committed
61
logger = getLogger(__name__)
62 63


64 65 66 67 68
class RemoteOperationMixin(object):

    remote_timeout = 30

    def _operation(self, **kwargs):
Őry Máté committed
69
        args = self._get_remote_args(**kwargs)
70 71 72 73 74 75 76 77 78
        return self.task.apply_async(
            args=args, queue=self._get_remote_queue()
        ).get(timeout=self.remote_timeout)

    def check_precond(self):
        super(RemoteOperationMixin, self).check_precond()
        self._get_remote_queue()


79 80 81 82 83 84 85
class AbortableRemoteOperationMixin(object):
    remote_step = property(lambda self: self.remote_timeout / 10)

    def _operation(self, task, **kwargs):
        args = self._get_remote_args(**kwargs),
        remote = self.task.apply_async(
            args=args, queue=self._get_remote_queue())
86
        for i in xrange(0, self.remote_timeout, self.remote_step):
87 88 89 90 91 92 93
            try:
                return remote.get(timeout=self.remote_step)
            except TimeoutError as e:
                if task is not None and task.is_aborted():
                    AbortableAsyncResult(remote.id).abort()
                    raise humanize_exception(ugettext_noop(
                        "Operation aborted by user."), e)
94
        raise TimeLimitExceeded()
95 96


97
class InstanceOperation(Operation):
98
    acl_level = 'owner'
99
    async_operation = abortable_async_instance_operation
100
    host_cls = Instance
101
    concurrency_check = True
102 103
    accept_states = None
    deny_states = None
104
    resultant_state = None
Dudás Ádám committed
105

106
    def __init__(self, instance):
107
        super(InstanceOperation, self).__init__(subject=instance)
108 109 110
        self.instance = instance

    def check_precond(self):
111 112
        if self.instance.destroyed_at:
            raise self.instance.InstanceDestroyedError(self.instance)
113 114 115 116 117 118 119 120 121 122 123 124 125 126
        if self.accept_states:
            if self.instance.status not in self.accept_states:
                logger.debug("precond failed for %s: %s not in %s",
                             unicode(self.__class__),
                             unicode(self.instance.status),
                             unicode(self.accept_states))
                raise self.instance.WrongStateError(self.instance)
        if self.deny_states:
            if self.instance.status in self.deny_states:
                logger.debug("precond failed for %s: %s in %s",
                             unicode(self.__class__),
                             unicode(self.instance.status),
                             unicode(self.accept_states))
                raise self.instance.WrongStateError(self.instance)
127 128

    def check_auth(self, user):
129
        if not self.instance.has_level(user, self.acl_level):
130 131 132
            raise humanize_exception(ugettext_noop(
                "%(acl_level)s level is required for this operation."),
                PermissionDenied(), acl_level=self.acl_level)
133

134
        super(InstanceOperation, self).check_auth(user=user)
135

136 137
    def create_activity(self, parent, user, kwargs):
        name = self.get_activity_name(kwargs)
138 139 140 141 142 143 144 145 146 147
        if parent:
            if parent.instance != self.instance:
                raise ValueError("The instance associated with the specified "
                                 "parent activity does not match the instance "
                                 "bound to the operation.")
            if parent.user != user:
                raise ValueError("The user associated with the specified "
                                 "parent activity does not match the user "
                                 "provided as parameter.")

148 149 150
            return parent.create_sub(
                code_suffix=self.get_activity_code_suffix(),
                readable_name=name, resultant_state=self.resultant_state)
151 152
        else:
            return InstanceActivity.create(
153 154
                code_suffix=self.get_activity_code_suffix(),
                instance=self.instance,
155
                readable_name=name, user=user,
156 157
                concurrency_check=self.concurrency_check,
                resultant_state=self.resultant_state)
158

159 160 161 162 163
    def is_preferred(self):
        """If this is the recommended op in the current state of the instance.
        """
        return False

164

165 166 167 168 169 170 171 172 173 174 175
class RemoteInstanceOperation(RemoteOperationMixin, InstanceOperation):

    remote_queue = ('vm', 'fast')

    def _get_remote_queue(self):
        return self.instance.get_remote_queue_name(*self.remote_queue)

    def _get_remote_args(self, **kwargs):
        return [self.instance.vm_name]


Bach Dániel committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
class EnsureAgentMixin(object):
    accept_states = ('RUNNING', )

    def check_precond(self):
        super(EnsureAgentMixin, self).check_precond()

        last_boot_time = self.instance.activity_log.filter(
            succeeded=True, activity_code__in=(
                "vm.Instance.deploy", "vm.Instance.reset",
                "vm.Instance.reboot")).latest("finished").finished

        try:
            InstanceActivity.objects.filter(
                activity_code="vm.Instance.agent.starting",
                started__gt=last_boot_time).latest("started")
        except InstanceActivity.DoesNotExist:  # no agent since last boot
            raise self.instance.NoAgentError(self.instance)


class RemoteAgentOperation(EnsureAgentMixin, RemoteInstanceOperation):
    remote_queue = ('agent', )
    concurrency_check = False


200
@register_operation
201 202 203 204 205
class AddInterfaceOperation(InstanceOperation):
    id = 'add_interface'
    name = _("add interface")
    description = _("Add a new network interface for the specified VLAN to "
                    "the VM.")
206
    required_perms = ()
207
    accept_states = ('STOPPED', 'PENDING', 'RUNNING')
208

209 210 211 212 213 214 215
    def rollback(self, net, activity):
        with activity.sub_activity(
            'destroying_net',
                readable_name=ugettext_noop("destroy network (rollback)")):
            net.destroy()
            net.delete()

216
    def _operation(self, activity, user, system, vlan, managed=None):
217
        if not vlan.has_level(user, 'user'):
218 219 220
            raise humanize_exception(ugettext_noop(
                "User acces to vlan %(vlan)s is required."),
                PermissionDenied(), vlan=vlan)
221 222 223 224 225 226 227
        if managed is None:
            managed = vlan.managed

        net = Interface.create(base_activity=activity, instance=self.instance,
                               managed=managed, owner=user, vlan=vlan)

        if self.instance.is_running:
228
            try:
229 230
                self.instance._attach_network(
                    interface=net, parent_activity=activity)
231 232 233 234
            except Exception as e:
                if hasattr(e, 'libvirtError'):
                    self.rollback(net, activity)
                raise
235
            net.deploy()
Bach Dániel committed
236 237
            self.instance._change_ip(parent_activity=activity)
            self.instance._restart_networking(parent_activity=activity)
238

239 240 241 242
    def get_activity_name(self, kwargs):
        return create_readable(ugettext_noop("add %(vlan)s interface"),
                               vlan=kwargs['vlan'])

243

244
@register_operation
245
class CreateDiskOperation(InstanceOperation):
246

247 248
    id = 'create_disk'
    name = _("create disk")
249
    description = _("Create and attach empty disk to the virtual machine.")
250
    required_perms = ('storage.create_empty_disk', )
251
    accept_states = ('STOPPED', 'PENDING', 'RUNNING')
252

253
    def _operation(self, user, size, activity, name=None):
Bach Dániel committed
254 255
        from storage.models import Disk

256 257 258
        if not name:
            name = "new disk"
        disk = Disk.create(size=size, name=name, type="qcow2-norm")
259
        disk.full_clean()
260 261 262 263
        devnums = list(ascii_lowercase)
        for d in self.instance.disks.all():
            devnums.remove(d.dev_num)
        disk.dev_num = devnums.pop(0)
264
        disk.save()
265 266
        self.instance.disks.add(disk)

267
        if self.instance.is_running:
268 269 270 271
            with activity.sub_activity(
                'deploying_disk',
                readable_name=ugettext_noop("deploying disk")
            ):
272
                disk.deploy()
273
            self.instance._attach_disk(parent_activity=activity, disk=disk)
274

275
    def get_activity_name(self, kwargs):
276 277 278
        return create_readable(
            ugettext_noop("create disk %(name)s (%(size)s)"),
            size=filesizeformat(kwargs['size']), name=kwargs['name'])
279 280


281
@register_operation
282
class ResizeDiskOperation(RemoteInstanceOperation):
283 284 285 286 287

    id = 'resize_disk'
    name = _("resize disk")
    description = _("Resize the virtual disk image. "
                    "Size must be greater value than the actual size.")
288
    required_perms = ('storage.resize_disk', )
289 290
    accept_states = ('RUNNING', )
    async_queue = "localhost.man.slow"
291 292
    remote_queue = ('vm', 'slow')
    task = vm_tasks.resize_disk
293

294 295 296
    def _get_remote_args(self, disk, size, **kwargs):
        return (super(ResizeDiskOperation, self)
                ._get_remote_args(**kwargs) + [disk.path, size])
297 298 299 300 301 302

    def get_activity_name(self, kwargs):
        return create_readable(
            ugettext_noop("resize disk %(name)s to %(size)s"),
            size=filesizeformat(kwargs['size']), name=kwargs['disk'].name)

303 304 305 306 307
    def _operation(self, disk, size):
        super(ResizeDiskOperation, self)._operation(disk=disk, size=size)
        disk.size = size
        disk.save()

308

309
@register_operation
310 311 312
class DownloadDiskOperation(InstanceOperation):
    id = 'download_disk'
    name = _("download disk")
313 314 315 316
    description = _("Download and attach disk image (ISO file) for the "
                    "virtual machine. Most operating systems do not detect a "
                    "new optical drive, so you may have to reboot the "
                    "machine.")
317
    abortable = True
318
    has_percentage = True
319
    required_perms = ('storage.download_disk', )
320
    accept_states = ('STOPPED', 'PENDING', 'RUNNING')
321
    async_queue = "localhost.man.slow"
322

323
    def _operation(self, user, url, task, activity, name=None):
Bach Dániel committed
324 325
        from storage.models import Disk

326
        disk = Disk.download(url=url, name=name, task=task)
327 328 329 330
        devnums = list(ascii_lowercase)
        for d in self.instance.disks.all():
            devnums.remove(d.dev_num)
        disk.dev_num = devnums.pop(0)
331
        disk.full_clean()
332
        disk.save()
333
        self.instance.disks.add(disk)
334 335
        activity.readable_name = create_readable(
            ugettext_noop("download %(name)s"), name=disk.name)
336

337 338 339 340
        activity.result = create_readable(ugettext_noop(
            "Downloading %(url)s is finished. The file md5sum "
            "is: '%(checksum)s'."),
            url=url, checksum=disk.checksum)
Őry Máté committed
341
        # TODO iso (cd) hot-plug is not supported by kvm/guests
342
        if self.instance.is_running and disk.type not in ["iso"]:
343
            self.instance._attach_disk(parent_activity=activity, disk=disk)
344

345

346
@register_operation
347
class DeployOperation(InstanceOperation):
Dudás Ádám committed
348 349
    id = 'deploy'
    name = _("deploy")
350 351
    description = _("Deploy and start the virtual machine (including storage "
                    "and network configuration).")
352
    required_perms = ()
353
    deny_states = ('SUSPENDED', 'RUNNING')
354
    resultant_state = 'RUNNING'
Dudás Ádám committed
355

356 357
    def is_preferred(self):
        return self.instance.status in (self.instance.STATUS.STOPPED,
358
                                        self.instance.STATUS.PENDING,
359 360
                                        self.instance.STATUS.ERROR)

361 362 363
    def on_abort(self, activity, error):
        activity.resultant_state = 'STOPPED'

Dudás Ádám committed
364 365
    def on_commit(self, activity):
        activity.resultant_state = 'RUNNING'
366
        activity.result = create_readable(
Guba Sándor committed
367
            ugettext_noop("virtual machine successfully "
368 369
                          "deployed to node: %(node)s"),
            node=self.instance.node)
Dudás Ádám committed
370

371
    def _operation(self, activity, node=None):
Dudás Ádám committed
372 373
        # Allocate VNC port and host node
        self.instance.allocate_vnc_port()
374 375 376 377 378
        if node is not None:
            self.instance.node = node
            self.instance.save()
        else:
            self.instance.allocate_node()
Dudás Ádám committed
379 380

        # Deploy virtual images
381 382 383 384 385 386
        try:
            self.instance._deploy_disks(parent_activity=activity)
        except:
            self.instance.yield_node()
            self.instance.yield_vnc_port()
            raise
Dudás Ádám committed
387 388

        # Deploy VM on remote machine
389
        if self.instance.state not in ['PAUSED']:
390
            self.instance._deploy_vm(parent_activity=activity)
Dudás Ádám committed
391 392

        # Establish network connection (vmdriver)
393 394 395
        with activity.sub_activity(
            'deploying_net', readable_name=ugettext_noop(
                "deploy network")):
Dudás Ádám committed
396 397
            self.instance.deploy_net()

398 399 400 401 402
        try:
            self.instance.renew(parent_activity=activity)
        except:
            pass

403
        self.instance._resume_vm(parent_activity=activity)
Dudás Ádám committed
404

405 406 407
        if self.instance.has_agent:
            activity.sub_activity('os_boot', readable_name=ugettext_noop(
                "wait operating system loading"), interruptible=True)
Dudás Ádám committed
408

409
    @register_operation
Őry Máté committed
410
    class DeployVmOperation(SubOperationMixin, RemoteInstanceOperation):
411 412
        id = "_deploy_vm"
        name = _("deploy vm")
Őry Máté committed
413
        description = _("Deploy virtual machine.")
414 415 416
        remote_queue = ("vm", "slow")
        task = vm_tasks.deploy

Őry Máté committed
417
        def _get_remote_args(self, **kwargs):
418 419 420 421 422 423 424 425 426
            return [self.instance.get_vm_desc()]
            # intentionally not calling super

        def get_activity_name(self, kwargs):
            return create_readable(ugettext_noop("deploy virtual machine"),
                                   ugettext_noop("deploy vm to %(node)s"),
                                   node=self.instance.node)

    @register_operation
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
    class DeployDisksOperation(SubOperationMixin, InstanceOperation):
        id = "_deploy_disks"
        name = _("deploy disks")
        description = _("Deploy all associated disks.")

        def _operation(self):
            devnums = list(ascii_lowercase)  # a-z
            for disk in self.instance.disks.all():
                # 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
                disk.deploy()

444
    @register_operation
Őry Máté committed
445
    class ResumeVmOperation(SubOperationMixin, RemoteInstanceOperation):
446 447 448 449 450
        id = "_resume_vm"
        name = _("boot virtual machine")
        remote_queue = ("vm", "slow")
        task = vm_tasks.resume

Dudás Ádám committed
451

452
@register_operation
453
class DestroyOperation(InstanceOperation):
Dudás Ádám committed
454 455
    id = 'destroy'
    name = _("destroy")
456 457
    description = _("Permanently destroy virtual machine, its network "
                    "settings and disks.")
458
    required_perms = ()
459
    resultant_state = 'DESTROYED'
Dudás Ádám committed
460

461 462 463
    def on_abort(self, activity, error):
        activity.resultant_state = None

464
    def _operation(self, activity, system):
465
        # Destroy networks
466 467 468
        with activity.sub_activity(
                'destroying_net',
                readable_name=ugettext_noop("destroy network")):
469
            if self.instance.node:
470
                self.instance.shutdown_net()
471
            self.instance.destroy_net()
Dudás Ádám committed
472

473
        if self.instance.node:
474
            self.instance._delete_vm(parent_activity=activity)
Dudás Ádám committed
475 476

        # Destroy disks
477 478 479
        with activity.sub_activity(
                'destroying_disks',
                readable_name=ugettext_noop("destroy disks")):
Dudás Ádám committed
480
            self.instance.destroy_disks()
Dudás Ádám committed
481

Dudás Ádám committed
482 483
        # Delete mem. dump if exists
        try:
484
            self.instance._delete_mem_dump(parent_activity=activity)
Dudás Ádám committed
485 486 487 488 489 490
        except:
            pass

        # Clear node and VNC port association
        self.instance.yield_node()
        self.instance.yield_vnc_port()
Dudás Ádám committed
491 492 493 494

        self.instance.destroyed_at = timezone.now()
        self.instance.save()

495
    @register_operation
496
    class DeleteVmOperation(SubOperationMixin, RemoteInstanceOperation):
497 498 499 500 501
        id = "_delete_vm"
        name = _("destroy virtual machine")
        task = vm_tasks.destroy
        # if e.libvirtError and "Domain not found" in str(e):

502 503 504 505 506 507 508 509 510 511 512 513 514 515
    @register_operation
    class DeleteMemDumpOperation(RemoteOperationMixin, SubOperationMixin,
                                 InstanceOperation):
        id = "_delete_mem_dump"
        name = _("removing memory dump")
        task = storage_tasks.delete_dump

        def _get_remote_queue(self):
            return self.instance.mem_dump['datastore'].get_remote_queue_name(
                "storage", "fast")

        def _get_remote_args(self, **kwargs):
            return [self.instance.mem_dump['path']]

Dudás Ádám committed
516

517
@register_operation
518
class MigrateOperation(RemoteInstanceOperation):
Dudás Ádám committed
519 520
    id = 'migrate'
    name = _("migrate")
521 522
    description = _("Move a running virtual machine to an other worker node "
                    "keeping its full state.")
523
    required_perms = ()
524
    superuser_required = True
525
    accept_states = ('RUNNING', )
526
    async_queue = "localhost.man.slow"
527 528
    task = vm_tasks.migrate
    remote_queue = ("vm", "slow")
529
    remote_timeout = 1000
530

531
    def _get_remote_args(self, to_node, live_migration, **kwargs):
532
        return (super(MigrateOperation, self)._get_remote_args(**kwargs)
533
                + [to_node.host.hostname, live_migration])
Dudás Ádám committed
534

535
    def rollback(self, activity):
536 537 538
        with activity.sub_activity(
            'rollback_net', readable_name=ugettext_noop(
                "redeploy network (rollback)")):
539 540
            self.instance.deploy_net()

541
    def _operation(self, activity, to_node=None, live_migration=True):
Dudás Ádám committed
542
        if not to_node:
Bach Dániel committed
543 544 545 546 547 548
            with activity.sub_activity('scheduling',
                                       readable_name=ugettext_noop(
                                           "schedule")) as sa:
                to_node = self.instance.select_node()
                sa.result = to_node

549
        try:
550 551 552
            with activity.sub_activity(
                'migrate_vm', readable_name=create_readable(
                    ugettext_noop("migrate to %(node)s"), node=to_node)):
553 554
                super(MigrateOperation, self)._operation(
                    to_node=to_node, live_migration=live_migration)
555 556 557
        except Exception as e:
            if hasattr(e, 'libvirtError'):
                self.rollback(activity)
Bach Dániel committed
558
            raise
Dudás Ádám committed
559

560
        # Shutdown networks
561 562 563
        with activity.sub_activity(
            'shutdown_net', readable_name=ugettext_noop(
                "shutdown network")):
564 565
            self.instance.shutdown_net()

Dudás Ádám committed
566 567 568
        # Refresh node information
        self.instance.node = to_node
        self.instance.save()
569

Dudás Ádám committed
570
        # Estabilish network connection (vmdriver)
571 572 573
        with activity.sub_activity(
            'deploying_net', readable_name=ugettext_noop(
                "deploy network")):
Dudás Ádám committed
574
            self.instance.deploy_net()
Dudás Ádám committed
575 576


577
@register_operation
578
class RebootOperation(RemoteInstanceOperation):
Dudás Ádám committed
579 580
    id = 'reboot'
    name = _("reboot")
581 582
    description = _("Warm reboot virtual machine by sending Ctrl+Alt+Del "
                    "signal to its console.")
583
    required_perms = ()
584
    accept_states = ('RUNNING', )
585
    task = vm_tasks.reboot
Dudás Ádám committed
586

587 588
    def _operation(self, activity):
        super(RebootOperation, self)._operation()
589 590 591
        if self.instance.has_agent:
            activity.sub_activity('os_boot', readable_name=ugettext_noop(
                "wait operating system loading"), interruptible=True)
Dudás Ádám committed
592 593


594
@register_operation
595 596 597
class RemoveInterfaceOperation(InstanceOperation):
    id = 'remove_interface'
    name = _("remove interface")
598 599 600
    description = _("Remove the specified network interface and erase IP "
                    "address allocations, related firewall rules and "
                    "hostnames.")
601
    required_perms = ()
602
    accept_states = ('STOPPED', 'PENDING', 'RUNNING')
603

604 605
    def _operation(self, activity, user, system, interface):
        if self.instance.is_running:
606 607
            self.instance._detach_network(interface=interface,
                                          parent_activity=activity)
608 609 610 611 612
            interface.shutdown()

        interface.destroy()
        interface.delete()

613 614
    def get_activity_name(self, kwargs):
        return create_readable(ugettext_noop("remove %(vlan)s interface"),
615
                               vlan=kwargs['interface'].vlan)
616

617

618
@register_operation
619 620 621 622 623
class RemovePortOperation(InstanceOperation):
    id = 'remove_port'
    name = _("close port")
    description = _("Close the specified port.")
    concurrency_check = False
624
    required_perms = ('vm.config_ports', )
625 626 627 628

    def _operation(self, activity, rule):
        interface = rule.host.interface_set.get()
        if interface.instance != self.instance:
629
            raise SuspiciousOperation()
630 631 632 633 634 635 636
        activity.readable_name = create_readable(
            ugettext_noop("close %(proto)s/%(port)d on %(host)s"),
            proto=rule.proto, port=rule.dport, host=rule.host)
        rule.delete()


@register_operation
637 638 639 640 641
class AddPortOperation(InstanceOperation):
    id = 'add_port'
    name = _("open port")
    description = _("Open the specified port.")
    concurrency_check = False
642
    required_perms = ('vm.config_ports', )
643 644 645

    def _operation(self, activity, host, proto, port):
        if host.interface_set.get().instance != self.instance:
646
            raise SuspiciousOperation()
647 648 649 650 651 652 653
        host.add_port(proto, private=port)
        activity.readable_name = create_readable(
            ugettext_noop("open %(proto)s/%(port)d on %(host)s"),
            proto=proto, port=port, host=host)


@register_operation
654 655 656
class RemoveDiskOperation(InstanceOperation):
    id = 'remove_disk'
    name = _("remove disk")
657 658
    description = _("Remove the specified disk from the virtual machine, and "
                    "destroy the data.")
659
    required_perms = ()
660
    accept_states = ('STOPPED', 'PENDING', 'RUNNING')
661 662

    def _operation(self, activity, user, system, disk):
663
        if self.instance.is_running and disk.type not in ["iso"]:
664
            self.instance._detach_disk(disk=disk, parent_activity=activity)
665 666 667 668
        with activity.sub_activity(
            'destroy_disk',
            readable_name=ugettext_noop('destroy disk')
        ):
669
            disk.destroy()
670
            return self.instance.disks.remove(disk)
671

672 673 674
    def get_activity_name(self, kwargs):
        return create_readable(ugettext_noop('remove disk %(name)s'),
                               name=kwargs["disk"].name)
675 676


677
@register_operation
678
class ResetOperation(RemoteInstanceOperation):
Dudás Ádám committed
679 680
    id = 'reset'
    name = _("reset")
681
    description = _("Cold reboot virtual machine (power cycle).")
682
    required_perms = ()
683
    accept_states = ('RUNNING', )
684
    task = vm_tasks.reset
Dudás Ádám committed
685

686 687
    def _operation(self, activity):
        super(ResetOperation, self)._operation()
688 689 690
        if self.instance.has_agent:
            activity.sub_activity('os_boot', readable_name=ugettext_noop(
                "wait operating system loading"), interruptible=True)
Dudás Ádám committed
691 692


693
@register_operation
694
class SaveAsTemplateOperation(InstanceOperation):
Dudás Ádám committed
695 696
    id = 'save_as_template'
    name = _("save as template")
697 698 699 700
    description = _("Save virtual machine as a template so they can be shared "
                    "with users and groups.  Anyone who has access to a "
                    "template (and to the networks it uses) will be able to "
                    "start an instance of it.")
701
    has_percentage = True
702
    abortable = True
703
    required_perms = ('vm.create_template', )
704
    accept_states = ('RUNNING', 'STOPPED')
705
    async_queue = "localhost.man.slow"
Dudás Ádám committed
706

707 708 709 710
    def is_preferred(self):
        return (self.instance.is_base and
                self.instance.status == self.instance.STATUS.RUNNING)

711 712 713 714 715 716
    @staticmethod
    def _rename(name):
        m = search(r" v(\d+)$", name)
        if m:
            v = int(m.group(1)) + 1
            name = search(r"^(.*) v(\d+)$", name).group(1)
717
        else:
718 719
            v = 1
        return "%s v%d" % (name, v)
720

721
    def on_abort(self, activity, error):
722
        if hasattr(self, 'disks'):
723 724 725
            for disk in self.disks:
                disk.destroy()

726
    def _operation(self, activity, user, system, name=None,
727
                   with_shutdown=True, clone=False, task=None, **kwargs):
728 729
        try:
            self.instance._cleanup(parent_activity=activity, user=user)
730
        except:
731 732
            pass

733
        if with_shutdown:
734
            try:
735 736
                self.instance.shutdown(parent_activity=activity,
                                       user=user, task=task)
737 738 739
            except Instance.WrongStateError:
                pass

Dudás Ádám committed
740 741 742 743 744 745 746 747
        # prepare parameters
        params = {
            'access_method': self.instance.access_method,
            'arch': self.instance.arch,
            'boot_menu': self.instance.boot_menu,
            'description': self.instance.description,
            'lease': self.instance.lease,  # Can be problem in new VM
            'max_ram_size': self.instance.max_ram_size,
748
            'name': name or self._rename(self.instance.name),
Dudás Ádám committed
749 750
            'num_cores': self.instance.num_cores,
            'owner': user,
751
            'parent': self.instance.template or None,  # Can be problem
Dudás Ádám committed
752 753 754 755 756 757
            'priority': self.instance.priority,
            'ram_size': self.instance.ram_size,
            'raw_data': self.instance.raw_data,
            'system': self.instance.system,
        }
        params.update(kwargs)
Bach Dániel committed
758
        params.pop("parent_activity", None)
Dudás Ádám committed
759

760 761
        from storage.models import Disk

Dudás Ádám committed
762 763
        def __try_save_disk(disk):
            try:
764
                return disk.save_as(task)
Dudás Ádám committed
765 766 767
            except Disk.WrongDiskTypeError:
                return disk

768
        self.disks = []
769 770 771 772 773 774 775
        for disk in self.instance.disks.all():
            with activity.sub_activity(
                'saving_disk',
                readable_name=create_readable(
                    ugettext_noop("saving disk %(name)s"),
                    name=disk.name)
            ):
776 777
                self.disks.append(__try_save_disk(disk))

Dudás Ádám committed
778 779 780 781
        # create template and do additional setup
        tmpl = InstanceTemplate(**params)
        tmpl.full_clean()  # Avoiding database errors.
        tmpl.save()
782
        # Copy traits from the VM instance
783
        tmpl.req_traits.add(*self.instance.req_traits.all())
784 785
        if clone:
            tmpl.clone_acl(self.instance.template)
Guba Sándor committed
786
            # Add permission for the original owner of the template
787 788
            tmpl.set_level(self.instance.template.owner, 'owner')
            tmpl.set_level(user, 'owner')
Dudás Ádám committed
789
        try:
790
            tmpl.disks.add(*self.disks)
Dudás Ádám committed
791 792 793 794 795 796 797
            # create interface templates
            for i in self.instance.interface_set.all():
                i.save_as_template(tmpl)
        except:
            tmpl.delete()
            raise
        else:
798 799 800 801
            return create_readable(
                ugettext_noop("New template: %(template)s"),
                template=reverse('dashboard.views.template-detail',
                                 kwargs={'pk': tmpl.pk}))
Dudás Ádám committed
802 803


804
@register_operation
805 806
class ShutdownOperation(AbortableRemoteOperationMixin,
                        RemoteInstanceOperation):
Dudás Ádám committed
807 808
    id = 'shutdown'
    name = _("shutdown")
809 810 811 812
    description = _("Try to halt virtual machine by a standard ACPI signal, "
                    "allowing the operating system to keep a consistent "
                    "state. The operation will fail if the machine does not "
                    "turn itself off in a period.")
Kálmán Viktor committed
813
    abortable = True
814
    required_perms = ()
815
    accept_states = ('RUNNING', )
816
    resultant_state = 'STOPPED'
817 818
    task = vm_tasks.shutdown
    remote_queue = ("vm", "slow")
819
    remote_timeout = 180
Dudás Ádám committed
820

821 822
    def _operation(self, task):
        super(ShutdownOperation, self)._operation(task=task)
Dudás Ádám committed
823
        self.instance.yield_node()
Dudás Ádám committed
824

825 826 827 828 829 830 831 832 833 834 835
    def on_abort(self, activity, error):
        if isinstance(error, TimeLimitExceeded):
            activity.result = humanize_exception(ugettext_noop(
                "The virtual machine did not switch off in the provided time "
                "limit. Most of the time this is caused by incorrect ACPI "
                "settings. You can also try to power off the machine from the "
                "operating system manually."), error)
            activity.resultant_state = None
        else:
            super(ShutdownOperation, self).on_abort(activity, error)

Dudás Ádám committed
836

837
@register_operation
838
class ShutOffOperation(InstanceOperation):
Dudás Ádám committed
839 840
    id = 'shut_off'
    name = _("shut off")
841 842 843 844 845 846 847
    description = _("Forcibly halt a virtual machine without notifying the "
                    "operating system. This operation will even work in cases "
                    "when shutdown does not, but the operating system and the "
                    "file systems are likely to be in an inconsistent state,  "
                    "so data loss is also possible. The effect of this "
                    "operation is the same as interrupting the power supply "
                    "of a physical machine.")
848
    required_perms = ()
849
    accept_states = ('RUNNING', 'PAUSED')
850
    resultant_state = 'STOPPED'
Dudás Ádám committed
851

852
    def _operation(self, activity):
Dudás Ádám committed
853 854 855
        # Shutdown networks
        with activity.sub_activity('shutdown_net'):
            self.instance.shutdown_net()
Dudás Ádám committed
856

857
        self.instance._delete_vm(parent_activity=activity)
Dudás Ádám committed
858
        self.instance.yield_node()
Dudás Ádám committed
859 860


861
@register_operation
862
class SleepOperation(InstanceOperation):
Dudás Ádám committed
863 864
    id = 'sleep'
    name = _("sleep")
865 866 867 868 869 870 871 872
    description = _("Suspend virtual machine. This means the machine is "
                    "stopped and its memory is saved to disk, so if the "
                    "machine is waked up, all the applications will keep "
                    "running. Most of the applications will be able to "
                    "continue even after a long suspension, but those which "
                    "need a continous network connection may fail when "
                    "resumed. In the meantime, the machine will only use "
                    "storage resources, and keep network resources allocated.")
873
    required_perms = ()
874
    accept_states = ('RUNNING', )
875
    resultant_state = 'SUSPENDED'
876
    async_queue = "localhost.man.slow"
Dudás Ádám committed
877

878 879 880 881
    def is_preferred(self):
        return (not self.instance.is_base and
                self.instance.status == self.instance.STATUS.RUNNING)

Dudás Ádám committed
882 883 884 885 886 887
    def on_abort(self, activity, error):
        if isinstance(error, TimeLimitExceeded):
            activity.resultant_state = None
        else:
            activity.resultant_state = 'ERROR'

888
    def _operation(self, activity, system):
889 890 891
        with activity.sub_activity('shutdown_net',
                                   readable_name=ugettext_noop(
                                       "shutdown network")):
Dudás Ádám committed
892
            self.instance.shutdown_net()
893
        self.instance._suspend_vm(parent_activity=activity)
894
        self.instance.yield_node()
Dudás Ádám committed
895

896 897 898 899
    @register_operation
    class SuspendVmOperation(SubOperationMixin, RemoteInstanceOperation):
        id = "_suspend_vm"
        name = _("suspend virtual machine")
900
        task = vm_tasks.sleep
901
        remote_queue = ("vm", "slow")
902
        remote_timeout = 1000
Dudás Ádám committed
903

904 905 906 907
        def _get_remote_args(self, **kwargs):
            return (super(SleepOperation.SuspendVmOperation, self)
                    ._get_remote_args(**kwargs)
                    + [self.instance.mem_dump['path']])
Dudás Ádám committed
908 909


910
@register_operation
911
class WakeUpOperation(InstanceOperation):
Dudás Ádám committed
912 913
    id = 'wake_up'
    name = _("wake up")
914 915 916
    description = _("Wake up sleeping (suspended) virtual machine. This will "
                    "load the saved memory of the system and start the "
                    "virtual machine from this state.")
917
    required_perms = ()
918
    accept_states = ('SUSPENDED', )
919
    resultant_state = 'RUNNING'
920
    async_queue = "localhost.man.slow"
Dudás Ádám committed
921

922
    def is_preferred(self):
923
        return self.instance.status == self.instance.STATUS.SUSPENDED
924

Dudás Ádám committed
925
    def on_abort(self, activity, error):
Bach Dániel committed
926 927 928 929
        if isinstance(error, SchedulerError):
            activity.resultant_state = None
        else:
            activity.resultant_state = 'ERROR'
Dudás Ádám committed
930

931
    def _operation(self, activity):
Dudás Ádám committed
932
        # Schedule vm
Dudás Ádám committed
933
        self.instance.allocate_vnc_port()
934
        self.instance.allocate_node()
Dudás Ádám committed
935 936

        # Resume vm
937
        self.instance._wake_up_vm(parent_activity=activity)
Dudás Ádám committed
938 939

        # Estabilish network connection (vmdriver)
940 941 942
        with activity.sub_activity(
            'deploying_net', readable_name=ugettext_noop(
                "deploy network")):
Dudás Ádám committed
943
            self.instance.deploy_net()
Dudás Ádám committed
944

945 946 947 948
        try:
            self.instance.renew(parent_activity=activity)
        except:
            pass
Dudás Ádám committed
949

950 951 952 953 954 955
    @register_operation
    class WakeUpVmOperation(SubOperationMixin, RemoteInstanceOperation):
        id = "_wake_up_vm"
        name = _("resume virtual machine")
        task = vm_tasks.wake_up
        remote_queue = ("vm", "slow")
956
        remote_timeout = 1000
957 958 959 960 961 962

        def _get_remote_args(self, **kwargs):
            return (super(WakeUpOperation.WakeUpVmOperation, self)
                    ._get_remote_args(**kwargs)
                    + [self.instance.mem_dump['path']])

Dudás Ádám committed
963

964
@register_operation
965 966 967
class RenewOperation(InstanceOperation):
    id = 'renew'
    name = _("renew")
968 969 970 971
    description = _("Virtual machines are suspended and destroyed after they "
                    "expire. This operation renews expiration times according "
                    "to the lease type. If the machine is close to the "
                    "expiration, its owner will be notified.")
972
    acl_level = "operator"
973
    required_perms = ()
974
    concurrency_check = False
975

Őry Máté committed
976
    def _operation(self, activity, lease=None, force=False, save=False):
977 978 979 980 981 982 983 984 985 986 987 988 989
        suspend, delete = self.instance.get_renew_times(lease)
        if (not force and suspend and self.instance.time_of_suspend and
                suspend < self.instance.time_of_suspend):
            raise HumanReadableException.create(ugettext_noop(
                "Renewing the machine with the selected lease would result "
                "in its suspension time get earlier than before."))
        if (not force and delete and self.instance.time_of_delete and
                delete < self.instance.time_of_delete):
            raise HumanReadableException.create(ugettext_noop(
                "Renewing the machine with the selected lease would result "
                "in its delete time get earlier than before."))
        self.instance.time_of_suspend = suspend
        self.instance.time_of_delete = delete
Őry Máté committed
990 991
        if save:
            self.instance.lease = lease
992
        self.instance.save()
993
        return create_readable(ugettext_noop(
994 995
            "Renewed to suspend at %(suspend)s and destroy at %(delete)s."),
            suspend=suspend, delete=delete)
996 997


998
@register_operation
999
class ChangeStateOperation(InstanceOperation):
Guba Sándor committed
1000
    id = 'emergency_change_state'
1001 1002 1003 1004 1005 1006
    name = _("emergency state change")
    description = _("Change the virtual machine state to NOSTATE. This "
                    "should only be used if manual intervention was needed in "
                    "the virtualization layer, and the machine has to be "
                    "redeployed without losing its storage and network "
                    "resources.")
1007
    acl_level = "owner"
Guba Sándor committed
1008
    required_perms = ('vm.emergency_change_state', )
1009
    concurrency_check = False
1010

1011 1012
    def _operation(self, user, activity, new_state="NOSTATE", interrupt=False,
                   reset_node=False):
1013
        activity.resultant_state = new_state
1014 1015 1016 1017 1018 1019 1020
        if interrupt:
            msg_txt = ugettext_noop("Activity is forcibly interrupted.")
            message = create_readable(msg_txt, msg_txt)
            for i in InstanceActivity.objects.filter(
                    finished__isnull=True, instance=self.instance):
                i.finish(False, result=message)
                logger.error('Forced finishing activity %s', i)
1021

1022 1023 1024 1025
        if reset_node:
            self.instance.node = None
            self.instance.save()

1026

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
@register_operation
class RedeployOperation(InstanceOperation):
    id = 'redeploy'
    name = _("redeploy")
    description = _("Change the virtual machine state to NOSTATE "
                    "and redeploy the VM. This operation allows starting "
                    "machines formerly running on a failed node.")
    acl_level = "owner"
    required_perms = ('vm.redeploy', )
    concurrency_check = False

    def _operation(self, user, activity, with_emergency_change_state=True):
        if with_emergency_change_state:
            ChangeStateOperation(self.instance).call(
                parent_activity=activity, user=user,
                new_state='NOSTATE', interrupt=False, reset_node=True)
        else:
            ShutOffOperation(self.instance).call(
                parent_activity=activity, user=user)

        self.instance._update_status()

        DeployOperation(self.instance).call(
            parent_activity=activity, user=user)

1052

1053
class NodeOperation(Operation):
1054
    async_operation = abortable_async_node_operation
1055
    host_cls = Node
1056 1057
    online_required = True
    superuser_required = True
1058 1059 1060 1061 1062

    def __init__(self, node):
        super(NodeOperation, self).__init__(subject=node)
        self.node = node

1063 1064 1065 1066 1067 1068 1069
    def check_precond(self):
        super(NodeOperation, self).check_precond()
        if self.online_required and not self.node.online:
            raise humanize_exception(ugettext_noop(
                "You cannot call this operation on an offline node."),
                Exception())

1070 1071
    def create_activity(self, parent, user, kwargs):
        name = self.get_activity_name(kwargs)
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
        if parent:
            if parent.node != self.node:
                raise ValueError("The node associated with the specified "
                                 "parent activity does not match the node "
                                 "bound to the operation.")
            if parent.user != user:
                raise ValueError("The user associated with the specified "
                                 "parent activity does not match the user "
                                 "provided as parameter.")

1082 1083 1084
            return parent.create_sub(
                code_suffix=self.get_activity_code_suffix(),
                readable_name=name)
1085
        else:
1086 1087 1088
            return NodeActivity.create(
                code_suffix=self.get_activity_code_suffix(), node=self.node,
                user=user, readable_name=name)
1089 1090


1091
@register_operation
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
class ResetNodeOperation(NodeOperation):
    id = 'reset'
    name = _("reset")
    description = _("Disable missing node and redeploy all instances "
                    "on other ones.")
    required_perms = ()
    online_required = False
    async_queue = "localhost.man.slow"

    def check_precond(self):
        super(ResetNodeOperation, self).check_precond()
        if not self.node.enabled or self.node.online:
            raise humanize_exception(ugettext_noop(
                "You cannot reset a disabled or online node."), Exception())

    def _operation(self, activity, user):
        for i in self.node.instance_set.all():
            name = create_readable(ugettext_noop(
1110
                "redeploy %(instance)s (%(pk)s)"), instance=i.name, pk=i.pk)
1111 1112 1113 1114
            with activity.sub_activity('migrate_instance_%d' % i.pk,
                                       readable_name=name):
                i.redeploy(user=user)

1115 1116 1117 1118
        self.node.enabled = False
        self.node.schedule_enabled = False
        self.node.save()

1119 1120

@register_operation
1121 1122 1123
class FlushOperation(NodeOperation):
    id = 'flush'
    name = _("flush")
1124
    description = _("Passivate node and move all instances to other ones.")