opennebula 5.12.9 → 6.0.0.1

data/lib/nsxv_tz.rb

@@ -0,0 +1,41 @@
+# -------------------------------------------------------------------------- #
+# 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 NSXDriver
+
+    # Class Transport Zone
+    class NSXVtz < TransportZone
+
+        # ATTRIBUTES
+        attr_reader :tz_id
+
+        # CONSTRUCTOR
+        def initialize(nsx_client)
+            super(nsx_client)
+            # Construct base URLs
+            @url_tzs_nsxv = NSXConstants::NSXV_TZS
+        end
+
+        # METHODS
+        # Return the transport zones list
+        def tzs
+            @nsx_client
+                .get(@url_tzs_nsxv)
+                .xpath(NSXConstants::NSXV_TZS_XPATH)
+        end
+
+    end
+
+end

data/lib/opaque_network.rb

@@ -0,0 +1,134 @@
+# -------------------------------------------------------------------------- #
+# 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 NSXDriver
+
+    # Class Opaque Network NSX-T Network
+    class OpaqueNetwork < LogicalSwitch
+
+        # ATTRIBUTES
+        # attr_reader :ls_id, :admin_display
+
+        # CONSTRUCTOR
+        def initialize(nsx_client, ls_id = nil, tz_id = nil, ls_data = nil)
+            super(nsx_client)
+            if ls_id
+                initialize_with_id(ls_id)
+            else
+                if tz_id && ls_data
+                    begin
+                        @ls_id = new_logical_switch(ls_data)
+                    rescue NSXError::IncorrectResponseCodeError => e
+                        raise 'Opaque Network not created in ' \
+                              "NSX Manager: #{e.message}"
+                    end
+                    unless @ls_id
+                        raise 'Opaque Network not created in NSX Manager: '\
+                              'generic error'
+                    end
+
+                    # Construct URL of the created logical switch
+                    @url_ls = NSXConstants::NSXT_LS_SECTION + @ls_id
+                    @ls_vni = ls_vni
+                    @ls_name = ls_name
+                    @tz_id = ls_tz
+                    @admin_display = 'UP'
+                end
+            end
+        end
+
+        # Creates a OpaqueNetwork from its name
+        def self.new_from_name(nsx_client, ls_name)
+            lswitch = new(nsx_client)
+            ls_id = lswitch.ls_id_from_name(nsx_client, ls_name)
+            unless ls_id
+                error_msg = "Opaque Network with name: #{ls_name} not found"
+                error =  NSXError::ObjectNotFound
+                         .new(error_msg)
+                raise error
+            end
+
+            # initialize_with_id(@ls_id)
+            lswitch.initialize_with_id(ls_id)
+            lswitch
+        end
+
+        # Creates a OpaqueNetwork from its id
+        def initialize_with_id(ls_id)
+            @ls_id = ls_id
+            # Construct URL of the created logical switch
+            @url_ls = NSXConstants::NSXT_LS_SECTION + \
+                      @ls_id
+            if ls?
+                @ls_vni = ls_vni
+                @ls_name = ls_name
+                @tz_id = ls_tz
+                @admin_display = 'UP'
+            else
+                error_msg = "Opaque Network with id: #{ls_id} not found"
+                error = NSXError::ObjectNotFound
+                        .new(error_msg)
+                raise error
+            end
+        end
+
+        # Get the logical switch id from its name
+        def ls_id_from_name(nsx_client, name)
+            url = NSXConstants::NSXT_LS_SECTION
+            lswitches = nsx_client.get(url)['results']
+            lswitches.each do |lswitch|
+                lsname = lswitch['display_name']
+                lsid = lswitch['id']
+                if lsname == name && lsid
+                    return lsid
+                end
+            end
+            nil
+        end
+
+        # METHODS
+        # Check if logical switch exists
+        def ls?
+            @nsx_client.get(@url_ls) ? true : false
+        end
+
+        # Get logical switch's name
+        def ls_name
+            @nsx_client.get(@url_ls)['display_name']
+        end
+
+        # Get logical switch's vni
+        def ls_vni
+            @nsx_client.get(@url_ls)['vni']
+        end
+
+        # Get the Transport Zone of the logical switch
+        def ls_tz
+            @nsx_client.get(@url_ls)['transport_zone_id']
+        end
+
+        # Create a new logical switch (NSX-T: opaque network)
+        def new_logical_switch(ls_data)
+            @nsx_client.post(NSXConstants::NSXT_LS_SECTION, ls_data)
+        end
+
+        # Delete a logical switch
+        def delete_logical_switch
+            @nsx_client.delete(@url_ls)
+        end
+
+    end
+
+end

data/lib/opennebula.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #
@@ -49,7 +49,9 @@ require 'opennebula/datastore_pool'
 require 'opennebula/cluster'
 require 'opennebula/cluster_pool'
 require 'opennebula/document'
+require 'opennebula/document_json'
 require 'opennebula/document_pool'
+require 'opennebula/document_pool_json'
 require 'opennebula/zone'
 require 'opennebula/zone_pool'
 require 'opennebula/security_group'
@@ -70,9 +72,10 @@ require 'opennebula/vntemplate_pool'
 require 'opennebula/hook'
 require 'opennebula/hook_pool'
 require 'opennebula/hook_log'
+require 'opennebula/flow'
 
 module OpenNebula
 
     # OpenNebula version
-    VERSION = '5.12.9'
+    VERSION = '6.0.0.1'
 end

data/lib/opennebula/acl.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/acl_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/client.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #
@@ -88,7 +88,7 @@ module OpenNebula
         NO_ONE_AUTH_ERROR = "ONE_AUTH file not present"
 
         attr_accessor :one_auth
-        attr_reader   :one_endpoint
+        attr_reader   :one_endpoint, :one_zmq
 
         begin
             require 'xmlparser'
@@ -152,6 +152,14 @@ module OpenNebula
 
             @async = !options[:sync]
 
+            if options[:subscriber_endpoint]
+                @one_zmq = options[:subscriber_endpoint]
+            elsif ENV["ONE_ZMQ"]
+                @one_zmq = ENV["ONE_ZMQ"]
+            else
+                @one_zmq = 'tcp://localhost:2101'
+            end
+
             timeout=nil
             if options[:timeout]
                 timeout = options[:timeout]

data/lib/opennebula/cluster.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/cluster_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/datastore.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/datastore_pool.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #

data/lib/opennebula/document.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #
@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+require 'opennebula/lockable_ext'
 require 'opennebula/pool_element'
 
 module OpenNebula
@@ -75,6 +76,8 @@ module OpenNebula
         # @example
         #   doc = Document.new(Document.build_xml(3),rpc_client)
         def initialize(xml, client)
+            LockableExt.make_lockable(self, DOCUMENT_METHODS)
+
             super(xml,client)
         end
 
@@ -86,8 +89,8 @@ module OpenNebula
         #
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
-        def info()
-            rc = super(DOCUMENT_METHODS[:info], 'DOCUMENT')
+        def info(decrypt = false)
+            rc = super(DOCUMENT_METHODS[:info], 'DOCUMENT', decrypt)
 
             if !OpenNebula.is_error?(rc) && self['TYPE'].to_i != document_type
                 return OpenNebula::Error.new("[DocumentInfo] Error getting document [#{@pe_id}].")
@@ -108,6 +111,8 @@ module OpenNebula
             super(DOCUMENT_METHODS[:allocate], description, document_type)
         end
 
+        alias_method :allocate_xml, :allocate
+
         # Deletes the Document
         #
         # @return [nil, OpenNebula::Error] nil in case of success, Error
@@ -217,32 +222,6 @@ module OpenNebula
             return call(DOCUMENT_METHODS[:rename], @pe_id, name)
         end
 
-        # Locks this object
-        #
-        # @param owner [String] String to identify the application requestiong
-        #   the lock
-        #
-        # @return [Bool, OpenNebula::Error] In case of success, true if the
-        #   lock was granted, and false if the object is already locked.
-        def lock(owner="")
-            return Error.new('ID not defined') if !@pe_id
-
-            rc = @client.call(DOCUMENT_METHODS[:lock], @pe_id, owner)
-
-            return rc
-        end
-
-        # Unlocks this object
-        #
-        # @param owner [String] String to identify the application requestiong
-        #   the unlock
-        #
-        # @return [nil, OpenNebula::Error] nil in case of success, Error
-        #   otherwise
-        def unlock(owner="")
-            return call(DOCUMENT_METHODS[:unlock], @pe_id, owner)
-        end
-
         #######################################################################
         # Helpers to get Document information
         #######################################################################

data/lib/opennebula/document_json.rb

@@ -1,5 +1,5 @@
 # -------------------------------------------------------------------------- #
-# Copyright 2002-2020, 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    #
@@ -21,6 +21,15 @@ module OpenNebula
 
         TEMPLATE_TAG = "BODY"
 
+        # Returns current template tag
+        def template_tag
+            if @tag
+                @tag
+            else
+                TEMPLATE_TAG
+            end
+        end
+
         # Allocate a new Document containing the json inside the TEMPLATE
         #
         # @param [String] template_json json to be inserted in the TEMPLATE
@@ -30,19 +39,28 @@ module OpenNebula
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
         #
-        def allocate(template_json, name=nil)
+        def allocate(template_json, name = nil, tag = nil)
+            @tag = tag if tag
+
             text = build_template_xml(template_json, name)
 
             super(text)
         end
 
+        # Allocate XML Document
+        #
+        # @param xml [String] XML document content
+        def allocate_xml(xml)
+            super(xml)
+        end
+
         # Retrieves the information of the Service and all its Nodes.
         #
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
         #
-        def info
-            rc = super
+        def info(decrypt = false)
+            rc = super(decrypt)
             if OpenNebula.is_error?(rc)
                 return rc
             end
@@ -90,10 +108,10 @@ module OpenNebula
         def to_json(pretty_generate=true)
             hash = self.to_hash
 
-            body = hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"]
+            body = hash['DOCUMENT']['TEMPLATE']["#{template_tag}"]
             if body
                 body_hash = JSON.parse(body)
-                hash['DOCUMENT']['TEMPLATE']["#{TEMPLATE_TAG}"] = body_hash
+                hash['DOCUMENT']['TEMPLATE']["#{template_tag}"] = body_hash
             end
 
             if pretty_generate
@@ -106,7 +124,7 @@ module OpenNebula
 
         # Fill the @body hash with the values of the template
         def load_body
-            body_str = self["TEMPLATE/#{TEMPLATE_TAG}"]
+            body_str = self["TEMPLATE/#{template_tag}"]
 
             if body_str
                 begin
@@ -116,27 +134,39 @@ module OpenNebula
                 end
             end
 
+            plain_str = self['TEMPLATE/PLAIN']
+
+            if plain_str
+                begin
+                    @plain = JSON.parse(plain_str)
+                rescue JSON::JSONError
+                    return OpenNebula::Error.new($!)
+                end
+            end
+
             return nil
         end
 
-        private
-
         # Build an xml string incluiding the provided json
         #
         # @param [String] template_json The template to be inserted
         # @param [String, nil] name The string to be inserted as name
+        # @param [String, nil] plain information to add to the document
         # @return [String] The xml containing the json
         #
-        def build_template_xml(template_json, name=nil)
+        def build_template_xml(template_json, name = nil, plain = nil)
             template_json ||= ""
+            plain         ||= @plain
+            plain           = plain.to_json if plain && !(plain.is_a? String)
 
             text = "<TEMPLATE>"
 
             text << "<NAME>#{name}</NAME>" if name
+            text << "<PLAIN><![CDATA[#{plain}]]></PLAIN>" if plain
 
-            text << "<#{TEMPLATE_TAG}>"
+            text << "<#{template_tag}>"
             text << "<![CDATA[#{template_json}]]>"
-            text << "</#{TEMPLATE_TAG}>"
+            text << "</#{template_tag}>"
 
             text << "</TEMPLATE>"