occi-core 4.3.6 → 5.0.0.alpha.1

data/lib/occi/infrastructure/instance_builder.rb

@@ -0,0 +1,24 @@
+module Occi
+  module Infrastructure
+    # See `Occi::Core::InstanceBuilder` for details.
+    #
+    # @attr model [Occi::Infrastructure::Model] model filled with known category definitions
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class InstanceBuilder < Occi::Core::InstanceBuilder
+      class << self
+        # :nodoc:
+        def klass_map
+          ns = Occi::Infrastructure
+          super.merge(
+            ns::Constants::COMPUTE_KIND => ns::Compute,
+            ns::Constants::NETWORK_KIND => ns::Network,
+            ns::Constants::STORAGE_KIND => ns::Storage,
+            ns::Constants::NETWORKINTERFACE_KIND => ns::Networkinterface,
+            ns::Constants::STORAGELINK_KIND => ns::Storagelink
+          )
+        end
+      end
+    end
+  end
+end

data/lib/occi/infrastructure/mixins/os_tpl.rb

@@ -0,0 +1,19 @@
+module Occi
+  module Infrastructure
+    module Mixins
+      # A helper class for manipulation with `os_tpl` parent mixin. Doesn't
+      # provide any additional functionality aside from the class name.
+      #
+      # @author Boris Parak <parak@cesnet.cz>
+      class OsTpl < Occi::Core::Mixin
+        TITLE = 'OS or Appliance template (parent mixin)'.freeze
+
+        # See `Occi::Core::Mixin` and `Occi::Core::Category`
+        def initialize
+          schema, term = Occi::Infrastructure::Constants::OS_TPL_MIXIN.split('#')
+          super term: term, schema: "#{schema}#", title: TITLE
+        end
+      end
+    end
+  end
+end

data/lib/occi/infrastructure/mixins/resource_tpl.rb

@@ -0,0 +1,19 @@
+module Occi
+  module Infrastructure
+    module Mixins
+      # A helper class for manipulation with `os_tpl` parent mixin. Doesn't
+      # provide any additional functionality aside from the class name.
+      #
+      # @author Boris Parak <parak@cesnet.cz>
+      class ResourceTpl < Occi::Core::Mixin
+        TITLE = 'Resource template providing flavor/sizing information (parent mixin)'.freeze
+
+        # See `Occi::Core::Mixin` and `Occi::Core::Category`
+        def initialize
+          schema, term = Occi::Infrastructure::Constants::RESOURCE_TPL_MIXIN.split('#')
+          super term: term, schema: "#{schema}#", title: TITLE
+        end
+      end
+    end
+  end
+end

data/lib/occi/infrastructure/mixins.rb

@@ -0,0 +1,12 @@
+module Occi
+  module Infrastructure
+    # Contains various INFRA-specific `Occi::Core::Mixin` sub-classes with pre-set
+    # attributes (OCCI attributes and Ruby attributes). For details, see documentation
+    # for the particular class.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    module Mixins; end
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), 'mixins', '*.rb')].each { |file| require file.gsub('.rb', '') }

data/lib/occi/infrastructure/model.rb

@@ -0,0 +1,27 @@
+module Occi
+  module Infrastructure
+    # See `Occi::Core::Model` for details.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Model < Occi::Core::Model
+      # Loads OGF's OCCI Infrastructure Standard from `Occi::Infrastructure::Warehouse`.
+      #
+      # @example
+      #    model = Occi::Infrastructure::Model.new
+      #    model.load_infrastructure!
+      def load_infrastructure!
+        Occi::Infrastructure::Warehouse.bootstrap! self
+        self << Occi::Infrastructure::Mixins::OsTpl.new
+        self << Occi::Infrastructure::Mixins::ResourceTpl.new
+        nil
+      end
+
+      # Returns an instance of `Occi::Infrastructure::InstanceBuilder` associated with this model.
+      #
+      # @return [Occi::Infrastructure::InstanceBuilder] instance of IB
+      def instance_builder
+        Occi::Infrastructure::InstanceBuilder.new(model: self)
+      end
+    end
+  end
+end

data/lib/occi/infrastructure/network.rb

@@ -1,108 +1,9 @@
 module Occi
   module Infrastructure
-    class Network < Occi::Core::Resource
-
-      up = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/network/action#',
-                                  term='up',
-                                  title='activate network'
-
-      down = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/network/action#',
-                                    term='down',
-                                    title='deactivate network'
-
-      self.actions = Occi::Core::Actions.new << up << down
-
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Resource.attributes)
-      self.attributes['occi.network.vlan'] = {:type => 'number',
-                                              :mutable => true,
-                                              :pattern => '\d+'}
-      self.attributes['occi.network.label'] = {:type => 'string',
-                                               :mutable => true}
-      self.attributes['occi.network.state'] ={:type => 'string',
-                                              :pattern => 'active|inactive|error',
-                                              :default => 'inactive',
-                                              :mutable => false}
-
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/infrastructure#',
-                                       term='network',
-                                       title = 'network resource',
-                                       attributes=Occi::Core::Attributes.new(self.attributes),
-                                       parent=Occi::Core::Resource.kind,
-                                       actions = Occi::Core::Actions.new(self.actions),
-                                       location = '/network/'
-
-      require 'occi/infrastructure/network/ipnetwork'
-      self.mixins = Occi::Core::Mixins.new << Occi::Infrastructure::Network::Ipnetwork.mixin
-
-      def ipnetwork(add = true)
-        if add
-          Occi::Log.info "[#{self.class}] Adding mixin IPNetwork"
-          @mixins << Occi::Infrastructure::Network::Ipnetwork.mixin
-        else
-          Occi::Log.info "[#{self.class}] Removing mixin IPNetwork"
-          @mixins.delete Occi::Infrastructure::Network::Ipnetwork.mixin
-        end
-      end
-
-      def vlan
-        @attributes.occi_.network_.vlan
-      end
-
-      def vlan=(vlan)
-        @attributes.occi!.network!.vlan = vlan
-      end
-
-      def label
-        @attributes.occi_.network_.label
-      end
-
-      def label=(label)
-        @attributes.occi!.network!.label = label
-      end
-
-      def state
-        @attributes.occi_.network_.state
-      end
-
-      def state=(state)
-        @attributes.occi!.network!.state = state
-      end
-
-      # IPNetwork Mixin attributes
-
-      def address
-        @attributes.occi_.network_.address
-      end
-
-      def address=(address)
-        add_ipnetwork_mixin
-        @attributes.occi!.network!.address = address
-      end
-
-      def gateway
-        @attributes.occi_.network_.gateway
-      end
-
-      def gateway=(gateway)
-        add_ipnetwork_mixin
-        @attributes.occi!.network!.gateway = gateway
-      end
-
-      def allocation
-        @attributes.occi_.network_.allocation
-      end
-
-      def allocation=(allocation)
-        add_ipnetwork_mixin
-        @attributes.occi!.network!.allocation = allocation
-      end
-
-      private
-
-      def add_ipnetwork_mixin
-        ipnetwork(true) if @mixins.select { |mixin| mixin.type_identifier == Occi::Infrastructure::Network::Ipnetwork.mixin.type_identifier }.empty?
-      end
-
-    end
+    # Dummy sub-class of `Occi::Core::Resource` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Network < Occi::Core::Resource; end
   end
 end

data/lib/occi/infrastructure/networkinterface.rb

@@ -1,104 +1,9 @@
 module Occi
   module Infrastructure
-    class Networkinterface < Occi::Core::Link
-
-      up = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/networkinterface/action#',
-                                  term='up',
-                                  title='activate networkinterface'
-
-      down = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/networkinterface/action#',
-                                    term='down',
-                                    title='deactivate networkinterface'
-
-      self.actions = Occi::Core::Actions.new << up << down
-
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Link.attributes)
-      self.attributes['occi.networkinterface.interface'] = {:mutable => false}
-      self.attributes['occi.networkinterface.mac'] = {:mutable => true,
-                                                      :pattern => '^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$'}
-      self.attributes['occi.networkinterface.state'] = {:type => 'string',
-                                                        :pattern => 'active|inactive|error',
-                                                        :default => 'inactive',
-                                                        :mutable => false}
-
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/infrastructure#',
-                                       term='networkinterface',
-                                       title = 'networkinterface link',
-                                       attributes = Occi::Core::Attributes.new(self.attributes),
-                                       parent = Occi::Core::Link.kind,
-                                       actions = Occi::Core::Actions.new(self.actions),
-                                       location = '/link/networkinterface/'
-
-      require 'occi/infrastructure/networkinterface/ipnetworkinterface'
-      self.mixins = Occi::Core::Mixins.new << Occi::Infrastructure::Networkinterface::Ipnetworkinterface.mixin
-
-      def ipnetworkinterface(add = true)
-        if add
-          Occi::Log.info "[#{self.class}] Adding mixin IPNetworkInterface"
-          @mixins << Occi::Infrastructure::Networkinterface::Ipnetworkinterface.mixin
-        else
-          Occi::Log.info "[#{self.class}] Removing mixin IPNetworkInterface"
-          @mixins.delete Occi::Infrastructure::Networkinterface::Ipnetworkinterface.mixin
-        end
-      end
-
-      def interface
-        @attributes.occi_.networkinterface_.interface
-      end
-
-      def interface=(interface)
-        @attributes.occi!.networkinterface!.interface = interface
-      end
-
-      def mac
-        @attributes.occi_.networkinterface_.mac
-      end
-
-      def mac=(mac)
-        @attributes.occi!.networkinterface!.mac = mac
-      end
-
-      def state
-        @attributes.occi_.networkinterface_.state
-      end
-
-      def state=(state)
-        @attributes.occi!.networkinterface!.state = state
-      end
-
-      def address
-        @attributes.occi_.networkinterface_.address
-      end
-
-      def address=(address)
-        add_ipnetworkinterface_mixin
-        @attributes.occi!.networkinterface!.address = address
-      end
-
-      def gateway
-        @attributes.occi_.networkinterface_.gateway
-      end
-
-      def gateway=(gateway)
-        add_ipnetworkinterface_mixin
-        @attributes.occi!.networkinterface!.gateway = gateway
-      end
-
-      def allocation
-        @attributes.occi_.networkinterface_.allocation
-      end
-
-      def allocation=(allocation)
-        add_ipnetworkinterface_mixin
-        @attributes.occi!.networkinterface!.allocation = allocation
-      end
-
-      private
-
-      def add_ipnetworkinterface_mixin
-        ipnetworkinterface(true) if @mixins.select { |mixin| mixin.type_identifier == Occi::Infrastructure::Networkinterface::Ipnetworkinterface.mixin.type_identifier }.empty?
-      end
-
-    end
+    # Dummy sub-class of `Occi::Core::Link` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Networkinterface < Occi::Core::Link; end
   end
 end

data/lib/occi/infrastructure/storage.rb

@@ -1,63 +1,9 @@
 module Occi
   module Infrastructure
-    class Storage < Occi::Core::Resource
-
-      online = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storage/action#',
-                                      term='online',
-                                      title='activate storage'
-
-      offline = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storage/action#',
-                                       term='offline',
-                                       title='deactivate storage'
-
-      backup = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storage/action#',
-                                      term='backup',
-                                      title='backup storage'
-
-      snapshot = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storage/action#',
-                                        term='snapshot',
-                                        title='snapshot storage'
-
-      resize = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storage/action#',
-                                      term='resize',
-                                      title='resize storage'
-      resize.attributes['size'] = {:type => 'number',
-                                   :mutable => true,
-                                   :required => true}
-
-      self.actions = Occi::Core::Actions.new << online << offline << backup << snapshot << resize
-
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Resource.attributes)
-      self.attributes['occi.storage.size'] = {:type => 'number',
-                                              :mutable => true,
-                                              :pattern => '\d+' }
-      self.attributes['occi.storage.state'] = {:pattern => 'online|offline|backup|snapshot|resize|degraded',
-                                               :default => 'offline'}
-
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/infrastructure#',
-                                       term='storage',
-                                       title = 'storage resource',
-                                       attributes = Occi::Core::Attributes.new(self.attributes),
-                                       parent=Occi::Core::Resource.kind,
-                                       actions = Occi::Core::Actions.new(self.actions),
-                                       location = '/storage/'
-
-      def size
-        @attributes.occi_.storage_['size']
-      end
-
-      def size=(size)
-        @attributes.occi!.storage!['size'] = size
-      end
-
-      def state
-        @attributes.occi_.storage_.state
-      end
-
-      def state=(state)
-        @attributes.occi!.storage!.state = state
-      end
-
-    end
+    # Dummy sub-class of `Occi::Core::Resource` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Storage < Occi::Core::Resource; end
   end
 end

data/lib/occi/infrastructure/storagelink.rb

@@ -1,58 +1,9 @@
 module Occi
   module Infrastructure
-    class Storagelink < Occi::Core::Link
-
-      online = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storagelink/action#',
-                                      term='online',
-                                      title='activate storagelink'
-
-      offline = Occi::Core::Action.new scheme='http://schemas.ogf.org/occi/infrastructure/storagelink/action#',
-                                       term='offline',
-                                       title='deactivate storagelink'
-
-      self.actions = Occi::Core::Actions.new << online << offline
-
-      self.attributes = Occi::Core::Attributes.new(Occi::Core::Link.attributes)
-      self.attributes['occi.storagelink.deviceid'] = {:mutable => true}
-      self.attributes['occi.storagelink.mountpoint'] = {:mutable => true}
-      self.attributes['occi.storagelink.state'] = {:type => 'string',
-                                                   :pattern => 'active|inactive|error',
-                                                   :default => 'inactive',
-                                                   :mutable => false}
-
-      self.kind = Occi::Core::Kind.new scheme='http://schemas.ogf.org/occi/infrastructure#',
-                                       term='storagelink',
-                                       title = 'storage link',
-                                       attributes = Occi::Core::Attributes.new(self.attributes),
-                                       parent=Occi::Core::Link.kind,
-                                       actions = Occi::Core::Actions.new(self.actions),
-                                       location = '/link/storagelink/'
-
-
-      def deviceid
-        @attributes.occi_.storagelink_.deviceid
-      end
-
-      def deviceid=(deviceid)
-        @attributes.occi!.storagelink!.deviceid = deviceid
-      end
-
-      def mountpoint
-        @attributes.occi_.storagelink_.mountpoint
-      end
-
-      def mountpoint=(mountpoint)
-        @attributes.occi!.storagelink!.mountpoint = mountpoint
-      end
-
-      def state
-        @attributes.occi_.storagelink_.state
-      end
-
-      def state=(state)
-        @attributes.occi!.storagelink!.state = state
-      end
-
-    end
+    # Dummy sub-class of `Occi::Core::Link` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Storagelink < Occi::Core::Link; end
   end
 end

data/lib/occi/infrastructure/version.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Infrastructure
+    VERSION = ::Occi::Core::VERSION
+  end
+end

data/lib/occi/infrastructure/warehouse/actions/compute_restart.yml

@@ -0,0 +1,12 @@
+---
+term: restart
+schema: http://schemas.ogf.org/occi/infrastructure/compute/action#
+title: Restart compute via the specified method
+attributes:
+  method:
+    type: !ruby/class String
+    required: false
+    mutable: true
+    default: cold
+    description: Restart method
+    pattern: !ruby/regexp '/^(graceful|warm|cold)$/'

data/lib/occi/infrastructure/warehouse/actions/compute_save.yml

@@ -0,0 +1,19 @@
+---
+term: save
+schema: http://schemas.ogf.org/occi/infrastructure/compute/action#
+title: Makes an independent copy of the compute instance
+attributes:
+  method:
+    type: !ruby/class String
+    required: false
+    mutable: true
+    default: deffered
+    description: Save method
+    pattern: !ruby/regexp '/^(hot|deffered)$/'
+  name:
+    type: !ruby/class String
+    required: false
+    mutable: true
+    default: ~
+    description: Name of the copy
+    pattern: !ruby/regexp '/^[[:alnum:]]+$/'

data/lib/occi/infrastructure/warehouse/actions/compute_start.yml

@@ -0,0 +1,4 @@
+---
+term: start
+schema: http://schemas.ogf.org/occi/infrastructure/compute/action#
+title: Change compute status to active

data/lib/occi/infrastructure/warehouse/actions/compute_stop.yml

@@ -0,0 +1,12 @@
+---
+term: stop
+schema: http://schemas.ogf.org/occi/infrastructure/compute/action#
+title: Change compute status to inactive
+attributes:
+  method:
+    type: !ruby/class String
+    required: false
+    mutable: true
+    default: poweroff
+    description: Stop method
+    pattern: !ruby/regexp '/^(graceful|acpioff|poweroff)$/'

data/lib/occi/infrastructure/warehouse/actions/compute_suspend.yml

@@ -0,0 +1,12 @@
+---
+term: suspend
+schema: http://schemas.ogf.org/occi/infrastructure/compute/action#
+title: Change compute status to suspended
+attributes:
+  method:
+    type: !ruby/class String
+    required: false
+    mutable: true
+    default: suspend
+    description: Suspend method
+    pattern: !ruby/regexp '/^(hibernate|suspend)$/'

data/lib/occi/infrastructure/warehouse/actions/network_down.yml

@@ -0,0 +1,4 @@
+---
+term: down
+schema: http://schemas.ogf.org/occi/infrastructure/network/action#
+title: Change network status to inactive

data/lib/occi/infrastructure/warehouse/actions/network_up.yml

@@ -0,0 +1,4 @@
+---
+term: up
+schema: http://schemas.ogf.org/occi/infrastructure/network/action#
+title: Change network status to active

data/lib/occi/infrastructure/warehouse/actions/networkinterface_down.yml

@@ -0,0 +1,4 @@
+---
+term: down
+schema: http://schemas.ogf.org/occi/infrastructure/networkinterface/action#
+title: Change networkinterface status to inactive

data/lib/occi/infrastructure/warehouse/actions/networkinterface_up.yml

@@ -0,0 +1,4 @@
+---
+term: up
+schema: http://schemas.ogf.org/occi/infrastructure/networkinterface/action#
+title: Change networkinterface status to active

data/lib/occi/infrastructure/warehouse/actions/storage_backup.yml

@@ -0,0 +1,4 @@
+---
+term: backup
+schema: http://schemas.ogf.org/occi/infrastructure/storage/action#
+title: Make a backup of the storage instance

data/lib/occi/infrastructure/warehouse/actions/storage_offline.yml

@@ -0,0 +1,4 @@
+---
+term: offline
+schema: http://schemas.ogf.org/occi/infrastructure/storage/action#
+title: Change storage status to offline

data/lib/occi/infrastructure/warehouse/actions/storage_online.yml

@@ -0,0 +1,4 @@
+---
+term: online
+schema: http://schemas.ogf.org/occi/infrastructure/storage/action#
+title: Change storage status to online

data/lib/occi/infrastructure/warehouse/actions/storage_resize.yml

@@ -0,0 +1,12 @@
+---
+term: resize
+schema: http://schemas.ogf.org/occi/infrastructure/storage/action#
+title: Change the resize of the storage instance
+attributes:
+  size:
+    type: !ruby/class Integer
+    required: true
+    mutable: true
+    default: ~
+    description: Amount of storage in GBs.
+    pattern: ~

data/lib/occi/infrastructure/warehouse/actions/storage_snapshot.yml

@@ -0,0 +1,4 @@
+---
+term: snapshot
+schema: http://schemas.ogf.org/occi/infrastructure/storage/action#
+title: Make a snapshot of the storage instance  

data/lib/occi/infrastructure/warehouse/actions/storagelink_offline.yml

@@ -0,0 +1,4 @@
+---
+term: offline
+schema: http://schemas.ogf.org/occi/infrastructure/storagelink/action#
+title: Change storagelink status to inactive

data/lib/occi/infrastructure/warehouse/actions/storagelink_online.yml

@@ -0,0 +1,4 @@
+---
+term: online
+schema: http://schemas.ogf.org/occi/infrastructure/storagelink/action#
+title: Change storagelink status to active

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.compute.architecture.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: 'x64'
+description: Compute platform architecture.
+pattern: !ruby/regexp '/^(x86|x64)$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.compute.cores.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class Integer
+required: false
+mutable: true
+default: ~
+description: Number of compute processor cores.
+pattern: ~

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.compute.hostname.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: ~
+description: Compute FQDN.
+pattern: ~

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.compute.memory.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class Float
+required: false
+mutable: true
+default: ~
+description: Amount of compute memory in GBs.
+pattern: ~