opennebula 4.0.1 → 4.1.80.beta

data/NOTICE

@@ -21,6 +21,9 @@ The following people have contributed to the development of the technology
 - Daniel Molina Aranda (dmolina@opennebula.org)
 - Hector Sanjuan Redondo (hsanjuan@opennebula.org)
 
+The new features for service elasticity (oneFlow) introduced in OpenNebula 4.2
+were funded by Blackberry in the context of the Fund a Feature Program.
+
 OpenNebula Project also acknowledges the contributions of C12G Labs developers.
 
 LICENSE
@@ -43,5 +46,6 @@ OpenNebula distribution includes third-party software under fully compatible
 open-source licenses. See the following directories and the NOTICE files
 they contain for more information:
 
+- share/vendor
 - src/sunstone/public/vendor
 - src/oca/java/lib

data/lib/opennebula.rb

@@ -54,5 +54,5 @@ require 'opennebula/system'
 module OpenNebula
 
     # OpenNebula version
-    VERSION = '4.0.1'
+    VERSION = '4.1.80'
 end

data/lib/opennebula/cluster.rb

@@ -162,11 +162,13 @@ module OpenNebula
         # 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)
-            super(CLUSTER_METHODS[:update], new_template)
+        def update(new_template, append=false)
+            super(CLUSTER_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # ---------------------------------------------------------------------

data/lib/opennebula/datastore.rb

@@ -106,11 +106,13 @@ module OpenNebula
         # 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)
-            super(DATASTORE_METHODS[:update], new_template)
+        def update(new_template, append=false)
+            super(DATASTORE_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Changes the owner/group

data/lib/opennebula/document.rb

@@ -120,14 +120,16 @@ module OpenNebula
         # Replaces the template contents
         #
         # @param [String] new_template 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)
+        def update(new_template, append=false)
             rc = check_type()
             return rc if OpenNebula.is_error?(rc)
 
-            super(DOCUMENT_METHODS[:update], new_template)
+            super(DOCUMENT_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Changes the owner/group

data/lib/opennebula/document_json.rb

@@ -56,15 +56,18 @@ module OpenNebula
         #
         # @params [String, nil] template_json string to be inserted in the
         #   template. If nil @body will be used instead
+        # @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(template_json=nil)
+        def update(template_json=nil, append=false)
             template_json ||= @body.to_json
 
             text = build_template_xml(template_json)
 
-            super(text)
+            super(text, append)
         end
 
         # Generates a json representing the object

data/lib/opennebula/host.rb

@@ -133,9 +133,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # +new_template+ New template contents
-        def update(new_template)
-            super(HOST_METHODS[:update], new_template)
+        # @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(HOST_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Retrieves this Host's monitoring data from OpenNebula

data/lib/opennebula/image.rb

@@ -114,10 +114,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # +new_template+ New template contents. If no argument is provided
-        #   the object will be updated using the @xml variable
-        def update(new_template=nil)
-            super(IMAGE_METHODS[:update], new_template)
+        # @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=nil, append=false)
+            super(IMAGE_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Enables an Image

data/lib/opennebula/oneflow_client.rb

@@ -0,0 +1,387 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2010-2013, C12G Labs S.L.                                        #
+#                                                                            #
+# 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 'uri'
+require 'cloud/CloudClient'
+
+include CloudCLI
+
+module Role
+    # Actions that can be performed on the VMs of a given Role
+    SCHEDULE_ACTIONS = [
+        'shutdown',
+        'shutdown-hard',
+        'undeploy',
+        'undeploy-hard',
+        'hold',
+        'release',
+        'stop',
+        'suspend',
+        'resume',
+        'boot',
+        'delete',
+        'delete-recreate',
+        'reboot',
+        'reboot-hard',
+        'poweroff',
+        'poweroff-hard',
+        'snapshot-create'
+    ]
+
+    STATE = {
+        'PENDING'            => 0,
+        'DEPLOYING'          => 1,
+        'RUNNING'            => 2,
+        'UNDEPLOYING'        => 3,
+        'WARNING'            => 4,
+        'DONE'               => 5,
+        'FAILED_UNDEPLOYING' => 6,
+        'FAILED_DEPLOYING'   => 7,
+        'SCALING'            => 8,
+        'FAILED_SCALING'     => 9,
+        'COOLDOWN'           => 10
+    }
+
+    STATE_STR = [
+        'PENDING',
+        'DEPLOYING',
+        'RUNNING',
+        'UNDEPLOYING',
+        'WARNING',
+        'DONE',
+        'FAILED_UNDEPLOYING',
+        'FAILED_DEPLOYING',
+        'SCALING',
+        'FAILED_SCALING',
+        'COOLDOWN'
+    ]
+
+    # Returns the string representation of the role state
+    # @param [String] state String number representing the state
+    # @return the state string
+    def self.state_str(state_number)
+        return STATE_STR[state_number.to_i]
+    end
+end
+
+module Service
+
+    STATE = {
+        'PENDING'            => 0,
+        'DEPLOYING'          => 1,
+        'RUNNING'            => 2,
+        'UNDEPLOYING'        => 3,
+        'WARNING'            => 4,
+        'DONE'               => 5,
+        'FAILED_UNDEPLOYING' => 6,
+        'FAILED_DEPLOYING'   => 7,
+        'SCALING'            => 8,
+        'FAILED_SCALING'     => 9,
+        'COOLDOWN'           => 10
+    }
+
+    STATE_STR = [
+        'PENDING',
+        'DEPLOYING',
+        'RUNNING',
+        'UNDEPLOYING',
+        'WARNING',
+        'DONE',
+        'FAILED_UNDEPLOYING',
+        'FAILED_DEPLOYING',
+        'SCALING',
+        'FAILED_SCALING',
+        'COOLDOWN'
+    ]
+
+    # Returns the string representation of the service state
+    # @param [String] state String number representing the state
+    # @return the state string
+    def self.state_str(state_number)
+        return STATE_STR[state_number.to_i]
+    end
+
+    # Build a json specifying an action
+    # @param [String] perform action to be performed (i.e: shutdowm)
+    # @param [Hash, nil] params contains the params for the action
+    # @return [String] json representing the action
+    def self.build_json_action(perform, params=nil)
+        body = Hash.new
+        body['perform'] = perform
+        body['params']  = params if params
+
+        action = Hash.new
+        action['action'] = body
+
+        JSON.pretty_generate action
+    end
+
+    # CLI options
+
+    DEFAULT_OPTIONS = [
+        ENDPOINT = {
+            :name => "server",
+            :short => "-s url",
+            :large => "--server url",
+            :format => String,
+            :description => "Service endpoint"
+        },
+        USERNAME={
+            :name => "username",
+            :short => "-u name",
+            :large => "--username name",
+            :format => String,
+            :description => "User name"
+        },
+        PASSWORD={
+            :name => "password",
+            :short => "-p pass",
+            :large => "--password pass",
+            :format => String,
+            :description => "User password"
+        }
+    ]
+
+    JSON_FORMAT = {
+        :name => "json",
+        :short => "-j",
+        :large => "--json",
+        :description => "Print the resource in JSON"
+    }
+
+    TOP = {
+        :name => "top",
+        :short => "-t",
+        :large => "--top",
+        :description => "Top for the command"
+    }
+
+    PERIOD = {
+        :name => "period",
+        :short => "-p x",
+        :large => "--period x",
+        :format => Integer,
+        :description => "Seconds between each group of actions"
+    }
+
+    NUMBER = {
+        :name => "number",
+        :short => "-n x",
+        :large => "--number x",
+        :format => Integer,
+        :description => "Number of VMs to apply the action to each period"
+    }
+
+    FORCE = {
+        :name => "force",
+        :short => "-f",
+        :large => "--force",
+        :description => "Force the new cardinality even if it is outside the limits"
+    }
+
+    # Format helpers
+
+#    def self.rname_to_id(name, poolname, options)
+    def self.rname_to_id(name, poolname)
+        return 0, name.to_i if name.match(/^[0123456789]+$/)
+
+        client = Service::Client.new()
+
+        resource_path = case poolname
+        when "SERVICE"          then "/service"
+        when "SERVICE TEMPLATE" then "/service_template"
+        end
+
+        response = client.get(resource_path)
+
+        if CloudClient::is_error?(response)
+            return -1, "OpenNebula #{poolname} name not found," <<
+                       " use the ID instead"
+        end
+
+        pool = JSON.parse(response.body)
+        name_to_id(name, pool, poolname)
+    end
+
+    def self.rname_to_id_desc(poolname)
+        "OpenNebula #{poolname} name or id"
+    end
+
+    def self.name_to_id(name, pool, ename)
+        if pool['DOCUMENT_POOL']['DOCUMENT'].nil?
+            return -1, "#{ename} named #{name} not found."
+        end
+
+        objects = pool['DOCUMENT_POOL']['DOCUMENT'].select {|object| object['NAME'] == name }
+
+        if objects.length>0
+            if objects.length>1
+                return -1, "There are multiple #{ename}s with name #{name}."
+            else
+                result = objects.first['ID']
+            end
+        else
+            return -1, "#{ename} named #{name} not found."
+        end
+
+        return 0, result
+    end
+
+    def self.list_to_id(names, poolname)
+
+        client = Service::Client.new()
+
+        resource_path = case poolname
+        when "SERVICE"          then "/service"
+        when "SERVICE TEMPLATE" then "/service_template"
+        end
+
+        response = client.get(resource_path)
+
+        if CloudClient::is_error?(response)
+            return -1, "OpenNebula #{poolname} name not found," <<
+                       " use the ID instead"
+        end
+
+        pool = JSON.parse(response.body)
+
+        result = names.split(',').collect { |name|
+            if name.match(/^[0123456789]+$/)
+                name.to_i
+            else
+                rc = name_to_id(name, pool, poolname)
+
+                if rc.first == -1
+                    return rc[0], rc[1]
+                end
+
+                rc[1]
+            end
+        }
+
+        return 0, result
+    end
+
+    def self.list_to_id_desc(poolname)
+        "Comma-separated list of OpenNebula #{poolname} names or ids"
+    end
+
+    # Perform an action on several resources
+    # @param [Array] ids resources ids
+    # @param [Block] block action to be performed
+    # @return [Integer] exit_code
+    def self.perform_actions(ids, &block)
+        exit_code = 0
+
+        ids.each do |id|
+            response = block.call(id)
+
+            if CloudClient::is_error?(response)
+                puts response.to_s
+                exit_code = response.code.to_i
+            end
+        end
+
+        exit_code
+    end
+
+    class Client
+        def initialize(opts={})
+            @username = opts[:username] || ENV['ONEFLOW_USER']
+            @password = opts[:password] || ENV['ONEFLOW_PASSWORD']
+
+            url = opts[:url] || ENV['ONEFLOW_URL'] || 'http://localhost:2474'
+
+            if @username.nil? && @password.nil?
+                if 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")
+                end
+
+                one_auth.rstrip!
+
+                @username, @password = one_auth.split(':')
+            end
+
+            @uri = URI.parse(url)
+
+            @user_agent = "OpenNebula #{CloudClient::VERSION} " <<
+                "(#{opts[:user_agent]||"Ruby"})"
+
+            @host = nil
+            @port = nil
+
+            if ENV['http_proxy']
+                uri_proxy  = URI.parse(ENV['http_proxy'])
+                @host = uri_proxy.host
+                @port = uri_proxy.port
+            end
+        end
+
+        def get(path)
+            req = Net::HTTP::Proxy(@host, @port)::Get.new(path)
+
+            do_request(req)
+        end
+
+        def delete(path)
+            req =Net::HTTP::Proxy(@host, @port)::Delete.new(path)
+
+            do_request(req)
+        end
+
+        def post(path, body)
+            req = Net::HTTP::Proxy(@host, @port)::Post.new(path)
+            req.body = body
+
+            do_request(req)
+        end
+
+        def put(path, body)
+            req = Net::HTTP::Proxy(@host, @port)::Put.new(path)
+            req.body = body
+
+            do_request(req)
+        end
+
+        def login
+            req = Net::HTTP::Proxy(@host, @port)::Post.new('/login')
+
+            do_request(req)
+        end
+
+        def logout
+            req = Net::HTTP::Proxy(@host, @port)::Post.new('/logout')
+
+            do_request(req)
+        end
+
+        private
+
+        def do_request(req)
+            req.basic_auth @username, @password
+
+            req['User-Agent'] = @user_agent
+
+            res = CloudClient::http_start(@uri, @timeout) do |http|
+                http.request(req)
+            end
+
+            res
+        end
+    end
+end

data/lib/opennebula/template.rb

@@ -111,11 +111,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # +new_template+ New template contents
-        def update(new_template)
-            return Error.new('ID not defined') if !@pe_id
-
-            super(TEMPLATE_METHODS[:update], new_template)
+        # @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(TEMPLATE_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Publishes the Template, to be used by other users

data/lib/opennebula/user.rb

@@ -97,9 +97,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # +new_template+ New template contents
-        def update(new_template)
-            super(USER_METHODS[:update], new_template)
+        # @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(USER_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Deletes the User

data/lib/opennebula/virtual_machine.rb

@@ -178,10 +178,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # @param new_template New template contents. If no argument is provided
-        #   the object will be updated using the @xml variable
-        def update(new_template=nil)
-            super(VM_METHODS[:update], new_template)
+        # @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=nil, append=false)
+            super(VM_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Returns the <USER_TEMPLATE> element in text form

data/lib/opennebula/virtual_network.rb

@@ -91,10 +91,14 @@ module OpenNebula
 
         # Replaces the template contents
         #
-        # +new_template+ New template contents. If no argument is provided
-        #   the object will be updated using the @xml variable
-        def update(new_template=nil)
-            super(VN_METHODS[:update], new_template)
+        # @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=nil, append=false)
+            super(VN_METHODS[:update], new_template, append ? 1 : 0)
         end
 
         # Publishes the VirtualNetwork, to be used by other users

metadata

@@ -1,59 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: opennebula
-version: !ruby/object:Gem::Version 
-  hash: 61
-  prerelease: 
-  segments: 
-  - 4
-  - 0
-  - 1
-  version: 4.0.1
+version: !ruby/object:Gem::Version
+  version: 4.1.80.beta
+  prerelease: 7
 platform: ruby
-authors: 
+authors:
 - OpenNebula
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Libraries needed to talk to OpenNebula
 email: contact@opennebula.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/opennebula.rb
 - lib/opennebula/acl.rb
 - lib/opennebula/acl_pool.rb
@@ -73,6 +68,7 @@ files:
 - lib/opennebula/host_pool.rb
 - lib/opennebula/image.rb
 - lib/opennebula/image_pool.rb
+- lib/opennebula/oneflow_client.rb
 - lib/opennebula/pool.rb
 - lib/opennebula/pool_element.rb
 - lib/opennebula/system.rb
@@ -97,36 +93,27 @@ files:
 - LICENSE
 homepage: http://opennebula.org
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: OpenNebula Client API
 test_files: []
-
+has_rdoc: