Class: OpenNebula::ServiceTemplate

Inherits:
DocumentJSON show all
Defined in:
lib/opennebula/flow/service_template.rb

Overview

Service Template

Constant Summary collapse

ROLE_SCHEMA = 
{
    :type => :object,
    :properties => {
        'name' => {
            :type => :string,
            :required => true,
            :regex => /^\w+$/
        },
        'cardinality' => {
            :type => :integer,
            :default => 1,
            :minimum => 0
        },
        'vm_template' => {
            :type => :integer,
            :required => true
        },
        'vm_template_contents' => {
            :type => :string,
            :required => false
        },
        'parents' => {
            :type => :array,
            :items => {
                :type => :string
            }
        },
        'shutdown_action' => {
            :type => :string,
            :enum => %w[
                terminate
                terminate-hard
                shutdown
                shutdown-hard
            ],
            :required => false
        },
        'min_vms' => {
            :type => :integer,
            :required => false,
            :minimum => 0
        },
        'max_vms' => {
            :type => :integer,
            :required => false,
            :minimum => 0
        },
        'cooldown' => {
            :type => :integer,
            :required => false,
            :minimum => 0
        },
        'on_hold' => {
            :type => :boolean,
            :required => false
        },
        'elasticity_policies' => {
            :type => :array,
            :items => {
                :type => :object,
                :properties => {
                    'type' => {
                        :type => :string,
                        :enum => %w[
                            CHANGE
                            CARDINALITY
                            PERCENTAGE_CHANGE
                        ],
                        :required => true
                    },
                    'adjust' => {
                        :type => :integer,
                        :required => true
                    },
                    'min_adjust_step' => {
                        :type => :integer,
                        :required => false,
                        :minimum => 1
                    },
                    'period_number' => {
                        :type => :integer,
                        :required => false,
                        :minimum => 0
                    },
                    'period' => {
                        :type => :integer,
                        :required => false,
                        :minimum => 0
                    },
                    'expression' => {
                        :type => :string,
                        :required => true
                    },
                    'cooldown' => {
                        :type => :integer,
                        :required => false,
                        :minimum => 0
                    }
                    # 'statistic' => {
                    # # SampleCount | Average | Sum | Minimum | Maximum
                    #    :type => :string
                    # }
                }
            }
        },
        'scheduled_policies' => {
            :type => :array,
            :items => {
                :type => :object,
                :properties => {
                    'type' => {
                        :type => :string,
                        :enum => %w[
                            CHANGE
                            CARDINALITY
                            PERCENTAGE_CHANGE
                        ],
                        :required => true
                    },
                    'adjust' => {
                        :type => :integer,
                        :required => true
                    },
                    'min_adjust_step' => {
                        :type => :integer,
                        :required => false,
                        :minimum => 1
                    },
                    'start_time' => {
                        :type => :string,
                        :required => false
                    },
                    'recurrence' => {
                        :type => :string,
                        :required => false
                    }
                }
            }
        }
    }
}
SCHEMA = 
{
    :type => :object,
    :properties => {
        'name' => {
            :type => :string,
            :required => true
        },
        'deployment' => {
            :type => :string,
            :enum => %w[none straight],
            :default => 'none'
        },
        'description' => {
            :type => :string,
            :default => ''
        },
        'shutdown_action' => {
            :type => :string,
            :enum => %w[
                terminate
                terminate-hard
                shutdown
                shutdown-hard
            ],
            :required => false
        },
        'roles' => {
            :type => :array,
            :items => ROLE_SCHEMA,
            :required => true
        },
        'custom_attrs' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'custom_attrs_values' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'ready_status_gate' => {
            :type => :boolean,
            :required => false
        },
        'automatic_deletion' => {
            :type => :boolean,
            :required => false
        },
        'networks' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'networks_values' => {
            :type => :array,
            :items => {
                :type => :object,
                :properties => {}
            },
            :required => false
        },
        'on_hold' => {
            :type => :boolean,
            :required => false
        }
    }
}
IMMUTABLE_ATTRS =

List of attributes that can’t be changed in update operation

registration_time: this is internal info managed by OneFlow server

%w[
    registration_time
]
DOCUMENT_TYPE = 
101

Constants inherited from DocumentJSON

DocumentJSON::TEMPLATE_TAG

Constants inherited from Document

Document::DOCUMENT_METHODS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DocumentJSON

#allocate_xml, #build_template_xml, #info, #load_body, #template_tag, #to_json

Methods inherited from Document

build_xml, #chmod, #chmod_octet, #chown, #document_type, #gid, #info, #initialize, #owner_id, #public?, #rename

Methods inherited from PoolElement

#id, #name, new_with_id, #replace, #to_str

Methods inherited from XMLElement

#[], #add_element, #attr, build_xml, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize, #initialize_xml, #name, #retrieve_elements, #retrieve_xmlelements, #set_content, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml, #xml_nil?

Constructor Details

This class inherits a constructor from OpenNebula::Document

Class Method Details

.init_default_vn_name_template(vn_name_template) ⇒ Object 



242
243
244
245
246
 
# File 'lib/opennebula/flow/service_template.rb', line 242

def self.init_default_vn_name_template(vn_name_template)
    # rubocop:disable Style/ClassVars
    @@vn_name_template = vn_name_template
    # rubocop:enable Style/ClassVars
end

.validate(template) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/opennebula/flow/service_template.rb', line 461

def self.validate(template)
    validator = Validator::Validator.new(
        :default_values => true,
        :delete_extra_properties => false,
        :allow_extra_properties => true
    )

    validator.validate!(template, SCHEMA)

    validate_values(template)
end

.validate_role(template) ⇒ Object 



473
474
475
476
477
478
479
480
481
 
# File 'lib/opennebula/flow/service_template.rb', line 473

def self.validate_role(template)
    validator = Validator::Validator.new(
        :default_values => true,
        :delete_extra_properties => false,
        :allow_extra_properties => true
    )

    validator.validate!(template, ROLE_SCHEMA)
end

.validate_values(template) ⇒ Object 



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
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/opennebula/flow/service_template.rb', line 510

def self.validate_values(template)
    parser = ElasticityGrammarParser.new

    roles = template['roles']

    roles.each_with_index do |role, role_index|
        roles[role_index+1..-1].each do |other_role|
            if role['name'] == other_role['name']
                raise Validator::ParseException,
                      "Role name '#{role['name']}' is repeated"
            end
        end

        if !role['min_vms'].nil? &&
           role['min_vms'].to_i > role['cardinality'].to_i

            raise Validator::ParseException,
                  "Role '#{role['name']}' 'cardinality' must be " \
                  "greater than or equal to 'min_vms'"
        end

        if !role['max_vms'].nil? &&
           role['max_vms'].to_i < role['cardinality'].to_i

            raise Validator::ParseException,
                  "Role '#{role['name']}' 'cardinality' must be " \
                  "lower than or equal to 'max_vms'"
        end

        if ((role['elasticity_policies'] &&
            !role['elasticity_policies'].empty?) ||
           (role['scheduled_policies'] &&
           !role['scheduled_policies'].empty?)) &&
           (role['min_vms'].nil? || role['max_vms'].nil?)
            raise Validator::ParseException,
                  "Role '#{role['name']}' with " \
                  " 'elasticity_policies' or " \
                  "'scheduled_policies'must define both 'min_vms'" \
                  " and 'max_vms'"
        end

        if role['elasticity_policies']
            role['elasticity_policies'].each_with_index do |policy,
                                                            index|
                exp = policy['expression']

                if exp.empty?
                    raise Validator::ParseException,
                          "Role '#{role['name']}', elasticity policy " \
                          "##{index} 'expression' cannot be empty"
                end

                treetop = parser.parse(exp)
                next unless treetop.nil?

                raise Validator::ParseException,
                      "Role '#{role['name']}', elasticity policy " \
                      "##{index} 'expression' parse error: " \
                      "#{parser.failure_reason}"
            end
        end

        next unless role['scheduled_policies']

        role['scheduled_policies'].each_with_index do |policy, index|
            start_time = policy['start_time']
            recurrence = policy['recurrence']

            if !start_time.nil?
                if !policy['recurrence'].nil?
                    raise Validator::ParseException,
                          "Role '#{role['name']}', scheduled policy "\
                          "##{index} must define "\
                          "'start_time' or 'recurrence', but not both"
                end

                begin
                    next if start_time.match(/^\d+$/)

                    Time.parse(start_time)
                rescue ArgumentError
                    raise Validator::ParseException,
                          "Role '#{role['name']}', scheduled policy " \
                          "##{index} 'start_time' is not a valid " \
                          'Time. Try with YYYY-MM-DD hh:mm:ss or ' \
                          '0YYY-MM-DDThh:mm:ssZ'
                end
            elsif !recurrence.nil?
                begin
                    cron_parser = CronParser.new(recurrence)
                    cron_parser.next
                rescue StandardError
                    raise Validator::ParseException,
                          "Role '#{role['name']}', scheduled policy " \
                          "##{index} 'recurrence' is not a valid " \
                          'cron expression'
                end
            else
                raise Validator::ParseException,
                      "Role '#{role['name']}', scheduled policy #" \
                      "#{index} needs to define either " \
                      "'start_time' or 'recurrence'"
            end
        end
    end
end

Instance Method Details

#allocate(template_json) ⇒ Object 



250
251
252
253
254
255
256
257
258
 
# File 'lib/opennebula/flow/service_template.rb', line 250

def allocate(template_json)
    template = JSON.parse(template_json)

    ServiceTemplate.validate(template)

    template['registration_time'] = Integer(Time.now)

    super(template.to_json, template['name'])
end

#clone(name) ⇒ Integer

Clones a service template

Parameters:

  • name (Stirng) —

    New name

Returns:

  • (Integer) —

    New template ID



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/opennebula/flow/service_template.rb', line 429

def clone(name)
    new_id = super

    doc = OpenNebula::ServiceTemplate.new_with_id(new_id, @client)
    rc  = doc.info

    return rc if OpenNebula.is_error?(rc)

    body = JSON.parse(doc["TEMPLATE/#{TEMPLATE_TAG}"])

    # add registration time, as the template is new
    body['registration_time'] = Integer(Time.now)

    # update the template with the new body
    DocumentJSON.instance_method(:update).bind(doc).call(body.to_json)

    # return the new document ID
    new_id
end

#clone_recursively(name, mode) ⇒ Integer

Clone service template and the VM templates asssociated to it

Parameters:

  • name (String) —

    New template name

  • mode (Symbol) —

    Cloning mode (:all, :templates)

Returns:

  • (Integer) —

    New document ID



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
 
# File 'lib/opennebula/flow/service_template.rb', line 351

def clone_recursively(name, mode)
    recursive = mode == 'all'

    # clone the document to get new ID
    new_id = clone(name)

    return new_id if OpenNebula.is_error?(new_id)

    doc = OpenNebula::ServiceTemplate.new_with_id(new_id, @client)
    rc  = doc.info

    return rc if OpenNebula.is_error?(rc)

    body             = JSON.parse(doc["TEMPLATE/#{TEMPLATE_TAG}"])
    cloned_templates = {}

    # iterate over roles to clone templates
    rc = body['roles'].each do |role|
        t_id = role['vm_template']

        # if the template has already been cloned, just update the value
        if cloned_templates.keys.include?(t_id)
            role['vm_template'] = cloned_templates[t_id]
            next
        end

        template = OpenNebula::Template.new_with_id(t_id, @client)
        rc       = template.info

        break rc if OpenNebula.is_error?(rc)

        # The maximum size is 128, so crop the template name if it
        # exceeds the limit
        new_name = "#{template.name}-#{name}"

        if new_name.size > 119
            new_name = "#{template.name[0..(119 - name.size)]}-#{name}"
        end

        rc = template.clone(new_name, recursive)

        break rc if OpenNebula.is_error?(rc)

        # add new ID to the hash
        cloned_templates[t_id] = rc

        role['vm_template'] = rc
    end

    # if any error, rollback and delete the left templates
    if OpenNebula.is_error?(rc)
        cloned_templates.each do |_, value|
            template = OpenNebula::Template.new_with_id(value, @client)

            rc = template.info

            break rc if OpenNebula.is_error?(rc)

            rc = template.delete(recursive)

            break rc if OpenNebula.is_error?(rc)
        end

        return rc
    end

    # update the template with the new body
    doc.update(body.to_json)

    # return the new document ID
    new_id
end

#delete(type = nil) ⇒ Object

Delete service template

Parameters:

  • type (String) (defaults to: nil) —

    Delete type

    • none: just the service template

    • all: delete VM templates, images and service template

    • templates: delete VM templates and service template



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
 
# File 'lib/opennebula/flow/service_template.rb', line 266

def delete(type = nil)
    case type
    when 'all'
        recursive = true
    when 'templates'
        recursive = false
    end

    if type && type != 'none'
        rc = vm_template_ids

        return rc if OpenNebula.is_error?(rc)

        rc = rc.each do |t_id|
            t  = OpenNebula::Template.new_with_id(t_id, @client)
            rc = t.info

            break rc if OpenNebula.is_error?(rc)

            rc = t.delete(recursive)

            break rc if OpenNebula.is_error?(rc)
        end
    end

    return rc if OpenNebula.is_error?(rc)

    super()
end

#instantiate(merge_template) ⇒ Object 



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
 
# File 'lib/opennebula/flow/service_template.rb', line 483

def instantiate(merge_template)
    rc = nil

    if merge_template.nil?
        instantiate_template = JSON.parse(@body.to_json)
    else
        instantiate_template = JSON.parse(@body.to_json)
                                   .merge(merge_template)
    end

    begin
        ServiceTemplate.validate(instantiate_template)

        xml     = OpenNebula::Service.build_xml
        service = OpenNebula::Service.new(xml, @client)

        rc = service.allocate(instantiate_template.to_json)
    rescue Validator::ParseException, JSON::ParserError => e
        return e
    end

    return rc if OpenNebula.is_error?(rc)

    service.info
    service
end

#template ⇒ String

Retrieves the template

Returns:

  • (String) —

    json template



299
300
301
 
# File 'lib/opennebula/flow/service_template.rb', line 299

def template
    @body.to_json
end

#update(template_json, append = false) ⇒ nil, OpenNebula::Error

Replaces the template contents

Parameters:

  • template_json (String) —

    New template contents

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



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
 
# File 'lib/opennebula/flow/service_template.rb', line 311

def update(template_json, append = false)
    rc = info

    return rc if OpenNebula.is_error?(rc)

    template = JSON.parse(template_json)

    if append
        IMMUTABLE_ATTRS.each do |attr|
            unless template[attr].nil?
                return [false, "service_template/#{attr}"]
            end
        end
    else
        IMMUTABLE_ATTRS.each do |attr|
            # Allows updating the template without
            # specifying the immutable attributes
            if template[attr].nil?
                template[attr] = @body[attr]
            end

            next if template[attr] == @body[attr]

            return [false, "service_template/#{attr}"]
        end
    end

    template = @body.merge(template) if append

    ServiceTemplate.validate(template)

    super(template.to_json)
end

#update_raw(template_raw, append = false) ⇒ nil, OpenNebula::Error

Replaces the raw template contents

Parameters:

  • template (String) —

    New template contents, in the form KEY = VAL

  • append (true, false) (defaults to: false) —

    True to append new attributes instead of replace the whole template

Returns:



457
458
459
 
# File 'lib/opennebula/flow/service_template.rb', line 457

def update_raw(template_raw, append = false)
    super(template_raw, append)
end

#vm_template_ids ⇒ Array

Retreives all associated VM templates IDs

Returns:

  • (Array) —

    VM templates IDs



620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/opennebula/flow/service_template.rb', line 620

def vm_template_ids
    rc = info

    return rc if OpenNebula.is_error?(rc)

    ret = []

    @body['roles'].each do |role|
        t_id = Integer(role['vm_template'])
        ret << t_id unless ret.include?(t_id)
    end

    ret
end