opennebula 4.14.2 → 4.90.0.beta1

data/lib/opennebula/image.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2015, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2016, 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    #
@@ -41,7 +41,8 @@ module OpenNebula
             :snapshotflatten=> "image.snapshotflatten"
         }
 
-        IMAGE_STATES=%w{INIT READY USED DISABLED LOCKED ERROR CLONE DELETE USED_PERS}
+        IMAGE_STATES=%w{INIT READY USED DISABLED LOCKED ERROR CLONE DELETE
+            USED_PERS LOCKED_USED LOCKED_USED_PERS}
 
         SHORT_IMAGE_STATES={
             "INIT"      => "init",
@@ -52,7 +53,9 @@ module OpenNebula
             "ERROR"     => "err",
             "CLONE"     => "clon",
             "DELETE"    => "dele",
-            "USED_PERS" => "used"
+            "USED_PERS" => "used",
+            "LOCKED_USED" => "lock",
+            "LOCKED_USED_PERS" => "lock"
         }
 
         IMAGE_TYPES=%w{OS CDROM DATABLOCK KERNEL RAMDISK CONTEXT}
@@ -252,6 +255,7 @@ module OpenNebula
         def snapshot_flatten(snap_id)
             return call(IMAGE_METHODS[:snapshotflatten], @pe_id, snap_id)
         end
+
         #######################################################################
         # Helpers to get Image information
         #######################################################################

data/lib/opennebula/image_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2015, OpenNebula Project, OpenNebula Systems                #
+# Copyright 2002-2016, 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    #
@@ -23,7 +23,6 @@ module OpenNebula
         # Constants and Class attribute accessors
         #######################################################################
 
-
         IMAGE_POOL_METHODS = {
             :info => "imagepool.info"
         }

data/lib/opennebula/ldap_auth.rb

@@ -1,5 +1,5 @@
 # ---------------------------------------------------------------------------- #
-# Copyright 2002-2015, OpenNebula Project, OpenNebula Systems                  #
+# Copyright 2002-2016, 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      #

data/lib/opennebula/ldap_auth_spec.rb

@@ -1,5 +1,5 @@
 # ---------------------------------------------------------------------------- #
-# Copyright 2002-2015, OpenNebula Project, OpenNebula Systems                  #
+# Copyright 2002-2016, 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      #

data/lib/opennebula/marketplace.rb

@@ -0,0 +1,161 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2016, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'opennebula/pool_element'
+
+module OpenNebula
+    class MarketPlace < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        MARKETPLACE_METHODS = {
+            :info       => "market.info",
+            :allocate   => "market.allocate",
+            :delete     => "market.delete",
+            :update     => "market.update",
+            :chown      => "market.chown",
+            :chmod      => "market.chmod",
+            :rename     => "market.rename"
+        }
+
+        # Creates a MarketPlace description with just its identifier
+        # this method should be used to create plain MarketPlace objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   marketplace = MarketPlace.new(MarketPlace.build_xml(3),rpc_client)
+        #
+        def MarketPlace.build_xml(pe_id=nil)
+            if pe_id
+                marketplace_xml = "<MARKETPLACE><ID>#{pe_id}</ID></MARKETPLACE>"
+            else
+                marketplace_xml = "<MARKETPLACE></MARKETPLACE>"
+            end
+
+            XMLElement.build_xml(marketplace_xml,'MARKETPLACE')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the MarketPlace Object
+        #######################################################################
+
+        # Retrieves the information of the given marketplace.
+        def info()
+            super(MARKETPLACE_METHODS[:info], 'MARKETPLACE')
+        end
+
+        alias_method :info!, :info
+
+        # Allocates a new marketplace in OpenNebula
+        #
+        # @param description [String] The template of the marketplace.
+        #
+        # @return [Integer, OpenNebula::Error] the new ID in case of
+        #   success, error otherwise
+        def allocate(description)
+            super(MARKETPLACE_METHODS[:allocate], description)
+        end
+
+        # Deletes the marketplace
+        def delete()
+            super(MARKETPLACE_METHODS[:delete])
+        end
+
+        # Replaces the template contents
+        #
+        # @param new_template [String] New template contents
+        # @param append [true, false] True to append new attributes instead of
+        #   replace the whole template
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def update(new_template, append=false)
+            super(MARKETPLACE_METHODS[:update], new_template, append ? 1 : 0)
+        end
+
+        # Changes the owner/group
+        #
+        # @param uid [Integer] the new owner id. Set to -1 to leave the current one
+        # @param gid [Integer] the new group id. Set to -1 to leave the current one
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chown(uid, gid)
+            super(MARKETPLACE_METHODS[:chown], uid, gid)
+        end
+
+        # Changes the marketplace permissions.
+        #
+        # @param octet [String] Permissions octed , e.g. 640
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod_octet(octet)
+            super(MARKETPLACE_METHODS[:chmod], octet)
+        end
+
+        # Changes the marketplace permissions.
+        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
+                other_m, other_a)
+            super(MARKETPLACE_METHODS[:chmod], owner_u, owner_m, owner_a, group_u,
+                group_m, group_a, other_u, other_m, other_a)
+        end
+
+        # Renames this marketplace
+        #
+        # @param name [String] New name for the marketplace
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def rename(name)
+            return call(MARKETPLACE_METHODS[:rename], @pe_id, name)
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # Returns whether or not the marketplace app with id 'id' is part of
+        # this marketplace
+        def contains(id)
+            #This doesn't work in ruby 1.8.5
+            #return self["MARKETPLACE/MARKETPLACEAPPS/ID[.=#{uid}]"] != nil
+
+            id_array = retrieve_elements('MARKETPLACEAPPS/ID')
+            return id_array != nil && id_array.include?(uid.to_s)
+        end
+
+        # Returns an array with the numeric image ids
+        def marketapp_ids
+            array = Array.new
+
+            self.each("MARKETPLACEAPPS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+    end
+end

data/lib/opennebula/marketplace_pool.rb

@@ -0,0 +1,55 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2016, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+
+require 'opennebula/pool'
+
+module OpenNebula
+    class MarketPlacePool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+        MARKETPLACE_POOL_METHODS = {
+            :info => "marketpool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('MARKETPLACE_POOL','MARKETPLACE', client)
+        end
+
+        # Factory method to create MarketPlace objects
+        def factory(element_xml)
+            OpenNebula::MarketPlace.new(element_xml, @client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the User Object
+        #######################################################################
+
+        # Retrieves all the marketplace apps
+        def info()
+            super(MARKETPLACE_POOL_METHODS[:info])
+        end
+
+        alias_method :info!, :info
+    end
+end

data/lib/opennebula/marketplaceapp.rb

@@ -0,0 +1,267 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2016, 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.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'opennebula/pool_element'
+
+module OpenNebula
+    class MarketPlaceApp < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        MARKETPLACEAPP_METHODS = {
+            :info       => "marketapp.info",
+            :allocate   => "marketapp.allocate",
+            :delete     => "marketapp.delete",
+            :update     => "marketapp.update",
+            :chown      => "marketapp.chown",
+            :chmod      => "marketapp.chmod",
+            :rename     => "marketapp.rename",
+            :enable     => "marketapp.enable"
+        }
+
+        MARKETPLACEAPP_STATES=%w{INIT READY LOCKED ERROR DISABLED}
+
+        SHORT_MARKETPLACEAPP_STATES={
+            "INIT"      => "ini",
+            "READY"     => "rdy",
+            "LOCKED"    => "lck",
+            "ERROR"     => "err",
+            "DISABLED"  => "dis"
+        }
+
+        MARKETPLACEAPP_TYPES=%w{UNKNOWN IMAGE VMTEMPLATE SERVICE_TEMPLATE}
+
+        SHORT_MARKETPLACEAPP_TYPES = {
+            "UNKNOWN"           => "unk",
+            "IMAGE"             => "img",
+            "VMTEMPLATE"        => "tpl",
+            "SERVICE_TEMPLATE"  => "srv"
+        }
+        # Creates a MarketPlace description with just its identifier
+        # this method should be used to create plain MarketPlace objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #  app = MarketPlaceApp.new(MarketPlace.build_xml(3),rpc_client)
+        #
+        def MarketPlaceApp.build_xml(pe_id=nil)
+            if pe_id
+                app_xml = "<MARKETPLACEAPP><ID>#{pe_id}</ID></MARKETPLACEAPP>"
+            else
+                app_xml = "<MARKETPLACEAPP></MARKETPLACEAPP>"
+            end
+
+            XMLElement.build_xml(app_xml,'MARKETPLACEAPP')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml, client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the MarketPlace Object
+        #######################################################################
+
+        # Retrieves the information of the given marketplace app
+        def info()
+            super(MARKETPLACEAPP_METHODS[:info], 'MARKETPLACEAPP')
+        end
+
+        alias_method :info!, :info
+
+        # Allocates a new MarketPlace in OpenNebula
+        #
+        # @param description [String] The template of the marketplace app
+        # @param mp_id [Integer] The id of the marketplace to create the app
+        #
+        # @return [Integer, OpenNebula::Error] the new ID in case of
+        #   success, error otherwise
+        def allocate(description, mp_id)
+            super(MARKETPLACEAPP_METHODS[:allocate], description, mp_id)
+        end
+
+        # Deletes the marketplace app
+        def delete()
+            super(MARKETPLACEAPP_METHODS[:delete])
+        end
+
+        # Replaces the template contents
+        #
+        # @param new_template [String] New template contents
+        # @param append [true, false] True to append new attributes instead of
+        #   replace the whole template
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def update(new_template, append=false)
+            super(MARKETPLACEAPP_METHODS[:update], new_template, append ? 1 : 0)
+        end
+
+        # Changes the owner/group
+        #
+        # @param uid [Integer] the new owner id. Set to -1 to leave the current one
+        # @param gid [Integer] the new group id. Set to -1 to leave the current one
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chown(uid, gid)
+            super(MARKETPLACEAPP_METHODS[:chown], uid, gid)
+        end
+
+        # Changes the marketplace app permissions.
+        #
+        # @param octet [String] Permissions octed , e.g. 640
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod_octet(octet)
+            super(MARKETPLACEAPP_METHODS[:chmod], octet)
+        end
+
+        # Changes the marketplace app permissions.
+        # Each [Integer] argument must be 1 to allow, 0 deny, -1 do not change
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def chmod(owner_u, owner_m, owner_a, group_u, group_m, group_a, other_u,
+                other_m, other_a)
+            super(MARKETPLACEAPP_METHODS[:chmod], owner_u, owner_m, owner_a,
+                group_u, group_m, group_a, other_u, other_m, other_a)
+        end
+
+        # Renames this marketplace app
+        #
+        # @param name [String] New name for the marketplace app
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def rename(name)
+            return call(MARKETPLACEAPP_METHODS[:rename], @pe_id, name)
+        end
+
+        # 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
+        #   name [String] of the new object
+        #   vmtemplate_name [String] name for the VM Template, if the App has one
+        #
+        # @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 ] }
+        def export(options={})
+            return Error.new("Missing datastore id") if options[:dsid].nil?
+            return Error.new("Missing name to export app") if options[:name].nil?
+
+            rc  = info
+            return rc if OpenNebula.is_error?(rc)
+            return Error.new("App is not in READY state") if state_str!="READY"
+
+            case type_str
+            when "IMAGE"
+                if !self['APPTEMPLATE64'].nil?
+                    tmpl=Base64::decode64(self['APPTEMPLATE64'])
+                else
+                    tmpl=""
+                end
+
+                name = options[:name] || "marketapp-#{self.id}"
+
+                tmpl << "\n"
+                tmpl << "NAME=\"" << name << "\"\n"
+                tmpl << "FROM_APP=\""       << self['ID'] << "\"\n"
+
+                image = Image.new(Image.build_xml, @client)
+                rc    = image.allocate(tmpl, options[:dsid])
+
+                return { :image => [rc] } if OpenNebula.is_error?(rc)
+
+                image_id = image.id
+                vmtpl_id = -1
+
+                if !self['TEMPLATE/VMTEMPLATE64'].nil?
+                    tmpl=Base64::decode64(self['TEMPLATE/VMTEMPLATE64'])
+
+                    tmpl_name = options[:vmtemplate_name] || name
+
+                    tmpl << "\nNAME=\"#{tmpl_name}\"\n"
+                    tmpl << "DISK=[ IMAGE_ID = #{image.id} ]\n"
+
+                    vmtpl = Template.new(Template.build_xml, @client)
+                    rc    = vmtpl.allocate(tmpl)
+
+                    if OpenNebula.is_error?(rc)
+                        return { :image => [image_id], :vmtemplate => [rc] }
+                    end
+
+                    vmtpl_id = vmtpl.id
+                end
+
+                return { :image => [image_id], :vmtemplate => [vmtpl_id] }
+            else
+                return Error.new("App type #{app.type_str} not supported")
+            end
+        end
+
+        # Enables this app
+        def enable
+            return call(MARKETPLACEAPP_METHODS[:enable], @pe_id, true)
+        end
+
+        # Enables this app
+        def disable
+            return call(MARKETPLACEAPP_METHODS[:enable], @pe_id, false)
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # Returns the marketplace app type
+        def type
+            self['TYPE'].to_i
+        end
+
+        # Returns the marketplace app type (string value)
+        def type_str
+            MARKETPLACEAPP_TYPES[type]
+        end
+
+        # Returns the marketplace app type (string value)
+        def short_type_str
+            SHORT_MARKETPLACEAPP_TYPES[type_str]
+        end
+
+        # Returns the state of the marketplace app (numeric value)
+        def state
+            self['STATE'].to_i
+        end
+
+        # Returns the state of the marketplace app (string value)
+        def state_str
+            MARKETPLACEAPP_STATES[state]
+        end
+
+        # Returns the state of the marketplace app (string value)
+        def short_state_str
+            SHORT_MARKETPLACEAPP_STATES[state_str]
+        end
+    end
+end