Module: OpenNebula::MarketPlaceAppExt
- Includes:
- OpenNebula
- Defined in:
- lib/opennebula/marketplaceapp_ext.rb
Overview
Module to decorate MarketApp class with additional helpers not directly exposed through the OpenNebula XMLRPC API. The extensions include
- export helper that creates OpenNebula related objects from a given app.
rubocop:disable Style/ClassAndModuleChildren
Constant Summary
Constants included from OpenNebula
DEFAULT_POOL_PAGE_SIZE, VERSION
Class Method Summary collapse
Methods included from OpenNebula
arg_host, arg_path, decrypt, encrypt, error_message, exec_and_log, format_error_message, handle_driver_exception, is_disk?, is_error?, log_debug, log_error, log_function, log_info, pool_page_size, process_monitoring, send_to_monitor
Class Method Details
.extend_object(obj) ⇒ Object
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 456 457 458 459 460 461 462 463 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 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
# File 'lib/opennebula/marketplaceapp_ext.rb', line 26 def self.extend_object(obj) if !obj.is_a?(OpenNebula::MarketPlaceApp) raise StandardError, "Cannot extended #{obj.class} " \ 'with MarketPlaceAppExt' end class << obj #################################################################### # Public extended interface #################################################################### # Exports this app to a suitable OpenNebula object # @param appid [Integer] id of the marketplace app # @param options [Hash] to control the export behavior # dsid [Integer] datastore to save images # f_dsid [Integer] file datastore to save kernels # name [String] of the new object # vmtemplate_name [String] name for the VM Template, if the App # has one complex [Boolean] true to only create image # # @return [Hash, OpenNebula::Error] with the ID and type of # the created objects. Instead of an ID, the array may # contain OpenNebula::Error with specific object creation errors # { # :vm => [ vm ids/OpenNebula::Error ], # :vmtemplate => [ vmtemplates ids/OpenNebula::Error ], # :image => [ vm ids/OpenNebula::Error ] # } # rc_info = { # :image => [], # :image_type => nil, # :vmtemplate => [], # :service_template => [] # } def export( = {}) # Get App information and check for errors rc = info return rc if OpenNebula.is_error?(rc) return Error.new('App is not READY') if state_str != 'READY' if [:dsid].nil? return Error.new('Missing datastore id') end if [:name].nil? return Error.new('Missing name to export app') end case type_str when 'IMAGE' export_image() when 'VMTEMPLATE' [:notemplate] = true export_vm_template() when 'SERVICE_TEMPLATE' export_service_template() else Error.new("App type #{type_str} not supported") end end #################################################################### # Private methods #################################################################### private # Exports an OpenNebula Image from this marketplace app # @param options to export the image # :vmtemplate_name [String] name of new image and template # :url_args [String] optional URL arguments # :dsid [String] Datastore id to create the image # :f_dsid [String] Files Datastore id # :notemplate [Bool] if true do not create vm_template (if any) # :template [Integer] Template id to use with image # :default_template [String] Default template id for vCenter # @return [Hash] # :image [Array] of the new image # :image_type [String] of the new image (CONTEXT, KERNEL, CDROM) # :vmtemplate [Array] of the associated vm_template (if any) # :service_template [Array] empty [] def export_image() rc_info = { :image => [], :image_type => nil, :vmtemplate => [], :service_template => [] } #--------------------------------------------------------------- # Create the image template #--------------------------------------------------------------- tmpl = '' if self['APPTEMPLATE64'] tmpl = Base64.decode64(self['APPTEMPLATE64']) end tmpl << <<-EOT NAME = "#{[:name]}" FROM_APP = "#{self['ID']}" EOT if [:url_args] tmpl << "URL_ARGS=\"#{[:url_args]}\"\n" end #--------------------------------------------------------------- # Kernel or context images stored in a files datastore #--------------------------------------------------------------- dsid = [:dsid] if tmpl.match(/^\s*TYPE\s*=\s*KERNEL|CONTEXT\s/i) if [:f_dsid] dsid = [:f_dsid] else dspool = DatastorePool.new(@client) rc = dspool.info return { :image => [rc] } if OpenNebula.is_error?(rc) file_ds = dspool.select {|d| d['TYPE'].to_i == 2 } dsid = file_ds.first['ID'].to_i end end ds = OpenNebula::Datastore.new_with_id(dsid, @client) rc = ds.info is_vcenter = !OpenNebula.is_error?(rc) && (ds['TEMPLATE/DRIVER'] == 'vcenter') if is_vcenter && [:template].nil? = () end #--------------------------------------------------------------- # Allocate the image in OpenNebula #--------------------------------------------------------------- image = Image.new(Image.build_xml, @client) rc = image.allocate(tmpl, dsid) if OpenNebula.is_error?(rc) rc_info[:image] = [rc] return rc_info end image.info image.delete_element('TEMPLATE/FORMAT') image.delete_element('TEMPLATE/DRIVER') image.delete_element('TEMPLATE/DEV_PREFIX') if is_vcenter image.update(image.template_xml) rc_info[:image] = [image.id] rc_info[:image_type] = image.type_str #--------------------------------------------------------------- # Created an associated VMTemplate if needed #--------------------------------------------------------------- if (self['TEMPLATE/VMTEMPLATE64'].nil? && !is_vcenter) || [:notemplate] || [:template] == -1 return rc_info end if ![:template].nil? template_id = [:template] if template_id < 0 raise 'Invalid option, template_id must be a valid ID' end template = Template.new_with_id(template_id, @client) vmtpl_id = template.clone( [:vmtemplate_name] || [:name] ) tmpl << <<-EOT NAME = "#{[:vmtemplate_name] || [:name]}" DISK = [ IMAGE_ID = "#{image.id}" ] EOT template = Template.new_with_id(vmtpl_id, @client) template.update(tmpl, true) rc_info[:vmtemplate] = [vmtpl_id] else tmpl = Base64.decode64(self['TEMPLATE/VMTEMPLATE64']) tmpl << <<-EOT NAME = "#{[:vmtemplate_name] || [:name]}" DISK = [ IMAGE_ID = "#{image.id}" ] EOT vmtpl = Template.new(Template.build_xml, @client) rc = vmtpl.allocate(tmpl) rc = vmtpl.id unless OpenNebula.is_error?(rc) rc_info[:vmtemplate] = [rc] end rc_info end # Export complex template from marketplace # # @param name [Hash] Export options # @param ds_id [Integer] Datastore ID to export child apps def export_vm_template() rc = { :image => [], :image_type => nil, :vmtemplate => [], :service_template => [] } vmtmpl = export_recursive('//DISK', ) do |disks| create_vm_template(, disks) end rc[:vmtemplate] = [vmtmpl[0]] unless OpenNebula.is_error?(vmtmpl[0]) rc[:image] += vmtmpl[1] rc[:vmtemplate] += vmtmpl[2] unless [:notemplate] end rc end # Export service template from marketplace # # @param name [Hash] Export options # @param ds_id [Integer] Datastore ID to export child apps def export_service_template() rc = { :image => [], :image_type => nil, :vmtemplate => [], :service_template => [] } stmpl = export_recursive('//ROLE', ) do |roles| create_service_template(, roles) end rc[:service_template] = [stmpl[0]] unless OpenNebula.is_error?(stmpl[0]) rc[:image] += stmpl[1] rc[:vmtemplate] += stmpl[2] end rc end def (, _validate = false) vcenterrc_path = "#{VAR_LOCATION}/remotes/etc/vmm/vcenter/vcenterrc" if File.file?(vcenterrc_path) config_vcenter = YAML.load_file(vcenterrc_path) if config_vcenter.key?(:default_template) [:template] = config_vcenter[:default_template] else raise "Couldn't find default_template " \ 'configuration in vcenterrc conf ' \ 'file. Please use the --template ' \ 'file to define a VM Template ID if ' \ 'needed or add default_template to' \ ' vcenterrc conf file' end else raise "Couldn't find vcenterrc conf file. " \ ' Please use the --template file to define' \ ' a VM Template ID if needed.' end end # Creates a VM template based on the APPTEMPLATE64 attribute # @param [Hash] options # :export_name [String] name of the vm template # @param [Hash] disks exported disks from related apps. # As returned by the export_image method # # @return [Integer, OpenNebula::Error] template id or error def create_vm_template(, disks) dsid = [:dsid] ds = OpenNebula::Datastore.new_with_id(dsid, @client) rc = ds.info is_vcenter = !OpenNebula.is_error?(rc) && (ds['TEMPLATE/DRIVER'] == 'vcenter') if is_vcenter if [:template].nil? = () end template_id = [:template] if template_id < 0 return end template = Template.new_with_id(template_id, @client) vmtpl_id = template.clone( [:vmtemplate_name] || [:name] ) vmtpl = Template.new_with_id(vmtpl_id, @client) rc = vmtpl.info else # ---------------------------------------------------------- # Allocate Template # ---------------------------------------------------------- if self['TEMPLATE/APPTEMPLATE64'].nil? return Error.new( "Missing APPTEMPLATE64 for App #{id}" ) end tmpl = Base64.decode64(self['TEMPLATE/APPTEMPLATE64']) tmpl << "\nNAME=\"#{[:name]}\"\n" vmtpl = Template.new(Template.build_xml, @client) rc = vmtpl.allocate(tmpl) end return rc if OpenNebula.is_error?(rc) # -------------------------------------------------------------- # Update disk information in template # -------------------------------------------------------------- vmtpl.info context = [] disks.each do |_app, disk| id = disk[:image] case disk[:image_type] when 'IMAGE', 'OS', 'DATABLOCK', 'CDROM' vmtpl.add_element('TEMPLATE', 'DISK' => { 'IMAGE_ID' => id.first }) when 'CONTEXT' context << "$FILE[IMAGE_ID=\"#{id}\"]" when 'KERNEL' if !vmtpl.has_elements?('TEMPLATE/OS') vmtpl.add_element('TEMPLATE', 'OS'=>{}) end vmtpl.add_element( 'TEMPLATE/OS', 'KERNEL_DS' => "$FILE[IMAGE_ID=#{id}]" ) end end if !context.empty? if !vmtpl.has_elements?('TEMPLATE/CONTEXT') vmtpl.add_element('TEMPLATE', 'CONTEXT' => {}) end vmtpl.add_element('TEMPLATE/CONTEXT', 'FILES_DS' => context.join(' ')) end # -------------------------------------------------------------- # Update template information in OpenNebula # -------------------------------------------------------------- vmtpl.update(vmtpl.template_xml) vmtpl.id end # Creates a Service template based on the VMTEMPLATE64 attribute # @return [Integer, OpenNebula::Error] template id or error def create_service_template(, roles) # -------------------------------------------------------------- # Allocate Template # -------------------------------------------------------------- if self['TEMPLATE/APPTEMPLATE64'].nil? return Error.new("Missing APPTEMPLATE64 for App #{id}") end tmpl = Base64.decode64(self['TEMPLATE/APPTEMPLATE64']) tmpl = JSON.parse(tmpl) tmpl['name'] = [:name] # -------------------------------------------------------------- # Append template IDs to each role information # -------------------------------------------------------------- tmpl['roles'].each do |role| t_id = roles.find {|_, v| v[:names].include?(role['name']) } if t_id.nil? || t_id[1].nil? || t_id[1][:vmtemplate].nil? next end role['vm_template'] = nil role['vm_template'] = t_id[1][:vmtemplate][0] end # -------------------------------------------------------------- # Allocate Service template in OpenNebula # -------------------------------------------------------------- stmpl = ServiceTemplate.new(ServiceTemplate.build_xml, @client) rc = stmpl.allocate(tmpl.to_json) rc = stmpl.id unless OpenNebula.is_error?(rc) rc end # Export complex template from marketplace # # @param xpath [String] Xpath to search childs # @param options [Hash] Export options # @param ds_id [Integer] Datastore ID to export child apps def export_recursive(xpath, ) # Get marketplace apps pool to find roles apps pool = OpenNebula::MarketPlaceAppPool.new(@client) rc = pool.info return rc if OpenNebula.is_error?(rc) # Apps that have been already exported # # app_name => # :vmtempalte = exported template ID # :image = exported image ID # :image_type = type (KERNEL, CONTEXT...) of image # :names = [name_a, name_b, ...] exported = {} idx = 0 # Store IDs of created resources images = [] templates = [] # Iterate over all childs rc = retrieve_xmlelements(xpath).each do |obj| # Get name and app information obj_name = obj['NAME'] app = obj['APP'] # If the app was already exported, do not export it again if exported[app] exported[app][:names] << obj_name next end # Find app in pool obj = pool.find {|p| p['NAME'] == app } break Error.new("App `#{app}` not found") unless obj obj.extend(MarketPlaceAppExt) rc = obj.export( :dsid => [:dsid], :name => "#{[:name]}-#{idx}", :notemplate => [:notemplate] ) image = rc[:image].first if rc[:image] vmtemplate = rc[:vmtemplate].first if rc[:vmtemplate] break image if OpenNebula.is_error?(image) break vmtemplate if OpenNebula.is_error?(vmtemplate) idx += 1 # Update exported hash with information exported[app] = rc exported[app][:names] = [obj_name] # Add IDs to return object images << image templates << vmtemplate end if block_given? && !OpenNebula.is_error?(rc) rc = yield(exported) end if OpenNebula.is_error?(rc) rc_rbck = rollback_export(exported, xpath != '//DISK') return rc_rbck if OpenNebula.is_error?(rc_rbck) end [rc, images, templates] end # Delete templates/images in case something went wrong # # @param exported [Hash] Exported apps information # @param template [Boolean] True to delete VM Template # False to delete images # # @return [nil | OpenNebula::Error] def rollback_export(exported, is_template) ret = '' if is_template obj_factory = lambda {|v| id = v[:vmtemplate].first [Template.new_with_id(id, @client), "Error deleting template #{id}"] } delete_method = 'delete(true)' else obj_factory = lambda {|v| id = v[:image].first [Image.new_with_id(id, @client), "Error deleting image #{id}"] } delete_method = 'delete' end exported.each do |_, v| obj, err_msg = obj_factory.call(v) next unless OpenNebula.is_error?(obj.send(delete_method)) ret << err_msg end if ret.empty? nil else Error.new(ret) unless ret.empty? end end end super end |