opennebula 3.9.80.beta

data/lib/opennebula/acl_pool.rb

@@ -0,0 +1,55 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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 AclPool < Pool
+
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+
+        ACL_POOL_METHODS = {
+            :info       => "acl.info",
+            :addrule    => "acl.addrule",
+            :delrule    => "acl.delrule"
+        }
+
+        # Class constructor
+        def initialize(client)
+            super('ACL_POOL','ACL',client)
+        end
+
+        def factory(element_xml)
+            OpenNebula::Acl.new(element_xml, @client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods
+        #######################################################################
+
+        # Retrieves the ACL Pool
+        def info()
+        # Retrieves all the Acls in the pool.
+            super(ACL_POOL_METHODS[:info])
+        end
+
+        alias_method :info!, :info
+    end
+end

data/lib/opennebula/client.rb

@@ -0,0 +1,119 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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 'xmlrpc/client'
+
+module OpenNebula
+    if OpenNebula::NOKOGIRI
+        class NokogiriStreamParser < XMLRPC::XMLParser::AbstractStreamParser
+            def initialize
+                @parser_class = NokogiriParser
+            end
+
+            class NokogiriParser < Nokogiri::XML::SAX::Document
+                include XMLRPC::XMLParser::StreamParserMixin
+
+                alias :cdata_block :character
+                alias :characters :character
+                alias :end_element :endElement
+                alias :start_element :startElement
+
+                def parse(str)
+                    parser = Nokogiri::XML::SAX::Parser.new(self)
+                    parser.parse(str)
+                end
+            end
+        end
+    end
+
+    # The client class, represents the connection with the core and handles the
+    # xml-rpc calls.
+    class Client
+        attr_accessor :one_auth
+
+        begin
+            require 'xmlparser'
+            XMLPARSER=true
+        rescue LoadError
+            XMLPARSER=false
+        end
+
+        # Creates a new client object that will be used to call OpenNebula
+        # functions.
+        #
+        # @param [String, nil] secret user credentials ("user:password") or
+        #   nil to get the credentials from user auth file
+        # @param [String, nil] endpoint OpenNebula server endpoint
+        #   (http://host:2633/RPC2) or nil to get it form the environment
+        #   variable ONE_XMLRPC or use the default endpoint
+        # @param [Hash] options
+        # @option params [Integer] :timeout connection timeout in seconds,
+        #   defaults to 30
+        #
+        # @return [OpenNebula::Client]
+        def initialize(secret=nil, endpoint=nil, options={})
+            if secret
+                @one_auth = secret
+            elsif ENV["ONE_AUTH"] and !ENV["ONE_AUTH"].empty? and
+                    File.file?(ENV["ONE_AUTH"])
+                @one_auth = File.read(ENV["ONE_AUTH"])
+            elsif File.file?(ENV["HOME"]+"/.one/one_auth")
+                @one_auth = File.read(ENV["HOME"]+"/.one/one_auth")
+            else
+                raise "ONE_AUTH file not present"
+            end
+
+            @one_auth.rstrip!
+
+            if endpoint
+                @one_endpoint = endpoint
+            elsif ENV["ONE_XMLRPC"]
+                @one_endpoint = ENV["ONE_XMLRPC"]
+            else
+                @one_endpoint = "http://localhost:2633/RPC2"
+            end
+
+            timeout=nil
+            timeout=options[:timeout] if options[:timeout]
+
+            @server = XMLRPC::Client.new2(@one_endpoint, nil, timeout)
+
+            if OpenNebula::NOKOGIRI
+                @server.set_parser(NokogiriStreamParser.new)
+            elsif XMLPARSER
+                @server.set_parser(XMLRPC::XMLParser::XMLStreamParser.new)
+            end
+        end
+
+        def call(action, *args)
+            begin
+                response = @server.call_async("one."+action, @one_auth, *args)
+
+                if response[0] == false
+                    Error.new(response[1], response[2])
+                else
+                    response[1] #response[1..-1]
+                end
+            rescue Exception => e
+                Error.new(e.message)
+            end
+        end
+
+        def get_version()
+            call("system.version")
+        end
+    end
+end

data/lib/opennebula/cluster.rb

@@ -0,0 +1,249 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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 Cluster < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        CLUSTER_METHODS = {
+            :info           => "cluster.info",
+            :allocate       => "cluster.allocate",
+            :delete         => "cluster.delete",
+            :addhost        => "cluster.addhost",
+            :delhost        => "cluster.delhost",
+            :adddatastore   => "cluster.adddatastore",
+            :deldatastore   => "cluster.deldatastore",
+            :addvnet        => "cluster.addvnet",
+            :delvnet        => "cluster.delvnet",
+            :update         => "cluster.update",
+        }
+
+        # Creates a Cluster description with just its identifier
+        # this method should be used to create plain Cluster objects.
+        # +id+ the id of the host
+        #
+        # Example:
+        #   cluster = Cluster.new(Cluster.build_xml(3),rpc_client)
+        #
+        def Cluster.build_xml(pe_id=nil)
+            if pe_id
+                cluster_xml = "<CLUSTER><ID>#{pe_id}</ID></CLUSTER>"
+            else
+                cluster_xml = "<CLUSTER></CLUSTER>"
+            end
+
+            XMLElement.build_xml(cluster_xml,'CLUSTER')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Cluster Object
+        #######################################################################
+
+        # Retrieves the information of the given Cluster.
+        def info()
+            super(CLUSTER_METHODS[:info], 'CLUSTER')
+        end
+
+        alias_method :info!, :info
+
+        # Allocates a new Cluster in OpenNebula
+        #
+        # +clustername+ A string containing the name of the Cluster.
+        def allocate(clustername)
+            super(CLUSTER_METHODS[:allocate], clustername)
+        end
+
+        # Deletes the Cluster
+        def delete()
+            super(CLUSTER_METHODS[:delete])
+        end
+
+        # Adds a Host to this Cluster
+        # @param hid [Integer] Host ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def addhost(hid)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:addhost], @pe_id, hid)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Deletes a Host from this Cluster
+        # @param hid [Integer] Host ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delhost(hid)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:delhost], @pe_id, hid)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Adds a Datastore to this Cluster
+        # @param ds_id [Integer] Datastore ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def adddatastore(ds_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:adddatastore], @pe_id, ds_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Deletes a Datastore from this Cluster
+        # @param ds_id [Integer] Datastore ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def deldatastore(ds_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:deldatastore], @pe_id, ds_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Adds a VNet to this Cluster
+        # @param vnet_id [Integer] VNet ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def addvnet(vnet_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:addvnet], @pe_id, vnet_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Deletes a VNet from this Cluster
+        # @param vnet_id [Integer] VNet ID
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def delvnet(vnet_id)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(CLUSTER_METHODS[:delvnet], @pe_id, vnet_id)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # Replaces the template contents
+        #
+        # @param new_template [String] New template contents
+        #
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def update(new_template)
+            super(CLUSTER_METHODS[:update], new_template)
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # Returns whether or not the host with 'id' is part of this cluster
+        # @param id [Integer|Array] host ID
+        # @return [Boolean] true if found 
+        def contains_host?(id)
+            contains_resource?('HOSTS/ID', id)
+        end
+
+        # Returns an array with the numeric host ids
+        # @return [Array<Integer>]
+        def host_ids
+            array = Array.new
+
+            self.each("HOSTS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+
+        # Returns whether or not the datastore with 'id' is part of this cluster
+        # @param id [Integer|Array] datastore ID
+        # @return [Boolean] true if found 
+        def contains_datastore?(id)
+            contains_resource?('DATASTORES/ID', id)
+        end
+
+        # Returns an array with the numeric datastore ids
+        # @return [Array<Integer>]
+        def datastore_ids
+            array = Array.new
+
+            self.each("DATASTORES/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+
+        # Returns whether or not the vnet with 'id' is part of this cluster
+        # @param id [Integer|Arrray] vnet ID
+        # @return [Boolean] true if found 
+        def contains_vnet?(id)
+            contains_resource?('VNETS/ID', id)
+        end
+
+        # Returns an array with the numeric vnet ids
+        # @return [Array<Integer>]
+        def vnet_ids
+            array = Array.new
+
+            self.each("VNETS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+
+        private
+
+        def contains_resource?(xpath, id)
+            id_array = retrieve_elements(xpath)
+
+            return false if id_array.nil?
+
+            id = [id] if id.class != Array
+
+            id.each { |i| 
+                return false if !id_array.include?(i.to_s)
+            }
+
+            return true
+        end
+    end
+end

data/lib/opennebula/cluster_pool.rb

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2013, OpenNebula Project (OpenNebula.org), C12G Labs        #
+#                                                                            #
+# 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 ClusterPool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+        NONE_CLUSTER_ID      = -1
+        DEFAULT_CLUSTER_ID   = 0
+
+        CLUSTER_POOL_METHODS = {
+            :info => "clusterpool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('CLUSTER_POOL','CLUSTER',client)
+        end
+
+        # Factory method to create Cluster objects
+        def factory(element_xml)
+            OpenNebula::Cluster.new(element_xml,@client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Cluster Object
+        #######################################################################
+
+        # Retrieves all the Clusters in the pool.
+        def info()
+            super(CLUSTER_POOL_METHODS[:info])
+        end
+
+        alias_method :info!, :info
+    end
+end