fog-openstack 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3c4d1c427e750aa77389354355ca0f437fc70e0
-  data.tar.gz: bbeae160627a5fcf20fdf5278bbcf766a3a60e49
+  metadata.gz: 9a3a52ccf8ef9aec1efe22b6cee7d6cfa6ca1a28
+  data.tar.gz: 29297c4505150b3a29f696dfd31620369b8d6544
 SHA512:
-  metadata.gz: 5e2d9bb935bcbee9cde4705d8c40ceb0c74ccda1f4965cbb270be9c31d7bda7e453878fd3340082aff9725ba1745029b90b8140b70878919c1297fa3ef4be51c
-  data.tar.gz: deb48e9bac485300c4349e463a3865facc4fc157f8096f5a856e57c3b4a3bedb5e1ff5f66f3e14c38821459e583a1a94f9e33686b14ced362851ad7aff08a4a6
+  metadata.gz: ca9f9563a28b33ed86c16ff22c7c37be97a63c67898c408918b2f054478304252628d10260174e8a786d56d65773c2e2d2e622b49e4c93b1477e59eb4f4dff59
+  data.tar.gz: eedee34b9856b255b2996071a6f8d907221d135d44ecec5b46f5c18593dc4300f5bb02d5f805e7c1e8e9e3fcd90550efd2a5426ed22e87103d406770a061471c

data/fog-openstack.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'fog-core',  '>= 1.35'
+  spec.add_dependency 'fog-core',  '>= 1.37'
   spec.add_dependency 'fog-json',  '>= 1.0'
   spec.add_dependency 'fog-xml',   '>= 0.1'
   spec.add_dependency 'ipaddress', '>= 0.8'

data/lib/fog/openstack.rb

@@ -9,42 +9,54 @@ require 'fog/openstack/errors'
 require 'fog/openstack/compute'
 require 'fog/openstack/identity_v2'
 require 'fog/openstack/identity_v3'
-require 'fog/openstack/image'
 require 'fog/openstack/image_v1'
 require 'fog/openstack/image_v2'
-require 'fog/openstack/metering'
-require 'fog/openstack/network'
-require 'fog/openstack/orchestration'
 require 'fog/openstack/storage'
-require 'fog/openstack/volume'
 require 'fog/openstack/volume_v1'
 require 'fog/openstack/volume_v2'
-require 'fog/openstack/baremetal'
 require 'fog/openstack/planning'
 
 module Fog
+  module Compute
+    autoload :OpenStack, File.expand_path('../openstack/compute', __FILE__)
+  end
+
+  module Identity
+    autoload :OpenStack, File.expand_path('../openstack/identity', __FILE__)
+  end
+
+  module Image
+    autoload :OpenStack, File.expand_path('../openstack/image', __FILE__)
+  end
+
+  module Metering
+    autoload :OpenStack, File.expand_path('../openstack/metering', __FILE__)
+  end
+
+  module Network
+    autoload :OpenStack, File.expand_path('../openstack/network', __FILE__)
+  end
+
+  module Orchestration
+    autoload :OpenStack, File.expand_path('../openstack/orchestration', __FILE__)
+  end
+
+  module Volume
+    autoload :OpenStack, File.expand_path('../openstack/volume', __FILE__)
+  end
+
+  module Baremetal
+    autoload :OpenStack, File.expand_path('../openstack/baremetal', __FILE__)
+  end
+
+  module Introspection
+    autoload :OpenStack, File.expand_path('../openstack/introspection', __FILE__)
+  end
+
   module OpenStack
     extend Fog::Provider
 
-    # `require` is necessary until they can be refactored into autoload
-    require 'fog/openstack/image_v1'
-    require 'fog/openstack/storage'
-    require 'fog/openstack/volume_v1'
-    require 'fog/openstack/volume_v2'
-    require 'fog/openstack/planning'
-
-    autoload :Compute, File.expand_path('../openstack/compute', __FILE__)
-    autoload :IdentityV2, File.expand_path('../openstack/identity_v2', __FILE__)
-    autoload :IdentityV3, File.expand_path('../openstack/identity_v3', __FILE__)
-    autoload :Image, File.expand_path('../openstack/image', __FILE__)
-    autoload :ImageV2, File.expand_path('../openstack/image_v2', __FILE__)
-    autoload :Metering, File.expand_path('../openstack/metering', __FILE__)
-    autoload :Network, File.expand_path('../openstack/network', __FILE__)
-    autoload :Orchestration, File.expand_path('../openstack/orchestration', __FILE__)
-    autoload :Volume, File.expand_path('../openstack/volume', __FILE__)
-    autoload :Baremetal, File.expand_path('../openstack/baremetal', __FILE__)
-
-    service(:compute ,      'Compute')
+    service(:compute,       'Compute')
     service(:image,         'Image')
     service(:identity,      'Identity')
     service(:network,       'Network')
@@ -54,6 +66,7 @@ module Fog
     service(:orchestration, 'Orchestration')
     service(:baremetal,     'Baremetal')
     service(:planning,      'Planning')
+    service(:introspection, 'Introspection')
 
     @@token_cache = {}
 
@@ -137,14 +150,6 @@ module Fog
 
       end
 
-      service['endpoints'] = service['endpoints'].select do |endpoint|
-        endpoint['region'] == openstack_region
-      end if openstack_region
-
-      if service['endpoints'].empty?
-        raise Fog::Errors::NotFound.new("No endpoints available for region '#{openstack_region}'")
-      end if openstack_region
-
       unless service
         available = body['access']['serviceCatalog'].map { |endpoint|
           endpoint['type']
@@ -157,6 +162,14 @@ module Fog
         raise Fog::Errors::NotFound, message
       end
 
+      service['endpoints'] = service['endpoints'].select do |endpoint|
+        endpoint['region'] == openstack_region
+      end if openstack_region
+
+      if service['endpoints'].empty?
+        raise Fog::Errors::NotFound.new("No endpoints available for region '#{openstack_region}'")
+      end if openstack_region
+
       regions = service["endpoints"].map{ |e| e['region'] }.uniq
       if regions.count > 1
         raise Fog::Errors::NotFound.new("Multiple regions available choose one of these '#{regions.join(',')}'")

data/lib/fog/openstack/docs/compute.md

@@ -10,14 +10,13 @@ Start by executing the following command:
 
 Once `irb` has launched you need to require the Fog library by executing:
 
-	require 'fog'
+	require 'fog/openstack'
 
 ## Create Service
 
 Next, create a connection to the Compute Service:
 
-	service = Fog::Compute.new({
-		:provider            => 'openstack',                                      # OpenStack Fog provider
+	service = Fog::Compute::OpenStack.new({
 		:openstack_auth_url  => 'http://KEYSTONE_HOST:KEYSTONE_PORT/v2.0/tokens', # OpenStack Keystone endpoint
 		:openstack_username  => OPEN_STACK_USER,                                  # Your OpenStack Username
 		:openstack_tenant    => OPEN_STACK_TENANT,                                # Your tenant id

data/lib/fog/openstack/docs/getting_started.md

@@ -20,16 +20,16 @@ Bundler helps manage gem dependencies and is recommended for new projects. For m
 
 ## Installation
 
-To install Fog via RubyGems run the following command:
+To install Fog-Openstack via RubyGems run the following command:
 
-    $ gem install fog
+    $ gem install fog-openstack
 
 To install Fog via Bundler add `gem 'fog'` to your `Gemfile`. This is a sample `Gemfile` to install Fog:
 
 ```ruby
 source 'https://rubygems.org'
 
-gem 'fog'
+gem 'fog-openstack'
 ```
 
 After creating your `Gemfile` execute the following command to install the libraries:
@@ -50,13 +50,13 @@ If using Ruby 1.8.x execute the following command:
 
 ```ruby
 require 'rubygems'
-require 'fog'
+require 'fog/openstack'
 ```
 
 If using Ruby 1.9.x execute the following command:
 
 ```ruby
-require 'fog'
+require 'fog/openstack'
 ```
 
 You should now be able to execute the following command to see a list of services Fog provides for the Rackspace Open Cloud:

data/lib/fog/openstack/docs/introspection.md

@@ -0,0 +1,251 @@
+# Introspection
+
+This document explains how to get started using introspection with
+fog-openstack.
+
+Please also refer to the
+[Getting Started with Fog and the OpenStack](getting_started.md) document.
+
+Introspection service is implemented by the OpenStack ironic-inspector project.
+Introspection is strongly related to the Baremetal service (Ironic project).
+Effectively, Instrospection communicates and operates on nodes defined by the
+Baremetal layer (Ironic).
+
+# OpenStack setup
+
+## The catalog
+For the fog-openstack's introspection service to work, the corresponding
+service must be defined in the OpenStack catalog.
+
+```bash
+openstack catalog show inspector
++-----------+-----------------------------------------+
+| Field     | Value                                   |
++-----------+-----------------------------------------+
+| endpoints | regionOne                               |
+|           |   publicURL: http://192.0.2.1:5050/v1   |
+|           |   internalURL: http://192.0.2.1:5050/v1 |
+|           |   adminURL: http://192.0.2.1:5050/v1    |
+|           |                                         |
+| name      | inspector                               |
+| type      | introspection                           |
++-----------+-----------------------------------------+
+```
+
+Depending on the OpenStack release, the introspection service might be installed
+but not defined yet in the catalog. In such case, you must add the service and
+corresponding endpoints to create the catalog entry:
+
+```bash
+source ./stackrc
+openstack service create --name inspector --description "OpenStack Introspection" introspection
+openstack endpoint create --region regionOne inspector --publicurl http://example.com:5050/v1 --internalurl http://example.com:5050/v1 --adminurl http://example.com:5050/v1
+```
+
+## The introspection timeout
+The default timeout value after which introspection is considered failed is set
+by an 1 hour (3600 s) default. Although in production environment, baremetal
+introspection requires time, testing in virtual environment doesn't, this is why
+if you are in the latter case the timeout value can be reduced for speeding
+results:
+
+```bash
+sudo openstack-config --set /etc/ironic-inspector/inspector.conf DEFAULT timeout 300
+```
+
+# Work flow
+Assuming Baremetal nodes have been defined (imported), a usual work-flow might
+consist of:
+* Start introspection
+* Check introspection status or abort introspection
+* Retrieve introspection data
+* optionally, pre-defined DSL based rules can be defined and applied during
+  introspection.
+
+For more details about this process please refer to
+http://docs.openstack.org/developer/ironic-inspector/workflow.html
+
+
+Using 'irb', we start with authentication:
+
+```ruby
+@user     = "admin"
+@project  = "admin"
+@password = "secret"
+@base_url = "http://keystone.example.com:5000/v3/auth/tokens"
+
+require 'rubygems'
+require 'fog/openstack'
+
+@connection_params = {
+  :openstack_auth_url     => @base_url,
+  :openstack_username     => @user,
+  :openstack_api_key      => @password,
+  :openstack_project_name => @project,
+  :openstack_domain_id    => "default"
+}
+```
+## Baremetal node introspection
+
+### Baremetal nodes
+
+Find the available Baremetal nodes.
+
+```ruby
+iron = Fog::Baremetal::OpenStack.new(@connection_params)
+
+nodes = iron.node_list
+```
+
+### Start introspection
+
+Let's start introspection using the first available node.
+
+Note: To be introspected, a node must be in "manage" state. If needed, use Baremetal Service
+to change the state with set_node_provision_state.
+
+For more information, please refer to
+http://docs.openstack.org/developer/ironic/deploy/install-guide.html#hardware-inspection
+
+```ruby
+node_id = nodes.body["nodes"][0]["uuid"]
+inspector = Fog::Introspection::OpenStack.new(@connection_params)
+
+introspection1 = inspector.create_introspection(node_id)
+```
+If everything went well the status returned by the request must be 202 which
+means accepted:
+```ruby
+introspection1.status
+=> 202
+```
+
+### Check introspection status
+
+To check the status of the introspection:
+```ruby
+inspector.get_introspection(node_id)
+```
+
+The body returned has 2 fields:
+* finished: A boolean, set to true if introspection process is finished
+* error: A null string unless an error occurred or the process was canceled by
+  the operator (in case introspection was aborted)
+
+### Abort an ongoing introspection
+
+To abort a node introspection:
+```ruby
+inspector.abort_introspection(node_id)
+```
+
+### Retrieve introspected data
+
+```ruby
+inspector.get_introspection_details(node_id)
+```
+The response body will provide a *very* long list of information about the node.
+
+## DSL rules
+
+### Create rules
+
+```ruby
+rule_set1 = {
+  "description" => "Successful Rule",
+  "actions"     => [
+    {
+      "action" => "set-attribute",
+      "path"   => "/extra/rule_success",
+      "value"  => "yes"
+    }
+  ],
+  "conditions"  => [
+    {
+      "field" => "memory_mb",
+      "op"    => "ge",
+      "value" => 256
+    },
+    {
+      "field" => "local_gb",
+      "op"    => "ge",
+      "value" => 1
+    }
+  ]
+}
+
+rule_set2 = {
+  "description" => "Failing Rule",
+  "actions"     => [
+    {
+      "action" => "set-attribute",
+      "path"   => "/extra/rule_success",
+      "value"  => "no"
+    },
+    {
+      "action"  => "fail",
+      "message" => "This rule should not have run"
+    }
+  ],
+  "conditions"  => [
+    {
+      "field" => "memory_mb",
+      "op"    => "lt",
+      "value" => 42
+    },
+    {
+      "field" => "local_gb",
+      "op"    => "eq",
+      "value" => 0
+    }
+  ],
+}
+
+inspector.create_rules(rule_set1)
+inspector.create_rules(rule_set2)
+```
+
+### List all rules
+
+```ruby
+inspector.list_rules.body
+=> {"rules"=>
+  [{"description"=>"Successful Rule",
+    "links"=>[{"href"=>"/v1/rules/4bf1bf40-d30f-4f31-a970-f0290d7e751b", "rel"=>"self"}],
+    "uuid"=>"4bf1bf40-d30f-4f31-a970-f0290d7e751b"},
+   {"description"=>"Failing Rule",
+    "links"=>[{"href"=>"/v1/rules/0d6e6687-3f69-4c14-8cab-ea6ada78036f", "rel"=>"self"}],
+    "uuid"=>"0d6e6687-3f69-4c14-8cab-ea6ada78036f"}]}
+```
+
+### Show rules details
+
+```ruby
+inspector.get_rules('0d6e6687-3f69-4c14-8cab-ea6ada78036f').body
+=> {"actions"=>
+  [{"action"=>"set-attribute", "path"=>"/extra/rule_success", "value"=>"no"},
+   {"action"=>"fail", "message"=>"This rule should not have run"}],
+ "conditions"=>[{"field"=>"memory_mb", "op"=>"lt", "value"=>42}, {"field"=>"local_gb", "op"=>"eq", "value"=>0}],
+ "description"=>"Failing Rule",
+ "links"=>[{"href"=>"/v1/rules/0d6e6687-3f69-4c14-8cab-ea6ada78036f", "rel"=>"self"}],
+ "uuid"=>"0d6e6687-3f69-4c14-8cab-ea6ada78036f"}
+```
+
+### Delete a specific rules set
+
+```ruby
+inspector.delete_rules'0d6e6687-3f69-4c14-8cab-ea6ada78036f')
+inspector.list_rules.body
+=> {"rules"=>
+  [{"description"=>"Successful Rule",
+    "links"=>[{"href"=>"/v1/rules/4bf1bf40-d30f-4f31-a970-f0290d7e751b", "rel"=>"self"}],
+    "uuid"=>"4bf1bf40-d30f-4f31-a970-f0290d7e751b"}]}
+```
+
+### Destroys all rules
+
+```ruby
+inspector.delete_rules_all
+inspector.list_rules.body
+=> {"rules"=>[]}
+```

data/lib/fog/openstack/docs/metering.md

@@ -20,9 +20,23 @@ service = Fog::Metering::OpenStack.new({
 
 ## Events
 
-* `service.events`: Return a list of events.
+* `service.events([<query_filter>])`: Return a list of events.
 * `service.events.find_by_id(<message_id>)`: Return the event matching message_id, or nil if no such event exists.
 
+### Filter events example
+
+Return events newer than 2016-03-17T09:59:44.606000.
+
+```ruby
+query_filter = [{
+  'field' => 'start_timestamp',
+  'op'    => 'gt',
+  'value' => '2016-03-17T09:59:44.606000'
+}]
+
+service.events(query_filter)
+```
+
 ## Resources
 
 * `service.resources`: Return a list of resources.