opennebula 5.12.9 → 6.0.0.1

data/lib/nsx_client.rb

@@ -0,0 +1,144 @@
+# -------------------------------------------------------------------------- #
+# 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
+
+    ONE_LOCATION = ENV['ONE_LOCATION'] unless defined?(ONE_LOCATION)
+
+    if !ONE_LOCATION
+        RUBY_LIB_LOCATION = '/usr/lib/one/ruby' \
+            unless defined?(RUBY_LIB_LOCATION)
+        GEMS_LOCATION     = '/usr/share/one/gems' \
+            unless defined?(GEMS_LOCATION)
+    else
+        RUBY_LIB_LOCATION = ONE_LOCATION + '/lib/ruby' \
+            unless defined?(RUBY_LIB_LOCATION)
+        GEMS_LOCATION     = ONE_LOCATION + '/share/gems' \
+            unless defined?(GEMS_LOCATION)
+    end
+
+    if File.directory?(GEMS_LOCATION)
+        real_gems_path = File.realpath(GEMS_LOCATION)
+        if !defined?(Gem) || Gem.path != [real_gems_path]
+            $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+            require 'rubygems'
+            Gem.use_paths(real_gems_path)
+        end
+    end
+
+    $LOAD_PATH << RUBY_LIB_LOCATION
+
+    require 'net/http'
+    require 'json'
+    require 'nokogiri'
+    require 'opennebula'
+    require 'vcenter_driver'
+    require 'nsx_driver'
+
+    # Class NSXClient
+    class NSXClient
+
+        # ATTIBUTES
+        attr_accessor :nsxmgr
+        attr_accessor :nsx_user
+        attr_accessor :nsx_password
+
+        # CONSTRUCTORS
+        def initialize(nsxmgr, nsx_user, nsx_password)
+            @nsxmgr = nsxmgr
+            @nsx_user = nsx_user
+            @nsx_password = nsx_password
+        end
+
+        def self.new_child(nsxmgr, nsx_user, nsx_password, type)
+            [nsxmgr, nsx_user, nsx_password, type].each do |v|
+                next if !v.nil? && !v.empty?
+
+                return nil
+            end
+
+            case type.upcase
+            when NSXConstants::NSXT
+                NSXTClient.new(nsxmgr, nsx_user, nsx_password)
+            when NSXConstants::NSXV
+                NSXVClient.new(nsxmgr, nsx_user, nsx_password)
+            else
+                error_msg = "Unknown NSX type: #{type}"
+                error     = NSXError::UnknownObject.new(error_msg)
+                raise error
+            end
+        end
+
+        def self.new_from_host(host)
+            nsxmgr = host['TEMPLATE/NSX_MANAGER']
+            nsx_user = host['TEMPLATE/NSX_USER']
+            nsx_password = host['TEMPLATE/NSX_PASSWORD']
+            nsx_type = host['TEMPLATE/NSX_TYPE']
+
+            new_child(nsxmgr, nsx_user, nsx_password, nsx_type)
+        end
+
+        def self.new_from_id(hid)
+            client = OpenNebula::Client.new
+            host   = OpenNebula::Host.new_with_id(hid, client)
+
+            rc = host.info(true)
+
+            if OpenNebula.is_error?(rc)
+                raise "Could not get host info for ID: #{hid} - #{rc.message}"
+            end
+
+            new_from_host(host)
+        end
+
+        # METHODS
+
+        # Return response if match with responses codes, If response not match
+        # with expected responses codes then raise an IncorrectResponseCodeError
+        def check_response(response, codes_array)
+            unless response.nil?
+                return response if codes_array.include?(response.code.to_i)
+
+                response_json = JSON.parse(response.body)
+                nsx_error = "\nNSX error code: " \
+                            "#{response_json['errorCode']}, " \
+                            "\nNSX error details: " \
+                            "#{response_json['details']}"
+                raise NSXError::IncorrectResponseCodeError, nsx_error
+            end
+            raise NSXError::IncorrectResponseCodeError, nsx_error
+        end
+
+        # Return: respose.body
+        def get(url, aditional_headers = []); end
+
+        # Return: response
+        def get_full_response(url, aditional_headers = []); end
+
+        # Return: id of the created object
+        def post(url, data, aditional_headers = []); end
+
+        def put(url, data, aditional_headers = []); end
+
+        def delete(url); end
+
+        def get_token(url); end
+
+        # Prepare headers
+        def add_headers(aditional_headers = []); end
+
+    end
+
+end

data/lib/nsx_component.rb

@@ -0,0 +1,28 @@
+# -------------------------------------------------------------------------- #
+# 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 NSXComponent
+
+        # CONSTRUCTOR
+        def initialize(nsx_client)
+            @nsx_client = nsx_client
+        end
+
+    end
+
+end

data/lib/nsx_constants.rb

@@ -0,0 +1,149 @@
+# -------------------------------------------------------------------------- #
+# 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
+
+    ONE_LOCATION = ENV['ONE_LOCATION'] unless defined?(ONE_LOCATION)
+
+    if !ONE_LOCATION
+        RUBY_LIB_LOCATION = '/usr/lib/one/ruby' \
+            unless defined?(RUBY_LIB_LOCATION)
+        GEMS_LOCATION     = '/usr/share/one/gems' \
+            unless defined?(GEMS_LOCATION)
+    else
+        RUBY_LIB_LOCATION = ONE_LOCATION + '/lib/ruby' \
+            unless defined?(RUBY_LIB_LOCATION)
+        GEMS_LOCATION     = ONE_LOCATION + '/share/gems' \
+            unless defined?(GEMS_LOCATION)
+    end
+
+    if File.directory?(GEMS_LOCATION)
+        real_gems_path = File.realpath(GEMS_LOCATION)
+        if !defined?(Gem) || Gem.path != [real_gems_path]
+            $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+            require 'rubygems'
+            Gem.use_paths(real_gems_path)
+        end
+    end
+
+    $LOAD_PATH << RUBY_LIB_LOCATION
+
+    class NSXConstants
+
+        # CONSTANTS
+        NSXT = 'NSX-T'
+        NSXV = 'NSX-V'
+        HEADER_JSON = { 'Content-Type' => 'application/json' }
+        HEADER_XML = { 'Content-Type' => 'application/xml' }
+        # NSX Manager
+        NSXT_EXTENSION_LIST = 'com.vmware.nsx.management.nsxt'
+        NSXV_EXTENSION_LIST = 'com.vmware.vShieldManager'
+        NSXT_BASE = '/api/v1'
+        NSXV_BASE = '/api/2.0'
+        # Transport Zones
+        NSXV_TZS = NSXV_BASE + '/vdn/scopes'
+        NSXV_TZS_XPATH = '//vdnScope'
+        NSXT_TZS = NSXT_BASE + '/transport-zones'
+        # VirtualWire
+        NSXV_AUTH = NSXV_BASE + '/services/auth/token'
+        NSXV_LS_TYPE = 'NSX-V'
+        NSXV_LS_NAME_XPATH = '//virtualWire/name'
+        NSXV_LS_VNI_XPATH = '//virtualWire/vdnId'
+        NSXV_LS_BACKING_XPATH = '//virtualWire/vdsContextWithBacking' \
+                                '/backingValue'
+        NSXV_LS_OBJECTID_XPATH = '//virtualWire/vdsContextWithBacking' \
+                                 '/switch/objectId'
+        NSXV_LS_XPATH = '//virtualWire'
+        NSXV_LS_SECTION = NSXV_BASE + '/vdn/virtualwires/'
+        NSXV_TZ_SECTION = NSXV_BASE + '/vdn/scopes/'
+        NSXV_TZ_XPATH = '//virtualWire/vdnScopeId'
+        # OpaqueNetwork
+        NSXT_AUTH = NSXT_BASE + '/aaa/registration-token'
+        NSXT_LS_TYPE = 'Opaque Network'
+        NSXT_LS_SECTION = NSXT_BASE + '/logical-switches/'
+        # DFW
+        ONE_SECTION_NAME = 'OpenNebula'
+        NSXT_DFW_BASE = NSXT_BASE + '/firewall'
+        NSXV_DFW_BASE = '/api/4.0/firewall/globalroot-0/config'
+        NSXT_DFW_SECTIONS = '/sections'
+        NSXV_DFW_SECTIONS = '/layer3sections'
+        NSXV_DFW_SECTION_XPATH = '//section'
+        NSXV_DFW_RULE_XPATH = '//rule'
+        # RULE
+        NSXT_RULE_BASE = NSXT_BASE + '/firewall/rules'
+        NSXT_RULE_PROTOCOL = {
+            'TCP' => {
+                :service => {
+                    :l4_protocol => 'TCP',
+                    :source_ports => [],
+                    :destination_ports => [],
+                    :resource_type => 'L4PortSetNSService'
+                }
+            },
+            'UDP' => {
+                :service => {
+                    :l4_protocol => 'UDP',
+                    :source_ports => [],
+                    :destination_ports => [],
+                    :resource_type => 'L4PortSetNSService'
+                }
+            },
+            'ICMP' => {
+                :service => {
+                    :protocol => 'ICMPv4',
+                    :resource_type => 'ICMPTypeNSService'
+                }
+            },
+            'ICMPv6' => {
+                :service => {
+                    :protocol => 'ICMPv6',
+                    :resource_type => 'ICMPTypeNSService'
+                }
+            }
+        }
+        NSXV_RULE_BASE = 'xxx'
+        NSX_RULE_IPSEC_PORTS = %w[500 4500]
+        # Logical Ports
+        NSXT_LP_BASE = NSXT_BASE + '/logical-ports/'
+        NSXV_LP_BASE = ''
+        # Messages
+        MSG_INCOMPLETE_REQ = 'Incomplete request, NSX_MANAGER, NSX_USER, \
+                              NSX_PASSWORD and NSX_TYPE are needed'
+        MSG_INVALID_REQ = 'Invalid request, check that NSX_MANAGER, NSX_USER, \
+                           NSX_PASSWORD and NSX_TYPE are correct'
+        MSG_INVALID_NSXTYPE = 'Invalid NSX-TYPE: Only NSX-T and NSX-V are \
+                               supported'
+        # Responses codes
+        # 2xx
+        CODE_OK = 200
+        CODE_CREATED = 201
+        CODE_ACCEPTED = 202
+        CODE_NO_CONTENT = 204
+        # 4xx
+        CODE_BAD_REQUEST = 400
+        CODE_UNAUTHORIZED = 401
+        CODE_FORBIDDEN = 403
+        CODE_NOT_FOUND = 404
+        CODE_METHOD_NOT_ALLOWED = 405
+        CODE_NOT_ACCEPTABLE = 406
+        # 5xx
+        CODE_INTERNAL_SERVER_ERROR = 500
+        CODE_BAD_GATEWAY = 502
+        CODE_SERVICE_UNAVAILABLE = 503
+        CODE_GATEWAY_TIMEOUT = 504
+
+    end
+
+end

data/lib/nsx_driver.rb

@@ -0,0 +1,78 @@
+# ---------------------------------------------------------------------------- #
+# 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.                                               #
+# ---------------------------------------------------------------------------- #
+
+# ---------------------------------------------------------------------------- #
+# Set up the environment for the driver                                        #
+# ---------------------------------------------------------------------------- #
+
+ONE_LOCATION = ENV['ONE_LOCATION'] unless defined?(ONE_LOCATION)
+
+if !ONE_LOCATION
+    BIN_LOCATION  = '/usr/bin'     unless defined?(BIN_LOCATION)
+    LIB_LOCATION  = '/usr/lib/one' unless defined?(LIB_LOCATION)
+    ETC_LOCATION  = '/etc/one/'    unless defined?(ETC_LOCATION)
+    VAR_LOCATION  = '/var/lib/one' unless defined?(VAR_LOCATION)
+    GEMS_LOCATION = '/usr/share/one/gems' unless defined?(GEMS_LOCATION)
+else
+    BIN_LOCATION  = ONE_LOCATION + '/bin' unless defined?(BIN_LOCATION)
+    LIB_LOCATION  = ONE_LOCATION + '/lib'  unless defined?(LIB_LOCATION)
+    ETC_LOCATION  = ONE_LOCATION + '/etc/' unless defined?(ETC_LOCATION)
+    VAR_LOCATION  = ONE_LOCATION + '/var/' unless defined?(VAR_LOCATION)
+    GEMS_LOCATION = ONE_LOCATION + '/share/gems' unless defined?(GEMS_LOCATION)
+end
+
+ENV['LANG'] = 'C'
+
+if File.directory?(GEMS_LOCATION)
+    real_gems_path = File.realpath(GEMS_LOCATION)
+    if !defined?(Gem) || Gem.path != [real_gems_path]
+        $LOAD_PATH.reject! {|l| l =~ /vendor_ruby/ }
+        require 'rubygems'
+        Gem.use_paths(real_gems_path)
+    end
+end
+
+$LOAD_PATH << LIB_LOCATION + '/ruby'
+$LOAD_PATH << LIB_LOCATION + '/ruby/nsx_driver'
+
+# ---------------------------------------------------------------------------- #
+# NSX Library                                                                  #
+# ---------------------------------------------------------------------------- #
+require 'nsx_constants'
+require 'nsx_error'
+require 'nsx_component'
+require 'nsx_client'
+require 'nsxt_client'
+require 'nsxv_client'
+require 'logical_switch'
+require 'opaque_network'
+require 'transport_zone'
+require 'nsxt_tz'
+require 'nsxv_tz'
+require 'virtual_wire'
+require 'distributed_firewall'
+require 'nsxt_dfw'
+require 'nsxv_dfw'
+require 'logical_port'
+require 'nsxt_logical_port'
+require 'nsxv_logical_port'
+require 'nsx_rule'
+require 'nsxt_rule'
+require 'nsxv_rule'
+
+# NSX Driver module
+module NSXDriver
+end

data/lib/nsx_error.rb

@@ -0,0 +1,77 @@
+# -------------------------------------------------------------------------- #
+# 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 NSXError < StandardError
+
+        # Class IncorrectResponseCodeError
+        class IncorrectResponseCodeError < NSXError
+
+            def initialize(msg = 'Incorrect response code')
+                super(msg)
+            end
+
+        end
+
+        # Class ObjectNotFound
+        class ObjectNotFound < NSXError
+
+            def initialize(msg = 'Object not found')
+                super(msg)
+            end
+
+        end
+
+        # Class UnknownObject
+        class UnknownObject < NSXError
+
+            def initialize(msg = 'Unknown object type')
+                super(msg)
+            end
+
+        end
+
+        # Class CreateError
+        class CreateError < NSXError
+
+            def initialize(msg = 'Error creating NSX object')
+                super(msg)
+            end
+
+        end
+
+        # Class DeleteError
+        class DeleteError < NSXError
+
+            def initialize(msg = 'Error deleting NSX object')
+                super(msg)
+            end
+
+        end
+
+        # Class DeleteError
+        class MissingParameter < NSXError
+
+            def initialize(parameter)
+                msg = "Missing NSX parameter #{parameter}"
+                super(msg)
+            end
+
+        end
+
+    end
+
+end