occi 1.2.1 → 2.0.0

data/lib/occi/backend/opennebula/network.rb

@@ -0,0 +1,143 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OpenNebula Backend
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'occi/log'
+require 'erubis'
+require 'ipaddr'
+
+module OCCI
+  module Backend
+    module OpenNebula
+
+      # ---------------------------------------------------------------------------------------------------------------------
+      module Network
+
+        TEMPLATENETWORKRAWFILE = 'network.erb'
+
+        # ---------------------------------------------------------------------------------------------------------------------       
+        #        private
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def network_parse_backend_object(backend_object)
+
+          # get information on storage object from OpenNebula backend
+          backend_object.info
+
+          network_kind = OCCI::Registry.get_by_id("http://schemas.ogf.org/occi/infrastructure#network")
+
+          network = Hashie::Mash.new
+
+          network.kind = storage_kind.type_identifier
+          network.mixins = %w|http://opennebula.org/occi/infrastructure#network http://schemas.ogf.org/occi/infrastructure#ipnetwork|
+          network.id = self.generate_occi_id(network_kind, backend_object.id.to_s)
+          network.title = backend_object['NAME']
+          network.summary = backend_object['TEMPLATE/DESCRIPTION'] if backend_object['TEMPLATE/DESCRIPTION']
+
+          network.attributes!.occi!.network!.address = backend_object['TEMPLATE/NETWORK_ADDRESS'] if backend_object['TEMPLATE/NETWORK_ADDRESS']
+          network.attributes!.occi!.network!.gateway = backend_object['TEMPLATE/GATEWAY'] if backend_object['TEMPLATE/GATEWAY']
+          network.attributes!.occi!.network!.vlan = backend_object['TEMPLATE/VLAN_ID'] if backend_object['TEMPLATE/VLAN_ID']
+          network.attributes!.occi!.network!.allocation = "static" if backend_object['TEMPLATE/TYPE'].downcase == "fixed"
+          network.attributes!.occi!.network!.allocation = "dynamic" if backend_object['TEMPLATE/TYPE'].downcase == "ranged"
+
+          network.attributes!.org!.opennebula!.network!.vlan = backend_object['TEMPLATE/VLAN'] if backend_object['TEMPLATE/VLAN']
+          network.attributes!.org!.opennebula!.network!.phydev = backend_object['TEMPLATE/PHYDEV'] if backend_object['TEMPLATE/PHYDEV']
+          network.attributes!.org!.opennebula!.network!.bridge = backend_object['TEMPLATE/BRIDGE'] if backend_object['TEMPLATE/BRIDGE']
+
+          network.attributes!.org!.opennebula!.network!.ip_start = backend_object['TEMPLATE/IP_START'] if backend_object['TEMPLATE/IP_START']
+          network.attributes!.org!.opennebula!.network!.ip_end = backend_object['TEMPLATE/IP_END'] if backend_object['TEMPLATE/IP_END']
+
+          network = OCCI::Core::Resource.new(network)
+
+          network_set_state(backend_object, network)
+
+          network_kind.entities << network
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        public
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def network_deploy(network)
+
+          backend_object = VirtualNetwork.new(VirtualNetwork.build_xml(), @one_client)
+
+          template_location = OCCI::Server.config["TEMPLATE_LOCATION"] + TEMPLATENETWORKRAWFILE
+          template = Erubis::Eruby.new(File.read(template_raw)).evaluate(network)
+
+          OCCI::Log.debug("Parsed template #{template}")
+          rc = backend_object.allocate(template)
+          check_rc(rc)
+
+          backend_object.info
+          network.id = self.generate_occi_id(OCCI::Registry.get_by_id(network.kind), backend_object['ID'].to_s)
+
+          network_set_state(backend_object, network)
+
+          OCCI::Log.debug("OpenNebula ID of virtual network: #{network.backend[:id]}")
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def network_set_state(backend_object, network)
+          network.attributes!.occi!.network!.state = "active"
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def network_delete(network)
+          backend_object = VirtualNetwork.new(VirtualNetwork.build_xml(network.backend[:id]), @one_client)
+          rc = backend_object.delete
+          check_rc(rc)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def network_register_all_instances
+          occi_objects = []
+          backend_object_pool=VirtualNetworkPool.new(@one_client, OCCI::Backend::OpenNebula::OpenNebula::INFO_ACL)
+          backend_object_pool.info
+          backend_object_pool.each { |backend_object| network_parse_backend_object(backend_object) }
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # STORAGE ACTIONS
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def network_action_dummy(network, parameters)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def network_up(network, parameters)
+          backend_object = VirtualNetwork.new(VirtualNetwork.build_xml(network.backend[:id]), @one_client)
+          # not implemented in OpenNebula
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def network_down(network, parameters)
+          backend_object = VirtualNetwork.new(VirtualNetwork.build_xml(network.backend[:id]), @one_client)
+          # not implemented in OpenNebula
+        end
+
+      end
+
+    end
+  end
+end

data/lib/occi/backend/opennebula/opennebula.rb

@@ -0,0 +1,188 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OpenNebula Backend
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'rubygems'
+require 'uuidtools'
+require 'OpenNebula/OpenNebula'
+require 'occi/registry'
+
+# OpenNebula backend
+require 'occi/backend/opennebula/compute'
+require 'occi/backend/opennebula/network'
+require 'occi/backend/opennebula/storage'
+
+# OpenNebula backend based mixins
+#require 'occi/extensions/one/Image'
+#require 'occi/extensions/one/Network'
+#require 'occi/extensions/one/VirtualMachine'
+#require 'occi/extensions/one/VNC'
+
+#require 'occi/extensions/Reservation'
+
+require 'occi/log'
+
+include OpenNebula
+
+module OCCI
+  module Backend
+    module OpenNebula
+
+      # ---------------------------------------------------------------------------------------------------------------------
+      class OpenNebula
+
+        # The ACL level to be used when querying resource in OpenNebula:
+        # - INFO_ALL returns all resources and works only when running under the oneadmin account
+        # - INFO_GROUP returns the resources of the account + his group (= default)
+        # - INFO_MINE returns only the resources of the account
+        INFO_ACL = OpenNebula::Pool::INFO_GROUP
+
+        include Compute
+        include Network
+        include Storage
+
+
+        # Operation mappings
+
+        OPERATIONS = {}
+
+        OPERATIONS["http://schemas.ogf.org/occi/infrastructure#compute"] = {
+
+            # Generic resource operations
+            :deploy => :compute_deploy,
+            :update_state => :compute_update_state,
+            :delete => :compute_delete,
+
+            # Compute specific resource operations
+            :start => :compute_start,
+            :stop => :compute_stop,
+            :restart => :compute_restart,
+            :suspend => :compute_suspend
+        }
+
+        OPERATIONS["http://schemas.ogf.org/occi/infrastructure#network"] = {
+
+            # Generic resource operations
+            :deploy => :network_deploy,
+            :update_state => :network_update_state,
+            :delete => :network_delete,
+
+            # Network specific resource operations
+            :up => :network_up,
+            :down => :network_down
+        }
+
+        OPERATIONS["http://schemas.ogf.org/occi/infrastructure#storage"] = {
+
+            # Generic resource operations
+            :deploy => :storage_deploy,
+            :update_state => :storage_update_state,
+            :delete => :storage_delete,
+
+            # Network specific resource operations
+            :online => :storage_online,
+            :offline => :storage_offline,
+            :backup => :storage_backup,
+            :snapshot => :storage_snapshot,
+            :resize => :storage_resize
+        }
+
+        # ---------------------------------------------------------------------------------------------------------------------       
+        # Register backend specific mixins
+        begin
+          #OCCI::CategoryRegistry.register(OCCI::Backend::ONE::Image::MIXIN)
+          #OCCI::CategoryRegistry.register(OCCI::Backend::ONE::Network::MIXIN)
+          #OCCI::CategoryRegistry.register(OCCI::Backend::ONE::VirtualMachine::MIXIN)
+          #OCCI::CategoryRegistry.register(OCCI::Mixins::Reservation::MIXIN)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------       
+        #        private
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------      
+        def check_rc(rc)
+          if rc.class == Error
+            raise OCCI::BackendError, "Error message from OpenNebula: #{rc.to_str}"
+            # TODO: return failed!
+          end
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Generate a new occi id for resources created directly in OpenNebula using a seed id and the kind identifier
+        def generate_occi_id(kind, seed_id)
+          # Use strings as kind ids
+          kind = kind.type_identifier if kind.kind_of?(OCCI::Core::Kind)
+          return UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, "#{kind}:#{seed_id}").to_s
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        public
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def initialize(user, password)
+
+          # TODO: create mixins from existing templates
+
+          # initialize OpenNebula connection
+          OCCI::Log.debug("### Initializing connection with OpenNebula")
+
+          # TODO: check for error!
+          #       @one_client = Client.new(OCCI::Server.config['one_user'] + ':' + OCCI::Server.config['one_password'], OCCI::Server.config['one_xmlrpc'])
+          @one_client = Client.new(user + ':' + password, OCCI::Server.config['one_xmlrpc'])
+
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def register_existing_resources
+          # get all compute objects
+          resource_template_register
+          os_template_register
+          compute_register_all_instances
+          network_register_all_instances
+          storage_register_all_instances
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def resource_template_register
+          # currently not directly supported by OpenNebula
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def os_template_register
+          backend_object_pool=TemplatePool.new(@one_client, INFO_ACL)
+          backend_object_pool.info
+          backend_object_pool.each do |backend_object|
+            related = OCCI::Registry.get_by_id('http://schemas.ogf.org/occi/infrastructure#os_tpl')
+            term = backend_object['NAME'].downcase.chomp.gsub(/\W/, '_')
+            # TODO: implement correct schema for service provider
+            scheme = "http://schemas.opennebula.org/occi/infrastructure/os_tpl#"
+            title = backend_object['NAME']
+            mixin = OCCI::Core::Mixin.new(:related => related, :term=>term, :scheme=>scheme,:title=>title)
+            OCCI::CategoryRegistry.register(mixin)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/occi/backend/opennebula/storage.rb

@@ -0,0 +1,175 @@
+##############################################################################
+#  Copyright 2011 Service Computing group, TU Dortmund
+#
+#  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.
+##############################################################################
+
+##############################################################################
+# Description: OpenNebula Backend
+# Author(s): Hayati Bice, Florian Feldhaus, Piotr Kasprzak
+##############################################################################
+
+require 'occi/log'
+require 'erubis'
+
+module OCCI
+  module Backend
+    module OpenNebula
+
+      # ---------------------------------------------------------------------------------------------------------------------
+      module Storage
+
+        TEMPLATESTORAGERAWFILE = 'storage.erb'
+
+        # ---------------------------------------------------------------------------------------------------------------------       
+        #        private
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------     
+        def storage_parse_backend_object(backend_object)
+
+          # get information on storage object from OpenNebula backend
+          backend_object.info
+
+          storage_kind = OCCI::Registry.get_by_id("http://schemas.ogf.org/occi/infrastructure#storage")
+
+          storage = Hashie::Mash.new
+
+          storage.kind = storage_kind.type_identifier
+          storage.mixins = %w|http://opennebula.org/occi/infrastructure#storage|
+          storage.id = self.generate_occi_id(storage_kind, backend_object.id.to_s)
+          storage.title = backend_object['NAME']
+          storage.summary = backend_object['TEMPLATE/DESCRIPTION'] if backend_object['TEMPLATE/DESCRIPTION']
+
+          storage.attributes!.occi!.storage!.size = backend_object['TEMPLATE/SIZE'].to_f/1000 if backend_object['TEMPLATE/SIZE']
+
+          storage.attributes!.org!.opennebula!.storage!.type = backend_object['TEMPLATE/TYPE'] if backend_object['TEMPLATE/TYPE']
+          storage.attributes!.org!.opennebula!.storage!.persistent = backend_object['TEMPLATE/PERSISTENT'] if backend_object['TEMPLATE/PERSISTENT']
+          storage.attributes!.org!.opennebula!.storage!.dev_prefix = backend_object['TEMPLATE/DEV_PREFIX'] if backend_object['TEMPLATE/DEV_PREFIX']
+          storage.attributes!.org!.opennebula!.storage!.bus = backend_object['TEMPLATE/BUS'] if backend_object['TEMPLATE/BUS']
+          storage.attributes!.org!.opennebula!.storage!.driver = backend_object['TEMPLATE/DRIVER'] if backend_object['TEMPLATE/DRIVER']
+
+          storage = OCCI::Core::Resource.new(storage)
+
+          storage_set_state(backend_object, storage)
+
+          storage_kind.entities << storage
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        public
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def storage_deploy(storage)
+
+          backend_object = Image.new(Image.build_xml, @one_client)
+
+          template_location = OCCI::Server.config["TEMPLATE_LOCATION"] + TEMPLATESTORAGERAWFILE
+          template = Erubis::Eruby.new(File.read(template_raw)).evaluate(storage)
+
+          OCCI::Log.debug("Parsed template #{template}")
+          rc = backend_object.allocate(template)
+          check_rc(rc)
+          OCCI::Log.debug("OpenNebula ID of image: #{storage.backend[:id]}")
+
+          backend_object.info
+          storage.id = self.generate_occi_id(OCCI::Registry.get_by_id(storage.kind), backend_object['ID'].to_s)
+
+          storage_set_state(backend_object, storage)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def storage_set_state(backend_object, storage)
+          OCCI::Log.debug("current Image state is: #{backend_object.state_str}")
+          storage.links = []
+          case backend_object.state_str
+            when "READY", "USED", "LOCKED" then
+              storage.attributes!.occi!.storage!.state = "online"
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=offline',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#offline')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=backup',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#backup')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=snapshot',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#snapshot')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=resize',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#resize')
+            when "ERROR" then
+              storage.attributes!.occi!.storage!.state = "degraded"
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=online',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#online')
+            else
+              storage.attributes!.occi!.storage!.state = "offline"
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=online',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#online')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=backup',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#backup')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=snapshot',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#snapshot')
+              storage.links << OCCI::Core::Link.new(:target=>storage.location + '?action=resize',:rel=>'http://schemas.ogf.org/occi/infrastructure/storage/action#resize')
+          end
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def storage_delete(storage)
+          backend_object = Image.new(Image.build_xml(storage.backend.id), @one_client)
+          rc = backend_object.delete
+          check_rc(rc)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def storage_register_all_instances
+          occi_objects = []
+          backend_object_pool=ImagePool.new(@one_client, OCCI::Backend::OpenNebula::OpenNebula::INFO_ACL)
+          backend_object_pool.info
+          backend_object_pool.each { |backend_object| storage_parse_backend_object(backend_object) }
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # STORAGE ACTIONS
+        # ---------------------------------------------------------------------------------------------------------------------
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        def storage_action_dummy(storage, parameters)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Action online
+        def storage_online(network, parameters)
+          backend_object = Image.new(Image.build_xml(network.backend.id), @one_client)
+          rc = backend_object.enable
+          check_rc(rc)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Action offline
+        def storage_offline(network, parameters)
+          backend_object = Image.new(Image.build_xml(network.backend.id), @one_client)
+          rc = backend_object.disable
+          check_rc(rc)
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Action backup
+        def storage_backup(network, parameters)
+          OCCI::Log.debug("not yet implemented")
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Action snapshot
+        def storage_snapshot(network, parameters)
+          OCCI::Log.debug("not yet implemented")
+        end
+
+        # ---------------------------------------------------------------------------------------------------------------------
+        # Action resize
+        def storage_resize(network, parameters)
+          OCCI::Log.debug("not yet implemented")
+        end
+
+      end
+    end
+  end
+end