opennebula-oca 3.8.0.beta1

data/lib/OpenNebula/DocumentPoolJSON.rb

@@ -0,0 +1,58 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 OpenNebula
+    class DocumentPoolJSON < DocumentPool
+
+        TEMPLATE_TAG = "BODY"
+
+        def factory(element_xml)
+            doc = OpenNebula::DocumentJSON.new(element_xml, @client)
+            doc.load_body
+            doc
+        end
+
+        # Generates a json representing the object
+        #
+        # @param [true, false] pretty_generate
+        # @return [String] json representing the object
+        #
+        def to_json(pretty_generate=true)
+            hash = self.to_hash
+
+            if hash['DOCUMENT_POOL'] && hash['DOCUMENT_POOL']['DOCUMENT']
+                if !hash['DOCUMENT_POOL']['DOCUMENT'].instance_of?(Array)
+                    array = [hash['DOCUMENT_POOL']['DOCUMENT']]
+                    hash['DOCUMENT_POOL']['DOCUMENT'] = array.compact
+                end
+
+                hash['DOCUMENT_POOL']['DOCUMENT'].each { |doc|
+                    body = doc['TEMPLATE']["#{TEMPLATE_TAG}"]
+                    if body
+                        b_hash = JSON.parse(body)
+                        doc['TEMPLATE']["#{TEMPLATE_TAG}"] = b_hash
+                    end
+                }
+            end
+
+            if pretty_generate
+                JSON.pretty_generate hash
+            else
+                hash.to_json
+            end
+        end
+    end
+end

data/lib/OpenNebula/Group.rb

@@ -0,0 +1,161 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 Group < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+        GROUP_METHODS = {
+            :info     => "group.info",
+            :allocate => "group.allocate",
+            :delete   => "group.delete",
+            :quota    => "group.quota"
+        }
+
+        # Flag for requesting connected user's group info
+        SELF = -1
+
+        #Default location for group ACL's
+        if ENV['ONE_LOCATION']
+            GROUP_DEFAULT = ENV['ONE_LOCATION'] + "/etc/group.default"
+        else
+            GROUP_DEFAULT = "/etc/one/group.default"
+        end
+
+        # Creates a Group description with just its identifier
+        # this method should be used to create plain Group objects.
+        # +id+ the id of the user
+        #
+        # Example:
+        #   group = Group.new(Group.build_xml(3),rpc_client)
+        #
+        def Group.build_xml(pe_id=nil)
+            if pe_id
+                group_xml = "<GROUP><ID>#{pe_id}</ID></GROUP>"
+            else
+                group_xml = "<GROUP></GROUP>"
+            end
+
+            XMLElement.build_xml(group_xml,'GROUP')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+        end
+
+        #######################################################################
+        # Group utils
+        #######################################################################
+
+        # Creates ACLs for the group. The ACL rules are described in a file
+        def create_acls(filename = GROUP_DEFAULT)
+            if !File.readable?(filename)
+                return -1, "Cannot read deafult ACL file for group"
+            end
+
+            msg = String.new
+
+            File.open(filename).each_line{ |l|
+                next if l.match(/^#/)
+
+                rule  = "@#{@pe_id} #{l}"
+                parse = OpenNebula::Acl.parse_rule(rule)
+
+                if OpenNebula.is_error?(parse)
+                    return -1, "Error parsing rule #{rule}: #{parse.message}"
+                end
+
+                xml = OpenNebula::Acl.build_xml
+                acl = OpenNebula::Acl.new(xml, @client)
+
+                rc = acl.allocate(*parse)
+
+                if OpenNebula.is_error?(rc)
+                    return -1, "Error creating rule #{rule}: #{rc.message}"
+                else
+                    msg << "ACL_ID: #{acl.id}\n"
+                end
+            }
+
+            return 0, msg
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Group Object
+        #######################################################################
+
+        # Retrieves the information of the given Group.
+        def info()
+            super(GROUP_METHODS[:info], 'GROUP')
+        end
+
+        # Allocates a new Group in OpenNebula
+        #
+        # +groupname+ A string containing the name of the Group.
+        def allocate(groupname)
+            super(GROUP_METHODS[:allocate], groupname)
+        end
+
+        # Deletes the Group
+        def delete()
+            super(GROUP_METHODS[:delete])
+        end
+
+        # Sets the group quota limits
+        # @param quota [String] a template (XML or txt) with the new quota limits 
+        # 
+        # @return [nil, OpenNebula::Error] nil in case of success, Error
+        #   otherwise
+        def set_quota(quota)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(GROUP_METHODS[:quota],@pe_id, quota)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
+        # ---------------------------------------------------------------------
+        # Helpers to get information
+        # ---------------------------------------------------------------------
+
+        # Returns whether or not the user with id 'uid' is part of this group
+        def contains(uid)
+            #This doesn't work in ruby 1.8.5
+            #return self["USERS/ID[.=#{uid}]"] != nil
+
+            id_array = retrieve_elements('USERS/ID')
+            return id_array != nil && id_array.include?(uid.to_s)
+        end
+
+        # Returns an array with the numeric user ids
+        def user_ids
+            array = Array.new
+
+            self.each("USERS/ID") do |id|
+                array << id.text.to_i
+            end
+
+            return array
+        end
+    end
+end

data/lib/OpenNebula/GroupPool.rb

@@ -0,0 +1,54 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 GroupPool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+
+        GROUP_POOL_METHODS = {
+            :info => "grouppool.info"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('GROUP_POOL','GROUP',client)
+        end
+
+        # Factory method to create User objects
+        def factory(element_xml)
+            OpenNebula::Group.new(element_xml,@client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the User Object
+        #######################################################################
+
+        # Retrieves all the Groups in the pool.
+        def info()
+            super(GROUP_POOL_METHODS[:info])
+        end
+    end
+end

data/lib/OpenNebula/Host.rb

@@ -0,0 +1,199 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 Host < PoolElement
+        #######################################################################
+        # Constants and Class Methods
+        #######################################################################
+
+
+        HOST_METHODS = {
+            :info       => "host.info",
+            :allocate   => "host.allocate",
+            :delete     => "host.delete",
+            :enable     => "host.enable",
+            :update     => "host.update",
+            :monitoring => "host.monitoring"
+        }
+
+        HOST_STATES=%w{INIT MONITORING_MONITORED MONITORED ERROR DISABLED MONITORING_ERROR}
+
+        SHORT_HOST_STATES={
+            "INIT"                 => "init",
+            "MONITORING_MONITORED" => "update",
+            "MONITORED"            => "on",
+            "ERROR"                => "err",
+            "DISABLED"             => "off",
+            "MONITORING_ERROR"     => "retry",
+        }
+
+        # Creates a Host description with just its identifier
+        # this method should be used to create plain Host objects.
+        # +id+ the id of the host
+        #
+        # Example:
+        #   host = Host.new(Host.build_xml(3),rpc_client)
+        #
+        def Host.build_xml(pe_id=nil)
+            if pe_id
+                host_xml = "<HOST><ID>#{pe_id}</ID></HOST>"
+            else
+                host_xml = "<HOST></HOST>"
+            end
+
+            XMLElement.build_xml(host_xml, 'HOST')
+        end
+
+        # Class constructor
+        def initialize(xml, client)
+            super(xml,client)
+
+            @client = client
+            @pe_id  = self['ID'].to_i if self['ID']
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Host
+        #######################################################################
+
+        # Retrieves the information of the given Host.
+        def info()
+            super(HOST_METHODS[:info], 'HOST')
+        end
+
+        # Allocates a new Host in OpenNebula
+        #
+        # @param hostname [String] Name of the new Host.
+        # @param im [String] Name of the im_driver (information/monitoring)
+        # @param vmm [String] Name of the vmm_driver (hypervisor)
+        # @param tm [String] Name of the vnm_driver (networking)
+        # @param cluster_id [String] Id of the cluster
+        #
+        # @return [Integer, OpenNebula::Error] the new ID in case of
+        #   success, error otherwise
+        def allocate(hostname,im,vmm,vnm,cluster_id=ClusterPool::NONE_CLUSTER_ID)
+            super(HOST_METHODS[:allocate],hostname,im,vmm,vnm,cluster_id)
+        end
+
+        # Deletes the Host
+        def delete()
+            super(HOST_METHODS[:delete])
+        end
+
+        # Enables the Host
+        def enable()
+            set_enabled(true)
+        end
+
+        # Disables the Host
+        def disable()
+            set_enabled(false)
+        end
+
+        def flush()
+            self.disable
+
+            vm_pool = OpenNebula::VirtualMachinePool.new(@client,
+                                                VirtualMachinePool::INFO_ALL_VM)
+
+            rc = vm_pool.info
+            if OpenNebula.is_error?(rc)
+                 puts rc.message
+                 exit -1
+            end
+
+            vm_pool.each do |vm|
+                hid = vm['HISTORY_RECORDS/HISTORY[last()]/HID']
+                if hid == self['ID']
+                    vm.resched
+                end
+            end
+        end
+
+        # Replaces the template contents
+        #
+        # +new_template+ New template contents
+        def update(new_template)
+            super(HOST_METHODS[:update], new_template)
+        end
+
+        # Retrieves this Host's monitoring data from OpenNebula
+        #
+        # @param [Array<String>] xpath_expressions Elements to retrieve.
+        #
+        # @return [Hash<String, Array<Array<int>>>, OpenNebula::Error] Hash with
+        #   the requested xpath expressions, and an Array of 'timestamp, value'.
+        #
+        # @example
+        #   host.monitoring( ['HOST_SHARE/FREE_CPU', 'HOST_SHARE/RUNNING_VMS'] )
+        #
+        #   { "HOST_SHARE/RUNNING_VMS" =>
+        #       [["1337266000", "1"],
+        #        ["1337266044", "1"],
+        #        ["1337266088", "3"]],
+        #     "HOST_SHARE/FREE_CPU" =>
+        #       [["1337266000", "800"],
+        #        ["1337266044", "800"],
+        #        ["1337266088", "800"]]
+        #   }
+        def monitoring(xpath_expressions)
+            return super(HOST_METHODS[:monitoring], 'HOST',
+                'LAST_MON_TIME', xpath_expressions)
+        end
+
+        # Retrieves this Host's monitoring data from OpenNebula, in XML
+        #
+        # @return [String] Monitoring data, in XML
+        def monitoring_xml()
+            return Error.new('ID not defined') if !@pe_id
+
+            return @client.call(HOST_METHODS[:monitoring], @pe_id)
+        end
+
+        #######################################################################
+        # Helpers to get Host information
+        #######################################################################
+
+        # Returns the state of the Host (numeric value)
+        def state
+            self['STATE'].to_i
+        end
+
+        # Returns the state of the Host (string value)
+        def state_str
+            HOST_STATES[state]
+        end
+
+        # Returns the state of the Host (string value)
+        def short_state_str
+            SHORT_HOST_STATES[state_str]
+        end
+
+    private
+        def set_enabled(enabled)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(HOST_METHODS[:enable], @pe_id, enabled)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+    end
+end

data/lib/OpenNebula/HostPool.rb

@@ -0,0 +1,91 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2012, OpenNebula Project Leads (OpenNebula.org)             #
+#                                                                            #
+# 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 HostPool < Pool
+        #######################################################################
+        # Constants and Class attribute accessors
+        #######################################################################
+
+
+        HOST_POOL_METHODS = {
+            :info       => "hostpool.info",
+            :monitoring => "hostpool.monitoring"
+        }
+
+        #######################################################################
+        # Class constructor & Pool Methods
+        #######################################################################
+
+
+        # +client+ a Client object that represents a XML-RPC connection
+        def initialize(client)
+            super('HOST_POOL','HOST',client)
+        end
+
+        # Factory Method for the Host Pool
+        def factory(element_xml)
+            OpenNebula::Host.new(element_xml,@client)
+        end
+
+        #######################################################################
+        # XML-RPC Methods for the Host Pool 
+        #######################################################################
+
+        # Retrieves all the Hosts in the pool.
+        def info()
+            super(HOST_POOL_METHODS[:info])
+        end
+
+        # Retrieves the monitoring data for all the Hosts in the pool
+        #
+        # @param [Array<String>] xpath_expressions Elements to retrieve.
+        #
+        # @return [Hash<String, <Hash<String, Array<Array<int>>>>>,
+        #   OpenNebula::Error] The first level hash uses the Host ID as keys,
+        #   and as value a Hash with the requested xpath expressions,
+        #   and an Array of 'timestamp, value'.
+        #
+        # @example
+        #   host_pool.monitoring(
+        #     ['HOST_SHARE/FREE_CPU',
+        #     'HOST_SHARE/RUNNING_VMS',
+        #     'TEMPLATE/CUSTOM_PROBE'] )
+        #
+        #   {"1"=>
+        #     {"TEMPLATE/CUSTOM_PROBE"=>[],
+        #      "HOST_SHARE/FREE_CPU"=>[["1337609673", "800"]],
+        #      "HOST_SHARE/RUNNING_VMS"=>[["1337609673", "3"]]},
+        #    "0"=>
+        #     {"TEMPLATE/CUSTOM_PROBE"=>[],
+        #      "HOST_SHARE/FREE_CPU"=>[["1337609673", "800"]],
+        #      "HOST_SHARE/RUNNING_VMS"=>[["1337609673", "3"]]}}
+        def monitoring(xpath_expressions)
+            return super(HOST_POOL_METHODS[:monitoring],
+                'HOST', 'LAST_MON_TIME', xpath_expressions)
+        end
+
+        # Retrieves the monitoring data for all the Hosts in the pool, in XML
+        #
+        # @return [String] VM monitoring data, in XML
+        def monitoring_xml()
+            return @client.call(HOST_POOL_METHODS[:monitoring])
+        end
+    end
+end