/usr/share/pyshared/archipelagentvmcasting/vmappliancemanager.py is in archipel-agent-vmcasting 0.6.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 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 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 210 211 212 213 214 215 216 217 218 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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 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 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | # -*- coding: utf-8 -*-
#
# vmappliancemanager.py
#
# Copyright (C) 2010 Antoine Mercadal <antoine.mercadal@inframonde.eu>
# This file is part of ArchipelProject
# http://archipelproject.org
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import sqlite3
import xmpp
from archipelcore.archipelPlugin import TNArchipelPlugin
from archipel.archipelVirtualMachine import ARCHIPEL_ERROR_CODE_VM_MIGRATING
from archipelcore.utils import build_error_iq, build_error_message
import archipel.archipelLibvirtEntity
import appliancecompresser
import appliancedecompresser
ARCHIPEL_NS_VIRTUALMACHINE_VMCASTING = "archipel:virtualmachine:vmcasting"
ARCHIPEL_APPLIANCES_INSTALLED = 1
ARCHIPEL_ERROR_CODE_VMAPPLIANCES_INSTALL = -4001
ARCHIPEL_ERROR_CODE_VMAPPLIANCES_GET = -4002
ARCHIPEL_ERROR_CODE_VMAPPLIANCES_DETACH = -4003
ARCHIPEL_ERROR_CODE_VMAPPLIANCES_PACKAGE = -4004
class TNVMApplianceManager (TNArchipelPlugin):
def __init__(self, configuration, entity, entry_point_group):
"""
Initialize the class.
@type configuration: Configuration object
@param configuration: the configuration
@type entity: L{TNArchipelEntity}
@param entity: the entity that owns the plugin
@type entry_point_group: string
@param entry_point_group: the group name of plugin entry_point
"""
TNArchipelPlugin.__init__(self, configuration=configuration, entity=entity, entry_point_group=entry_point_group)
## create directories if neede
if not os.path.exists(self.configuration.get("VMCASTING", "repository_path")):
os.makedirs(self.configuration.get("VMCASTING", "repository_path"))
if not os.path.exists(self.configuration.get("VMCASTING", "temp_path")):
os.makedirs(self.configuration.get("VMCASTING", "temp_path"))
if not os.path.exists(self.configuration.get("VMCASTING", "own_vmcast_path")):
os.makedirs(self.configuration.get("VMCASTING", "own_vmcast_path"))
self.disks_extensions = self.configuration.get("VMCASTING", "disks_extensions").split(";")
self.temp_directory = self.configuration.get("VMCASTING", "temp_path")
self.hypervisor_repo_path = self.configuration.get("VMCASTING", "own_vmcast_path")
self.is_installing = False
self.installing_media_uuid = None
self.is_installed = False
self.database_connection = sqlite3.connect(self.configuration.get("VMCASTING", "vmcasting_database_path"), check_same_thread = False)
self.cursor = self.database_connection.cursor()
# permissions
self.entity.permission_center.create_permission("appliance_get", "Authorizes user to get installed appliances", False)
self.entity.permission_center.create_permission("appliance_attach", "Authorizes user attach appliance to virtual machine", False)
self.entity.permission_center.create_permission("appliance_detach", "Authorizes user to detach appliance_detach from virtual machine", False)
self.entity.permission_center.create_permission("appliance_package", "Authorizes user to package new appliance from virtual machine", False)
# chat
registrar_items = [
{ "commands" : ["list appliances"],
"parameters": [],
"method": self.message_get,
"permissions": ["appliance_get"],
"description": "List all appliances" },
{ "commands" : ["attach appliance"],
"parameters": [{"name": "identifier", "description": "The identifer of the appliance, UUID or name"}],
"method": self.message_attach,
"permissions": ["appliance_attach"],
"description": "Attach to the given appliance" },
{ "commands" : ["detach appliance"],
"parameters": [],
"method": self.message_detach,
"permissions": ["appliance_detach"],
"description": "Detach from the current appliance" }
]
self.entity.add_message_registrar_items(registrar_items)
### Plugin interface
def register_handlers(self):
"""
This method will be called by the plugin user when it will be
necessary to register module for listening to stanza.
"""
self.entity.xmppclient.RegisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_VIRTUALMACHINE_VMCASTING)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.entity.xmppclient.UnregisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_VIRTUALMACHINE_VMCASTING)
@staticmethod
def plugin_info():
"""
Return informations about the plugin.
@rtype: dict
@return: dictionary contaning plugin informations
"""
plugin_friendly_name = "Virtual Machine Appliances"
plugin_identifier = "virtualmachine_appliance"
plugin_configuration_section = "VMCASTING"
plugin_configuration_tokens = [ "repository_path",
"temp_path",
"own_vmcast_path",
"disks_extensions",
"repository_path",
"vmcasting_database_path"]
return { "common-name" : plugin_friendly_name,
"identifier" : plugin_identifier,
"configuration-section" : plugin_configuration_section,
"configuration-tokens" : plugin_configuration_tokens }
### Callbacks
def finish_installing(self):
"""
Used as callback for TNApplianceDecompresser.
"""
def presence_callback(conn, resp):
self.entity.push_change("vmcasting", "applianceinstalled")
self.entity.change_status("Off")
self.entity.shout("appliance", "I've terminated to install from applicance.")
self.is_installed = True
self.is_installing = False
self.installing_media_uuid = None
self.entity.change_presence(presence_show=self.old_show, presence_status=self.old_status, callback=presence_callback)
def error_installing(self, exception):
"""
Used as callback for TNApplianceDecompresser.
"""
def presence_callback(conn, resp):
self.entity.push_change("vmcasting", "applianceerror")
self.entity.shout("appliance", "Cannot install appliance: %s" % str(exception))
self.is_installed = False
self.is_installing = False
self.installing_media_uuid = None
self.entity.change_presence(presence_show=self.old_show, presence_status="Cannot install appliance", callback=presence_callback)
def finish_packaging(self):
"""
Used as callback for TNApplianceCompresser.
"""
def presence_callback(conn, resp):
self.entity.push_change("vmcasting", "packaged")
self.is_installing = False
hypervisor_vmcast_plugin = self.entity.hypervisor.get_plugin("hypervisor_vmcasts")
hypervisor_vmcast_plugin.parse_own_repo(loop=False)
self.entity.change_presence(presence_show=self.old_show, presence_status=self.old_status, callback=presence_callback)
def error_packaging(self, exception):
"""
Used as callback for TNApplianceCompresser.
"""
def presence_callback(conn, resp):
self.entity.push_change("vmcasting", "packagingerror")
self.entity.shout("appliance", "Cannot package virtual machine: %s" % str(exception))
self.is_installing = False
self.entity.change_presence(presence_show=self.old_show, presence_status="Cannot package appliance", callback=presence_callback)
### Processing
def get(self):
"""
return the list of appliance
@rtype: array
@return: array of appliances
"""
ret = []
self.cursor.execute("SELECT save_path, name, description, uuid FROM vmcastappliances WHERE status=%d" % (ARCHIPEL_APPLIANCES_INSTALLED))
for values in self.cursor:
path = values[0]
name = values[1]
description = values[2]
uuid = values[3]
status = "none"
if self.is_installing and (self.installing_media_uuid == uuid):
status = "installing"
else:
try:
f = open(self.entity.folder + "/current.package", "r")
puuid = f.read()
f.close()
if puuid == uuid:
status = "installed"
self.is_installed = True
except:
pass
ret.append({"path": path, "name": name, "description": description, "uuid": uuid, "status": status})
return ret
def attach(self, uuid, requester):
"""
attach the appliance identified by given UUID
@type uuid: string
@param uuid: the UUID of the appliance
@type requester: JID
@param requester: the JID of the requester
"""
if self.is_installing:
raise Exception("Virtual machine is already installing a package.")
if (self.is_installed):
raise Exception("You must detach from already attached template.")
self.cursor.execute("SELECT * FROM vmcastappliances WHERE uuid=\"%s\"" % (uuid))
try:
name, description, url, uuid, status, source, save_path = self.cursor.fetchone()
except Exception as ex:
raise Exception("Cannot find appliance with UUID %s" % uuid)
self.entity.log.debug("Supported extensions : %s " % str(self.disks_extensions))
self.entity.log.info("will install appliance with uuid %s at path %s" % (uuid, save_path))
appliance_packager = appliancedecompresser.TNApplianceDecompresser(self.temp_directory, self.disks_extensions, save_path, self.entity, self.finish_installing, self.error_installing, uuid, requester)
self.old_status = self.entity.xmppstatus
self.old_show = self.entity.xmppstatusshow
self.entity.change_presence(presence_show="dnd", presence_status="Installing from appliance...")
self.is_installing = True
self.installing_media_uuid = uuid
appliance_packager.start()
self.entity.push_change("vmcasting", "applianceinstalling")
def detach(self):
"""
detach the current appliance
"""
if self.is_installing:
raise Exception("Virtual machine is already installing a package.")
package_file_path = self.entity.folder + "/current.package"
if not os.path.exists(package_file_path):
raise Exception("No appliance is attached.")
os.unlink(package_file_path)
self.is_installed = False
self.entity.push_change("vmcasting", "appliancedetached")
### XMPP Processing
def process_iq(self, conn, iq):
"""
Process incoming IQ of type ARCHIPEL_NS_HYPERVISOR_VMCASTING.
It understands IQ of type:
- get
- attach
- detach
- package
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.entity.check_acp(conn, iq)
self.entity.check_perm(conn, iq, action, -1, prefix="appliance_")
if self.entity.is_migrating and (not action in ("get")):
reply = build_error_iq(self, "Virtual machine is migrating. Can't perform any snapshoting operation.", iq, ARCHIPEL_ERROR_CODE_VM_MIGRATING)
elif action == "get":
reply = self.iq_get(iq)
elif action == "attach":
reply = self.iq_attach(iq)
elif action == "detach":
reply = self.iq_detach(iq)
elif action == "package":
reply = self.iq_package(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_get(self, iq):
"""
Get all installed appliances.
@type iq: xmpp.Protocol.Iq
@param iq: the sender request IQ
@rtype: xmpp.Protocol.Iq
@return: a ready-to-send IQ containing the results
"""
try:
nodes = []
reply = iq.buildReply("result")
appliances = self.get()
for appliance in appliances:
node = xmpp.Node(tag="appliance", attrs=appliance)
nodes.append(node)
reply.setQueryPayload(nodes)
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_VMAPPLIANCES_GET)
return reply
def message_get(self, msg):
"""
Create the message response to list appliances.
@type msg: xmpp.Protocol.Message
@param msg: the message containing the request
@rtype: string
@return: the answer
"""
try:
appliances = self.get()
ret = "Sure. Here are available appliances:\n"
for app in appliances:
ret += " - %s (%s)\n" % (app["name"], app["uuid"])
return ret
except Exception as ex:
return build_error_message(self, ex, msg)
def iq_attach(self, iq):
"""
Instanciate a new virtualmachine from an installed appliance.
@type iq: xmpp.Protocol.Iq
@param iq: the sender request IQ
@rtype: xmpp.Protocol.Iq
@return: a ready-to-send IQ containing the results
"""
reply = iq.buildReply("result")
try:
uuid = iq.getTag("query").getTag("archipel").getAttr("uuid")
requester = iq.getFrom()
self.attach(uuid, requester);
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_VMAPPLIANCES_INSTALL)
return reply
def message_attach(self, msg):
"""
Attach the appliance identified by UUID from the given msg
@type msg: xmpp.Protocol.Message
@param msg: the message containing the request
@rtype: string
@return: the answer
"""
try:
tokens = msg.getBody().split()
if not len(tokens) == 3:
return "I'm sorry, you use a wrong format. You can type 'help' to get help."
uuid = tokens[-1:][0]
requester = msg.getFrom()
self.attach(uuid, requester)
return "Appliance installation as started"
except Exception as ex:
return build_error_message(self, ex, msg)
def iq_detach(self, iq):
"""
Detach an installed appliance from a virtualmachine.
@type iq: xmpp.Protocol.Iq
@param iq: the sender request IQ
@rtype: xmpp.Protocol.Iq
@return: a ready-to-send IQ containing the results
"""
reply = iq.buildReply("result")
try:
self.detach()
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_VMAPPLIANCES_DETACH)
return reply
def message_detach(self, msg):
"""
detach the current attached appliance
"""
try:
tokens = msg.getBody().split()
if not len(tokens) == 2:
return "I'm sorry, you use a wrong format. You can type 'help' to get help."
self.detach()
return "Appliance is now detached"
except Exception as ex:
return build_error_message(self, ex, msg)
def iq_package(self, iq):
"""
Package the current virtual machine.
@type iq: xmpp.Protocol.Iq
@param iq: the sender request IQ
@rtype: xmpp.Protocol.Iq
@return: a ready-to-send IQ containing the results
"""
reply = iq.buildReply("result")
try:
if self.is_installing:
raise Exception("Virtual machine is already installing a package.")
if not self.entity.definition:
raise Exception("Virtual machine is not defined.")
disk_nodes = self.entity.definition.getTag('devices').getTags('disk', attrs={'type': 'file'})
package_name = iq.getTag("query").getTag("archipel").getAttr("name")
package_should_gzip = iq.getTag("query").getTag("archipel").getAttr("gzip")
if package_should_gzip:
package_should_gzip = package_should_gzip.lower() in ["true", "1", "y", "yes"];
conf_should_gzip = self.configuration.getboolean("VMCASTING", "should_gzip_drives")
conf_force_gzip = self.configuration.getboolean("VMCASTING", "ignore_user_gzip_choice")
if package_should_gzip == None or conf_force_gzip:
package_should_gzip = conf_should_gzip
paths = []
if os.path.exists(self.hypervisor_repo_path + "/" + package_name + ".xvm2"):
self.entity.log.error(self.hypervisor_repo_path + "/" + package_name + ".xvm2 already exists. Aborting.")
raise Exception("Appliance with name %s is already in hypervisor repository." % package_name)
self.entity.push_change("vmcasting", "packaging")
self.old_status = self.entity.xmppstatus
self.old_show = self.entity.xmppstatusshow
def perform_packaging(conn, resp):
for disk_node in disk_nodes:
path = disk_node.getTag('source').getAttr('file')
paths.append(path)
snapshots = []
if self.entity.hypervisor.is_hypervisor((archipel.archipelLibvirtEntity.ARCHIPEL_HYPERVISOR_TYPE_QEMU)):
if self.entity.domain.hasCurrentSnapshot(0):
snapshot_names = self.entity.domain.snapshotListNames(0)
for snapshot_name in snapshot_names:
snapshotObject = self.entity.domain.snapshotLookupByName(snapshot_name, 0)
desc = snapshotObject.getXMLDesc(0)
snapshots.append(desc)
working_dir = self.entity.configuration.get("VMCASTING", "temp_path")
## create directories if needed
if not os.path.exists(working_dir):
os.makedirs(working_dir)
compressor = appliancecompresser.TNApplianceCompresser(package_name, paths, self.entity.definition, snapshots, working_dir,
self.entity.folder, self.hypervisor_repo_path, self.finish_packaging,
self.error_packaging, self.entity, package_should_gzip)
self.is_installing = True
compressor.start()
self.entity.change_presence(presence_show="dnd", presence_status="Packaging myself...", callback=perform_packaging)
except Exception as ex:
reply = build_error_iq(self, ex, iq, ARCHIPEL_ERROR_CODE_VMAPPLIANCES_PACKAGE)
return reply
|