opennebula 5.12.13 → 5.13.80.pre

data/lib/{models → opennebula/flow}/service_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -34,7 +34,7 @@ module OpenNebula
     end
 
     # ServicePool class
-    class ServicePool
+    class ServicePool < Pool
 
         # rubocop:disable Style/ClassVars
         @@mutex      = Mutex.new
@@ -53,6 +53,13 @@ module OpenNebula
             @cloud_auth = cloud_auth
             @client     = client
             @one_pool   = nil
+
+            if @client
+                info     = Nokogiri::XML(@client.call('user.info', -1))
+                @user_id = Integer(info.xpath('/USER/ID').text)
+            end
+
+            super('DOCUMENT_POOL', 'DOCUMENT', @client)
         end
 
         def client
@@ -93,6 +100,23 @@ module OpenNebula
             @one_pool.each(&block)
         end
 
+        # Iterates over pool pages
+        # size:: nil => default page size
+        #        > 0 => page size
+        # state state of objects
+        def each_page(size)
+            loop_page(size, Service::DOCUMENT_TYPE, false) do |element, page|
+                page.each("//#{element}") do |obj|
+                    service = Service.new_with_id(obj['ID'], @client)
+                    service.info
+
+                    yield(service)
+                end
+
+                size
+            end
+        end
+
         # Retrieves a Service element from OpenNebula. The Service::info()
         # method is called
         #

data/lib/{models → opennebula/flow}/service_template.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #
@@ -18,7 +18,7 @@ require 'parse-cron'
 
 module OpenNebula
 
-    # Service Tempalte
+    # Service Template
     class ServiceTemplate < DocumentJSON
 
         ROLE_SCHEMA = {
@@ -204,6 +204,10 @@ module OpenNebula
                     :type => :boolean,
                     :required => false
                 },
+                'automatic_deletion' => {
+                    :type => :boolean,
+                    :required => false
+                },
                 'networks' => {
                     :type => :object,
                     :properties => {},
@@ -220,6 +224,13 @@ module OpenNebula
             }
         }
 
+        # List of attributes that can't be changed in update operation
+        #
+        # registration_time: this is internal info managed by OneFlow server
+        IMMUTABLE_ATTRS = %w[
+            registration_time
+        ]
+
         def self.init_default_vn_name_template(vn_name_template)
             # rubocop:disable Style/ClassVars
             @@vn_name_template = vn_name_template
@@ -233,9 +244,47 @@ module OpenNebula
 
             ServiceTemplate.validate(template)
 
+            template['registration_time'] = Integer(Time.now)
+
             super(template.to_json, template['name'])
         end
 
+        # Delete service template
+        #
+        # @param type [String] Delete type
+        #   - none: just the service template
+        #   - all: delete VM templates, images and service template
+        #   - templates: delete VM templates and service template
+        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
+
         # Retrieves the template
         #
         # @return [String] json template
@@ -252,16 +301,20 @@ module OpenNebula
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
         def update(template_json, append = false)
-            template = JSON.parse(template_json)
+            rc = info
 
-            if append
-                rc = info
+            return rc if OpenNebula.is_error?(rc)
 
-                return rc if OpenNebula.is_error?(rc)
+            template = JSON.parse(template_json)
 
-                template = @body.merge(template)
+            IMMUTABLE_ATTRS.each do |attr|
+                next if template[attr] == @body[attr]
+
+                return [false, "service_template/#{attr}"]
             end
 
+            template = @body.merge(template) if append
+
             ServiceTemplate.validate(template)
 
             super(template.to_json)
@@ -418,18 +471,16 @@ module OpenNebula
                           "lower than or equal to 'max_vms'"
                 end
 
-                if (role['elasticity_policies'] &&
+                if ((role['elasticity_policies'] &&
                     !role['elasticity_policies'].empty?) ||
                    (role['scheduled_policies'] &&
-                   !role['scheduled_policies'].empty?)
-
-                    if 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
+                   !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']
@@ -498,6 +549,24 @@ module OpenNebula
             end
         end
 
+        # Retreives all associated VM templates IDs
+        #
+        # @return [Array] VM templates IDs
+        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
+
     end
 
 end

data/lib/opennebula/flow/service_template_ext.rb

@@ -0,0 +1,84 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+# Module to decorate ServiceTemplate class with additional helpers not directly
+# exposed through the OpenNebula XMLRPC API. The extensions include
+#   - mp_import helper that imports a template into a marketplace
+#
+# rubocop:disable Style/ClassAndModuleChildren
+module OpenNebula::ServiceTemplateExt
+
+    def self.extend_object(obj)
+        if !obj.is_a?(OpenNebula::ServiceTemplate)
+            raise StandardError, "Cannot extended #{obj.class} " \
+                                 'with MarketPlaceAppExt'
+        end
+
+        class << obj
+
+            ####################################################################
+            # Public extended interface
+            ####################################################################
+            # Imports service template into marketplace
+            #
+            # @param templates [Hash]    Service roles templates information
+            # @param market_id [Integer] Marketplace ID to import app
+            # @param name      [String]  Service Template App name
+            def mp_import(templates, market_id, name)
+                template = ''
+                name   ||= "#{@body['name']}-#{SecureRandom.hex[0..9]}"
+
+                template = <<-EOT
+                NAME      = "#{name}"
+                ORIGIN_ID = "-1"
+                TYPE      = "SERVICE_TEMPLATE"
+                APPTEMPLATE64 = "#{Base64.strict_encode64(@body.to_json)}"
+                EOT
+
+                # Add VM template name into roles information
+                @body['roles'].each do |role|
+                    # Find role template into templates to get the name to use
+                    t = templates.find do |_, v|
+                        v[:template]['ID'].to_i == role['vm_template']
+                    end
+
+                    next if t.nil? || t[1].nil? || t[1][:name].nil?
+
+                    app_name = t[1][:name]
+
+                    template << <<-EOT
+                    ROLE = [ NAME="#{role['name']}", APP="#{app_name}"]
+                    EOT
+
+                    role.delete('vm_template')
+                end
+
+                xml = MarketPlaceApp.build_xml
+                app = MarketPlaceApp.new(xml, @client)
+                rc  = app.allocate(template, market_id)
+
+                if OpenNebula.is_error?(rc)
+                    [-1, rc]
+                else
+                    [0, app.id]
+                end
+            end
+
+        end
+    end
+
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/{models → opennebula/flow}/service_template_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2023, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
 #                                                                            #
 # Licensed under the Apache License, Version 2.0 (the "License"); you may    #
 # not use this file except in compliance with the License. You may obtain    #