Class: OpenNebula::ServiceTemplate

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

Overview

Service Template

Constant Summary collapse

VM_ROLE_SCHEMA = 
{
    :type => :object,
    :properties => {
        'name' => {
            :type => :string,
            :required => true,
            :regex => /^\w+$/
        },
        'type' => {
            :type => :string,
            :enum => [
                'vm'
            ],
            :required => true
        },
        'cardinality' => {
            :type => :integer,
            :default => 0,
            :minimum => 0
        },
        'template_id' => {
            :type => :integer,
            :required => true
        },
        'template_contents' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'user_inputs' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'user_inputs_values' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'parents' => {
            :type => :array,
            :items => {
                :type => :string
            }
        },
        'shutdown_action' => {
            :type => :string,
            :enum => [
                '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 => [
                            '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 => [
                            '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
                    }
                }
            }
        }
    }
}
VR_ROLE_SCHEMA = 
{
    :type => :object,
    :properties => {
        'name' => {
            :type => :string,
            :required => true,
            :regex => /^\w+$/
        },
        'type' => {
            :type => :string,
            :enum => [
                'vr'
            ],
            :required => true
        },
        'template_id' => {
            :type => :integer,
            :required => true
        },
        'cardinality' => {
            :type => :integer,
            :default => 0,
            :minimum => 0
        },
        'template_contents' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'user_inputs' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'user_inputs_values' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'on_hold' => {
            :type => :boolean,
            :required => false
        },
        'parents' => {
            :type => :array,
            :items => {
                :type => :string
            }
        }
    }
}
SCHEMA = 
{
    :type => :object,
    :properties => {
        'name' => {
            :type => :string,
            :required => true
        },
        'deployment' => {
            :type => :string,
            :enum => ['none', 'straight'],
            :default => 'none'
        },
        'description' => {
            :type => :string,
            :default => ''
        },
        'shutdown_action' => {
            :type => :string,
            :enum => [
                'terminate',
                'terminate-hard',
                'shutdown',
                'shutdown-hard'
            ],
            :required => false
        },
        'roles' => {
            :type => :array,
            :items => [],
            :required => true
        },
        'user_inputs' => {
            :type => :object,
            :properties => {},
            :required => false
        },
        'user_inputs_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

[
    'registration_time'
]
DOCUMENT_TYPE = 
101

Constants inherited from DocumentJSON

DocumentJSON::TEMPLATE_TAG

Constants inherited from Document

Document::DOCUMENT_METHODS

Instance Attribute Summary

Attributes inherited from PoolElement

#name

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, 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

.convert_template(body) ⇒ Object

Compatibility function to translate a service template from the old format to the new one with vRouters with other data model changes

Parameters:

  • template (String) —

    Hash body of the service template to translate



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/opennebula/flow/service_template.rb', line 808

def self.convert_template(body)
    body['roles'].each do |role|
        # Mandatory
        role['template_id'] = role['vm_template'].to_i
        role['type']        = 'vm'

        # Optional attributes
        role['user_inputs']        = role['custom_attrs'] if role['custom_attrs']
        body['user_inputs_values'] = role['custom_attrs_values'] \
                                     if body['custom_attrs_values']

        # Change name and type (string -> object)
        role['template_contents'] = ServiceTemplate.upgrade_template_contents(
            role['vm_template_contents']
        ) if role['vm_template_contents']

        # Remove old attributes
        role.delete('vm_template')
        role.delete('vm_template_contents') if role['vm_template_contents']
        role.delete('custom_attrs') if role['custom_attrs']
        role.delete('custom_attrs_values') if role['custom_attrs_values']
    end

    body['user_inputs'] = body['custom_attrs'] if body['custom_attrs']
    body['user_inputs_values'] = body['custom_attrs_values'] if body['custom_attrs_values']

    body.delete('custom_attrs') if body['custom_attrs']
    body.delete('custom_attrs_values') if body['custom_attrs_values']
rescue StandardError => e
    return OpenNebula::Error.new(
        'An old service template format (OpenNebula v6.x) was detected and could not be ' \
        'automatically converted. Update it manually to the new format. Error: ' + e.message
    )
end

.init_default_vn_name_template(vn_name_template) ⇒ Object 



312
313
314
315
316
 
# File 'lib/opennebula/flow/service_template.rb', line 312

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

.old_format?(body) ⇒ Boolean

Returns:

  • (Boolean) 


798
799
800
801
802
 
# File 'lib/opennebula/flow/service_template.rb', line 798

def self.old_format?(body)
    body.key?('roles') && body['roles'].all? do |role|
        role.key?('vm_template') || role.key?('vm_template_contents')
    end
end

.upgrade_template_contents(vm_template_contents) ⇒ Hash, OpenNebula::Error

Converts a RAW string in the form KEY = VAL to a hash

Parameters:

  • template (String) —

    Raw string content in the form KEY = VAL, representing vm_template_contents

Returns:

  • (Hash, OpenNebula::Error) —

    Hash representation of the raw content, or an OpenNebula Error if the conversion fails



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'lib/opennebula/flow/service_template.rb', line 849

def self.upgrade_template_contents(vm_template_contents)
    return {} if vm_template_contents.nil? || vm_template_contents.empty?

    result = {}

    vm_template_contents.split(/\n(?![^\[]*\])/).each do |line|
        next unless line.include?('=')

        key, value = line.split('=', 2).map(&:strip)
        value = value.tr('"', '')

        # If the value is an array (e.g., NIC = [ ... ]),
        # process the content inside the brackets
        if value.start_with?('[') && value.end_with?(']')
            # Split the elements inside the brackets by commas
            array_elements = value[1..-2].split(/\s*,\s*/)

            # Create a hash combining all key-value pairs in the array
            array_result = {}
            array_elements.each do |element|
                sub_key, sub_value = element.split('=', 2).map(&:strip)
                array_result[sub_key] = sub_value
            end

            value = [array_result]
        else
            value = [value]
        end

        # If the key already exists in the result hash, add the new value
        if result[key]
            if result[key].is_a?(Array)
                result[key] << value.first
            else
                result[key] = [result[key], value.first]
            end
        else
            result[key] = value.first
        end
    end

    result.each do |key, val|
        if val.is_a?(Hash)
            result[key] = [val]
        end
    end

    result
end

.validate(template) ⇒ Object 



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/opennebula/flow/service_template.rb', line 530

def self.validate(template)
    # Compability mode v<7.0
    rc = ServiceTemplate.convert_template(template) \
        if ServiceTemplate.old_format?(template)

    raise Validator::ParseException(rc.message) if OpenNebula.is_error?(rc)

    validator = Validator::Validator.new(
        :default_values => true,
        :delete_extra_properties => false,
        :allow_extra_properties => true
    )

    validator.validate!(template, SCHEMA)

    template['roles'].each do |role|
        validate_role(role)
    end

    validate_values(template)
end

.validate_role(template) ⇒ Object 



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/opennebula/flow/service_template.rb', line 552

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

    tmplt_type = template.fetch('type', 'vm')

    case tmplt_type
    when 'vm'
        validator.validate!(template, VM_ROLE_SCHEMA)
    when 'vr'
        validator.validate!(template, VR_ROLE_SCHEMA)
    else
        raise Validator::ParseException, "Unsupported role type \"#{template['type']}\""
    end
end

.validate_values(template) ⇒ Object 



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/opennebula/flow/service_template.rb', line 600

def self.validate_values(template)
    roles = template['roles']

    roles.each_with_index do |role, role_index|
        # General verification (applies to all roles)
        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

        # Specific values verification per role type
        case role['type']
        when 'vm'
            parser = ElasticityGrammarParser.new
            validate_vmvalues(role, parser)
        when 'vr'
            validate_vrvalues(role)
        else
            raise Validator::ParseException,
                  "Unsupported role type \"#{template['type']}\""
        end
    end
end

.validate_vmvalues(vmrole, parser) ⇒ Object 



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/opennebula/flow/service_template.rb', line 665

def self.validate_vmvalues(vmrole, parser)
    if !vmrole['min_vms'].nil? &&
        vmrole['min_vms'].to_i > vmrole['cardinality'].to_i

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

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

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

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

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

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

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

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

    return unless vmrole['scheduled_policies']

    vmrole['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 '#{vmrole['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 '#{vmrole['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 '#{vmrole['name']}', scheduled policy " \
                      "##{index} 'recurrence' is not a valid " \
                      'cron expression'
            end
        else
            raise Validator::ParseException,
                  "Role '#{vmrole['name']}', scheduled policy #" \
                  "#{index} needs to define either " \
                  "'start_time' or 'recurrence'"
        end
    end
end

.validate_vrvalues(vrrole) ⇒ Object

Raises:



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/opennebula/flow/service_template.rb', line 644

def self.validate_vrvalues(vrrole)
    nic_array   = vrrole.dig('template_contents', 'NIC')
    cardinality = vrrole['cardinality']

    return if nic_array.nil? || !nic_array.is_a?(Array)

    contains_floating_key = nic_array.any? do |nic|
        nic.keys.any? do |key|
            key.to_s.start_with?('FLOATING')
        end
    end

    return unless cardinality > 1 && !contains_floating_key

    raise(
        Validator::ParseException,
        "Role '#{vrrole['name']}' with 'cardinality' greather " \
        'than one must define a floating IP'
    )
end

Instance Method Details

#allocate(template_json) ⇒ Object 



320
321
322
323
324
325
326
327
 
# File 'lib/opennebula/flow/service_template.rb', line 320

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



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/opennebula/flow/service_template.rb', line 498

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



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

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['template_id']

        # if the template has already been cloned, just update the value
        if cloned_templates.keys.include?(t_id)
            role['template_id'] = 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['template_id'] = 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



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

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

#handle_nested_values(template, extra_template) ⇒ Object 



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/opennebula/flow/service_template.rb', line 758

def handle_nested_values(template, extra_template)
    roles        = template['roles']
    extra_roles  = extra_template.fetch('roles', [])

    # Check if nics key already exist
    template_nets = template['networks_values'] || []
    extra_nets    = extra_template['networks_values'] || []

    unless extra_nets.empty?
        extra_nets.each do |extra_net|
            next unless extra_net.is_a?(Hash) && !extra_net.empty?

            net_name  = extra_net.keys.first
            net_index = template_nets.index {|net| net.key?(net_name) }

            if net_index
                template_nets[net_index] = extra_net
            else
                template_nets << extra_net
            end
        end

        template['networks_values']       = template_nets
        extra_template['networks_values'] = []
    end

    return template if extra_roles.empty?

    roles.each_with_index do |role, index|
        extra_role = extra_roles.find {|item| item['name'] == role['name'] }
        next unless extra_role

        roles[index] = role.deep_merge(extra_role)
    end

    extra_template.delete('roles')

    template
end

#instantiate(merge_template) ⇒ Object 



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

def instantiate(merge_template)
    rc = nil

    if merge_template.nil?
        instantiate_template = JSON.parse(@body.to_json)
    else
        @body = handle_nested_values(@body, merge_template)

        instantiate_template = JSON.parse(@body.to_json)
                                   .deep_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



368
369
370
 
# File 'lib/opennebula/flow/service_template.rb', line 368

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:



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

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:



526
527
528
 
# File 'lib/opennebula/flow/service_template.rb', line 526

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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/opennebula/flow/service_template.rb', line 629

def vm_template_ids
    rc = info

    return rc if OpenNebula.is_error?(rc)

    ret = []

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

    ret
end