occi-core 4.3.6 → 5.0.0.alpha.1

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

@@ -0,0 +1,7 @@
+---
+type: !ruby/class Float
+required: false
+mutable: true
+default: ~
+description: Relative speed of the compute instance.
+pattern: ~

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

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: Compute instance state.
+pattern: !ruby/regexp '/^(active|inactive|error|waiting|suspended)$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.network.label.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: ~
+description: Label of the network instance.
+pattern: ~

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.network.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: Network instance state.
+pattern: !ruby/regexp '/^(active|inactive|error)$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.network.vlan.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class Integer
+required: false
+mutable: true
+default: ~
+description: VLAN identifier or a tag.
+pattern: ~

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.networkinterface.interface.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: false
+default: ~
+description: Network interface name.
+pattern: !ruby/regexp '/^[[:alnum:]]+$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.networkinterface.mac.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: false
+default: ~
+description: Network interface MAC address.
+pattern: !ruby/regexp '/^([0-9a-fA-F]{2}[:-]){5}([0-9a-fA-F]{2})$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.networkinterface.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: Networkinterface instance state.
+pattern: !ruby/regexp '/^(active|inactive|error)$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.storage.size.yml

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

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.storage.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'offline'
+description: Storage instance state.
+pattern: !ruby/regexp '/^(online|offline|backup|snapshot|resize|degraded)$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.storagelink.deviceid.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: false
+default: ~
+description: Block device ID.
+pattern: !ruby/regexp '/^([[:alnum:]]|-|_|\/)+$/'

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.storagelink.mountpoint.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: false
+default: ~
+description: Block device mount point.
+pattern: ~

data/lib/occi/infrastructure/warehouse/kinds/attributes/occi.storagelink.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: Storagelink instance state.
+pattern: !ruby/regexp '/^(active|inactive|error|waiting)$/'

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

@@ -0,0 +1,19 @@
+---
+term: compute
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure Compute
+parent: http://schemas.ogf.org/occi/core#resource
+location: /compute/
+attributes:
+  - occi.compute.architecture
+  - occi.compute.cores
+  - occi.compute.hostname
+  - occi.compute.memory
+  - occi.compute.speed
+  - occi.compute.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/compute/action#start
+  - http://schemas.ogf.org/occi/infrastructure/compute/action#stop
+  - http://schemas.ogf.org/occi/infrastructure/compute/action#restart
+  - http://schemas.ogf.org/occi/infrastructure/compute/action#suspend
+  - http://schemas.ogf.org/occi/infrastructure/compute/action#save

data/lib/occi/infrastructure/warehouse/kinds/network.yml

@@ -0,0 +1,13 @@
+---
+term: network
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure Network
+parent: http://schemas.ogf.org/occi/core#resource
+location: /network/
+attributes:
+  - occi.network.vlan
+  - occi.network.label
+  - occi.network.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/network/action#up
+  - http://schemas.ogf.org/occi/infrastructure/network/action#down

data/lib/occi/infrastructure/warehouse/kinds/networkinterface.yml

@@ -0,0 +1,13 @@
+---
+term: networkinterface
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure NetworkInterface
+parent: http://schemas.ogf.org/occi/core#link
+location: /link/networkinterface/
+attributes:
+  - occi.networkinterface.interface
+  - occi.networkinterface.mac
+  - occi.networkinterface.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/networkinterface/action#up
+  - http://schemas.ogf.org/occi/infrastructure/networkinterface/action#down

data/lib/occi/infrastructure/warehouse/kinds/storage.yml

@@ -0,0 +1,15 @@
+---
+term: storage
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure Storage
+parent: http://schemas.ogf.org/occi/core#resource
+location: /storage/
+attributes:
+  - occi.storage.size
+  - occi.storage.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/storage/action#online
+  - http://schemas.ogf.org/occi/infrastructure/storage/action#offline
+  - http://schemas.ogf.org/occi/infrastructure/storage/action#backup
+  - http://schemas.ogf.org/occi/infrastructure/storage/action#snapshot
+  - http://schemas.ogf.org/occi/infrastructure/storage/action#resize

data/lib/occi/infrastructure/warehouse/kinds/storagelink.yml

@@ -0,0 +1,13 @@
+---
+term: storagelink
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure StorageLink
+parent: http://schemas.ogf.org/occi/core#link
+location: /link/storagelink/
+attributes:
+  - occi.storagelink.deviceid
+  - occi.storagelink.mountpoint
+  - occi.storagelink.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/storagelink/action#online
+  - http://schemas.ogf.org/occi/infrastructure/storagelink/action#offline

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.network.address.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class IPAddr
+required: false
+mutable: true
+default: ~
+description: IP address (v4 or v6) assigned to this instance.
+pattern: ~

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.network.allocation.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: 'static'
+description: Network address allocation mechanism.
+pattern: !ruby/regexp '/^(dynamic|static)$/'

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.network.gateway.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class IPAddr
+required: false
+mutable: true
+default: ~
+description: IP address (v4 or v6) of the pre-configured gateway.
+pattern: ~

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.networkinterface.address.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class IPAddr
+required: false
+mutable: true
+default: ~
+description: IP address (v4 or v6) assigned to this instance.
+pattern: ~

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.networkinterface.allocation.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: false
+mutable: true
+default: 'static'
+description: Network address allocation mechanism.
+pattern: !ruby/regexp '/^(dynamic|static)$/'

data/lib/occi/infrastructure/warehouse/mixins/attributes/occi.networkinterface.gateway.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class IPAddr
+required: false
+mutable: true
+default: ~
+description: IP address (v4 or v6) of the pre-configured gateway.
+pattern: ~

data/lib/occi/infrastructure/warehouse/mixins/ipnetwork.yml

@@ -0,0 +1,11 @@
+---
+term: ipnetwork
+schema: http://schemas.ogf.org/occi/infrastructure/network#
+title: OCCI IP Network mixin
+attributes:
+  - occi.network.address
+  - occi.network.allocation
+  - occi.network.gateway
+location: /mixin/ipnetwork/
+applies:
+  - http://schemas.ogf.org/occi/infrastructure#network

data/lib/occi/infrastructure/warehouse/mixins/ipnetworkinterface.yml

@@ -0,0 +1,11 @@
+---
+term: ipnetworkinterface
+schema: http://schemas.ogf.org/occi/infrastructure/networkinterface#
+title: OCCI IP NetworkInterface mixin
+attributes:
+  - occi.networkinterface.address
+  - occi.networkinterface.allocation
+  - occi.networkinterface.gateway
+location: /mixin/ipnetworkinterface/
+applies:
+  - http://schemas.ogf.org/occi/infrastructure#networkinterface

data/lib/occi/infrastructure/warehouse.rb

@@ -0,0 +1,20 @@
+module Occi
+  module Infrastructure
+    # Extended loader for static categories defined in the OCCI Infra Standard
+    # published by OGF's OCCI WG. This warehouse is meant to be used as a
+    # quick bootstrap tools for `Occi::Core::Model` instances. Instances passed
+    # to this warehouse MUST be already boostrapped by `Occi::Core::Warehouse`.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class Warehouse < Occi::Core::Warehouse
+      class << self
+        protected
+
+        # :nodoc:
+        def whereami
+          File.expand_path(File.dirname(__FILE__))
+        end
+      end
+    end
+  end
+end

data/lib/occi/infrastructure-ext.rb

@@ -0,0 +1,35 @@
+# internal deps
+require 'occi/infrastructure'
+
+# Contains all OCCI-related classes and modules. This module
+# does not provide any additional functionality aside from
+# acting as a wrapper and a namespace-defining mechanisms.
+# Please, defer to specific classes and modules within this
+# namespace for details and functionality descriptions.
+#
+# @author Boris Parak <parak@cesnet.cz>
+module Occi
+  # Contains all OCCI-Infra-Ext-related classes and modules. This
+  # module does not provide any additional functionality aside
+  # from acting as a wrapped, a namespace-defining mechanism,
+  # and versioning wrapper. Please, defer to specific classes
+  # and modules within this namespace for details and
+  # functionality descriptions.
+  #
+  # @author Boris Parak <parak@cesnet.cz>
+  module InfrastructureExt
+    autoload :Constants, 'occi/infrastructure_ext/constants'
+    autoload :Mixins, 'occi/infrastructure_ext/mixins'
+
+    autoload :SecurityGroup, 'occi/infrastructure_ext/securitygroup'
+    autoload :IPReservation, 'occi/infrastructure_ext/ipreservation'
+    autoload :SecurityGroupLink, 'occi/infrastructure_ext/securitygrouplink'
+
+    autoload :Model, 'occi/infrastructure_ext/model'
+    autoload :Warehouse, 'occi/infrastructure_ext/warehouse'
+    autoload :InstanceBuilder, 'occi/infrastructure_ext/instance_builder'
+  end
+end
+
+# Explicitly pull in versioning information
+require 'occi/infrastructure_ext/version'

data/lib/occi/infrastructure.rb

@@ -1,25 +1,40 @@
-require 'occi/infrastructure/compute'
-require 'occi/infrastructure/storage'
-require 'occi/infrastructure/storagelink'
-require 'occi/infrastructure/network'
-require 'occi/infrastructure/networkinterface'
+# internal deps
+require 'occi/core'
 
+# Contains all OCCI-related classes and modules. This module
+# does not provide any additional functionality aside from
+# acting as a wrapper and a namespace-defining mechanisms.
+# Please, defer to specific classes and modules within this
+# namespace for details and functionality descriptions.
+#
+# @author Boris Parak <parak@cesnet.cz>
 module Occi
+  # Contains all OCCI-Infra-related classes and modules. This
+  # module does not provide any additional functionality aside
+  # from acting as a wrapped, a namespace-defining mechanism,
+  # and versioning wrapper. Please, defer to specific classes
+  # and modules within this namespace for details and
+  # functionality descriptions.
+  #
+  # @author Boris Parak <parak@cesnet.cz>
   module Infrastructure
+    autoload :Constants, 'occi/infrastructure/constants'
+    autoload :Mixins, 'occi/infrastructure/mixins'
 
-    extend Occi
-
-    def self.kinds
-      Occi::Core::Kinds.new << Occi::Infrastructure::Compute.kind << Occi::Infrastructure::Storage.kind << Occi::Infrastructure::Network.kind << Occi::Infrastructure::Networkinterface.kind << Occi::Infrastructure::Storagelink.kind
-    end
-
-    def self.mixins
-      Occi::Infrastructure::Compute.mixins + Occi::Infrastructure::Storage.mixins + Occi::Infrastructure::Network.mixins + Occi::Infrastructure::Networkinterface.mixins + Occi::Infrastructure::Storagelink.mixins
-    end
-
-    def self.actions
-      Occi::Infrastructure::Compute.actions + Occi::Infrastructure::Storage.actions + Occi::Infrastructure::Network.actions + Occi::Infrastructure::Networkinterface.actions + Occi::Infrastructure::Storagelink.actions
-    end
+    autoload :Compute, 'occi/infrastructure/compute'
+    autoload :Network, 'occi/infrastructure/network'
+    autoload :Storage, 'occi/infrastructure/storage'
+    autoload :SecurityGroup, 'occi/infrastructure/securitygroup'
+    autoload :IPReservation, 'occi/infrastructure/ipreservation'
+    autoload :Networkinterface, 'occi/infrastructure/networkinterface'
+    autoload :Storagelink, 'occi/infrastructure/storagelink'
+    autoload :SecurityGroupLink, 'occi/infrastructure/securitygrouplink'
 
+    autoload :Model, 'occi/infrastructure/model'
+    autoload :Warehouse, 'occi/infrastructure/warehouse'
+    autoload :InstanceBuilder, 'occi/infrastructure/instance_builder'
   end
-end
+end
+
+# Explicitly pull in versioning information
+require 'occi/infrastructure/version'

data/lib/occi/infrastructure_ext/constants.rb

@@ -0,0 +1,20 @@
+module Occi
+  module InfrastructureExt
+    # Module containing important constats defined in OGF's Infrastructure Extension documents.
+    # Here, you can find commonly used kind identifiers for `SecurityGroup`, `SecurityGroupLink`,
+    # `IPReservation`, and others.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    module Constants
+      # Resource sub-types
+      SECURITY_GROUP_KIND = 'http://schemas.ogf.org/occi/infrastructure#securitygroup'.freeze
+      IPRESERVATION_KIND  = 'http://schemas.ogf.org/occi/infrastructure#ipreservation'.freeze
+
+      # Link sub-types
+      SECURITY_GROUP_LINK_KIND = 'http://schemas.ogf.org/occi/infrastructure#securitygrouplink'.freeze
+
+      # Mixins
+      AVAILABILITY_ZONE_MIXIN  = 'http://schemas.ogf.org/occi/infrastructure#availability_zone'.freeze
+    end
+  end
+end

data/lib/occi/infrastructure_ext/instance_builder.rb

@@ -0,0 +1,22 @@
+module Occi
+  module InfrastructureExt
+    # See `Occi::infrastructure::InstanceBuilder` for details.
+    #
+    # @attr model [Occi::InfrastructureExt::Model] model filled with known category definitions
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class InstanceBuilder < Occi::Infrastructure::InstanceBuilder
+      class << self
+        # :nodoc:
+        def klass_map
+          ns = Occi::InfrastructureExt
+          super.merge(
+            ns::Constants::SECURITY_GROUP_KIND => ns::SecurityGroup,
+            ns::Constants::IPRESERVATION_KIND => ns::IPReservation,
+            ns::Constants::SECURITY_GROUP_LINK_KIND => ns::SecurityGroupLink
+          )
+        end
+      end
+    end
+  end
+end

data/lib/occi/infrastructure_ext/ipreservation.rb

@@ -0,0 +1,9 @@
+module Occi
+  module InfrastructureExt
+    # Dummy sub-class of `Occi::Infrastructure::Network` meant to simplify handling
+    # of known instances of the given sub-class. Does not contain any functionality.
+    #
+    # @author Boris Parak <parak@cesnet.cz>
+    class IPReservation < Occi::Infrastructure::Network; end
+  end
+end

data/lib/occi/infrastructure_ext/mixins/availability_zone.rb

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

data/lib/occi/infrastructure_ext/mixins.rb

@@ -0,0 +1,12 @@
+module Occi
+  module InfrastructureExt
+    # Contains various INFRA-Ext-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_ext/model.rb

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

data/lib/occi/infrastructure_ext/securitygroup.rb

@@ -0,0 +1,9 @@
+module Occi
+  module InfrastructureExt
+    # 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 SecurityGroup < Occi::Core::Resource; end
+  end
+end

data/lib/occi/infrastructure_ext/securitygrouplink.rb

@@ -0,0 +1,9 @@
+module Occi
+  module InfrastructureExt
+    # 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 SecurityGroupLink < Occi::Core::Link; end
+  end
+end

data/lib/occi/infrastructure_ext/version.rb

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

data/lib/occi/infrastructure_ext/warehouse/actions/ipreservation_down.yml

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

data/lib/occi/infrastructure_ext/warehouse/actions/ipreservation_up.yml

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

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.ipreservation.address.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class IPAddr
+required: true
+mutable: true
+default: ~
+description: IP address (v4 or v6) assigned to this reservation.
+pattern: ~

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.ipreservation.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: IPReservation instance state.
+pattern: !ruby/regexp '/^(active|inactive|error)$/'

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.ipreservation.used.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/module Boolean
+required: true
+mutable: false
+default: false
+description: Status of the IPReservation instance.
+pattern: ~

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.securitygroup.rules.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class Array
+required: true
+mutable: true
+default: ~
+description: Status of the IPReservation instance.
+pattern: ~

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.securitygroup.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: SecurityGroup instance state.
+pattern: !ruby/regexp '/^(active|inactive|error)$/'

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.securitygrouplink.state.yml

@@ -0,0 +1,7 @@
+---
+type: !ruby/class String
+required: true
+mutable: false
+default: 'inactive'
+description: SecurityGroupLink instance state.
+pattern: !ruby/regexp '/^(active|inactive|error)$/'

data/lib/occi/infrastructure_ext/warehouse/kinds/ipreservation.yml

@@ -0,0 +1,13 @@
+---
+term: ipreservation
+schema: http://schemas.ogf.org/occi/infrastructure#
+title: OCCI Infrastructure IP Reservation
+parent: http://schemas.ogf.org/occi/infrastructure#network
+location: /ipreservation/
+attributes:
+  - occi.ipreservation.address
+  - occi.ipreservation.used
+  - occi.ipreservation.state
+actions:
+  - http://schemas.ogf.org/occi/infrastructure/ipreservation/action#up
+  - http://schemas.ogf.org/occi/infrastructure/ipreservation/action#down