fog-maestrodev 1.8.0.20130114204828 → 1.14.0.20130806165225

data/lib/fog/openstack/compute.rb

@@ -10,7 +10,8 @@ module Fog
                  :persistent, :openstack_service_type, :openstack_service_name,
                  :openstack_tenant,
                  :openstack_api_key, :openstack_username, :openstack_identity_endpoint,
-                 :current_user, :current_tenant, :openstack_region
+                 :current_user, :current_tenant, :openstack_region,
+                 :openstack_endpoint_type
 
       ## MODELS
       #
@@ -92,6 +93,11 @@ module Fog
       request :create_flavor
       request :delete_flavor
 
+      # Flavor Access
+      request :add_flavor_access
+      request :remove_flavor_access
+      request :list_tenants_with_flavor_access
+
       # Metadata
       request :list_metadata
       request :get_metadata
@@ -99,6 +105,10 @@ module Fog
       request :update_metadata
       request :delete_metadata
 
+      # Metadatam
+      request :delete_meta
+      request :update_meta
+
       # Address
       request :list_addresses
       request :list_address_pools
@@ -221,7 +231,8 @@ module Fog
                 'volumes'        => 10,
                 'cores'          => 20,
                 'ram'            => 51200
-              }
+              },
+              :volumes => {}
             }
           end
         end
@@ -294,6 +305,7 @@ module Fog
           @openstack_service_type = options[:openstack_service_type] || ['nova', 'compute']
           @openstack_service_name = options[:openstack_service_name]
           @openstack_identity_service_type = options[:openstack_identity_service_type] || 'identity'
+          @openstack_endpoint_type = options[:openstack_endpoint_type] || 'publicURL'
           @openstack_region      = options[:openstack_region]
 
           @connection_options = options[:connection_options] || {}
@@ -332,7 +344,7 @@ module Fog
               }.merge!(params[:headers] || {}),
               :host     => @host,
               :path     => "#{@path}/#{@tenant_id}/#{params[:path]}",
-              :query    => params[:query] || ('ignore_awful_caching' << Time.now.to_i.to_s)
+              :query    => params[:query]
             }))
           rescue Excon::Errors::Unauthorized => error
             if error.response.body != 'Bad username or password' # token expiration
@@ -351,7 +363,7 @@ module Fog
               end
           end
 
-          unless response.body.empty?
+          if !response.body.empty? and response.get_header('Content-Type') == 'application/json'
             response.body = Fog::JSON.decode(response.body)
           end
 
@@ -371,7 +383,8 @@ module Fog
               :openstack_tenant     => @openstack_tenant,
               :openstack_service_type => @openstack_service_type,
               :openstack_service_name => @openstack_service_name,
-              :openstack_identity_service_type => @openstack_identity_service_type
+              :openstack_identity_service_type => @openstack_identity_service_type,
+              :openstack_endpoint_type => @openstack_endpoint_type
             }
 
             if @openstack_auth_uri.path =~ /\/v2.0\//
@@ -405,9 +418,9 @@ module Fog
           @scheme = uri.scheme
            
           # Not all implementations have identity service in the catalog
-          if @openstack_identity_public_endpoint
+          if @openstack_identity_public_endpoint || @openstack_management_url
             @identity_connection = Fog::Connection.new(
-              @openstack_identity_public_endpoint,
+              @openstack_identity_public_endpoint || @openstack_management_url,
               false, @connection_options)
           end
 

data/lib/fog/openstack/examples/identity/basics.rb

@@ -0,0 +1,69 @@
+# OpenStack Identity Service (Keystone) Example
+
+require 'fog'
+require 'pp'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+
+keystone = Fog::Identity.new :provider           => 'OpenStack',
+                             :openstack_auth_url => auth_url,
+                             :openstack_username => username,
+                             :openstack_api_key  => password
+                             # Optional, self-signed certs
+                             #:connection_options => { :ssl_verify_peer => false }
+
+#
+# Listing keystone tenants
+#
+keystone.tenants.each do |tenant|
+  # <Fog::Identity::OpenStack::Tenant
+  #   id="46b4ab...",
+  #   description=nil,
+  #   enabled=1,
+  #   name="admin@example.net"
+  # >
+  pp tenant
+end
+
+#
+# List users
+#
+keystone.users.each do |user|
+  # <Fog::Identity::OpenStack::User
+  #   id="c975f...",
+  #   email="quantum@example.net",
+  #   enabled=true,
+  #   name="quantum",
+  #   tenant_id="00928...",
+  #   password=nil
+  # >
+  # ...
+  pp user
+end
+
+#
+# Create a new tenant
+#
+tenant = keystone.tenants.create :name        => 'rubiojr@example.net',
+                                 :description => 'My foo tenant'
+
+#
+# Create a new user
+#
+user = keystone.users.create :name      => 'rubiojr@example.net',
+                             :tenant_id => tenant.id,
+                             :password  => 'rubiojr@example.net',
+                             :email     => 'rubiojr@example.net'
+
+
+# Find the recently created tenant
+tenant = keystone.tenants.find { |t| t.name == 'rubiojr@example.net' }
+# Destroy the tenant
+tenant.destroy
+
+# Find the recently created user 
+user = keystone.users.find { |u| u.name == 'rubiojr@example.net' }
+# Destroy the user
+user.destroy

data/lib/fog/openstack/examples/image/upload-test-image.rb

@@ -0,0 +1,77 @@
+require 'securerandom'
+require 'rubygems/package'
+require 'zlib'
+require 'fog'
+
+#
+# Download CirrOS 0.3.0 image from launchpad (~6.5MB) to /tmp
+# and upload it to Glance (the OpenStack Image Service).
+#
+# You will need to source OpenStack credentials since the script
+# reads the following envionment variables:
+#
+#  OS_PASSWORD
+#  OS_USERNAME
+#  OS_AUTH_URL
+#  OS_TENANT_NAME
+#
+# Should work with Fog >= 1.9, ruby 1.8.7 and 2.0
+#
+image_url = "https://launchpadlibrarian.net/83305869/cirros-0.3.0-x86_64-uec.tar.gz"
+image_out = File.open("/tmp/cirros-image-#{SecureRandom.hex}", 'wb')
+extract_path = "/tmp/cirros-#{SecureRandom.hex}-dir"
+ami = "#{extract_path}/cirros-0.3.0-x86_64-blank.img"
+aki = "#{extract_path}/cirros-0.3.0-x86_64-vmlinuz"
+ari = "#{extract_path}/cirros-0.3.0-x86_64-initrd"
+
+FileUtils.mkdir_p extract_path
+
+# Efficient image write
+puts "Downloading Cirros image..."
+streamer = lambda do |chunk, remaining_bytes, total_bytes|
+  image_out.write chunk
+end
+Excon.get image_url, :response_block => streamer
+image_out.close
+puts "Image downloaded to #{image_out.path}"
+
+puts "Extracting image contents to #{extract_path}..."
+Gem::Package::TarReader.new(Zlib::GzipReader.open(image_out.path)).each do |entry|
+  FileUtils.mkdir_p "#{extract_path}/#{File.dirname(entry.full_name)}"
+  File.open "#{extract_path}/#{entry.full_name}", 'w' do |f|
+    f.write entry.read
+  end
+end
+
+image_service = Fog::Image.new({
+  :provider => 'OpenStack',
+  :openstack_api_key => ENV['OS_PASSWORD'],
+  :openstack_username => ENV["OS_USERNAME"],
+  :openstack_auth_url => ENV["OS_AUTH_URL"] + "/tokens",
+  :openstack_tenant => ENV["OS_TENANT_NAME"]
+})
+
+puts "Uploading AKI..."
+aki = image_service.images.create :name => 'cirros-0.3.0-amd64-aki',
+                                  :size => File.size(aki),
+                                  :disk_format => 'aki',
+                                  :container_format => 'aki',
+                                  :location => aki
+
+puts "Uploading ARI..."
+ari = image_service.images.create :name => 'cirros-0.3.0-amd64-ari',
+                                  :size => File.size(ari),
+                                  :disk_format => 'ari',
+                                  :container_format => 'ari',
+                                  :location => ari
+
+puts "Uploading AMI..."
+image_service.images.create :name => 'cirros-0.3.0-amd64',
+                            :size => File.size(ami),
+                            :disk_format => 'ami',
+                            :container_format => 'ami',
+                            :location => ami,
+                            :properties => {
+                              'kernel_id'  => aki.id,
+                              'ramdisk_id' => ari.id
+                            }

data/lib/fog/openstack/examples/network/network_subnets_routers.rb

@@ -0,0 +1,63 @@
+require 'fog/openstack'
+
+#
+# Quantum demo
+#
+# Create some routers, networks and subnets for
+# a couple of tenants.
+#
+# Needs Fog >= 1.11.0
+# Needs OpenStack credentials in ~/.fog
+#
+
+def create_tenant_network( tenant_name,
+                           external_net,
+                           router_name = 'router1',
+                           subnet_range = '10.0.0.0/21',
+                           subnet_gateway = '10.0.0.1',
+                           private_network_name = 'private' )
+
+  network = Fog::Network[:openstack]
+  id = Fog::Identity[:openstack]
+  
+  tenant = id.tenants.find { |t| t.name == tenant_name }
+
+  # Create a router for the tenant
+  router = network.routers.create :name => router_name,
+                                  :tenant_id => tenant.id,
+                                  :external_gateway_info => { 
+                                    'network_id' => external_net.id
+                                  }
+
+  # Create a private network for the tenant
+  net = network.networks.create :name => private_network_name,
+                                :tenant_id => tenant.id
+
+  # Create a subnet for the previous network and associate it
+  # with the tenant
+  subnet = network.subnets.create :name => 'net_10',
+                                  :network_id  => net.id,
+                                  :ip_version  => 4,
+                                  :gateway_ip  => subnet_gateway,
+                                  :cidr        => subnet_range,
+                                  :tenant_id => tenant.id,
+                                  :enable_dhcp => true
+
+  network.add_router_interface router.id, subnet.id
+end
+
+# Create a public shared network
+public_net = network.networks.create :name => 'nova',
+                                     :router_external => true
+
+# Create the public subnet
+public_subnet = network.subnets.create :name => 'floating_ips_net',
+                                       :network_id  => public_net.id,
+                                       :ip_version  => 4,
+                                       :cidr        => '1.2.3.0/24',
+                                       :enable_dhcp => false
+
+
+# Create tenant networks
+create_tenant_network, 'admin@example.net', public_net
+create_tenant_network, 'demo@example.net', public_net

data/lib/fog/openstack/examples/storage/set-account-quota.rb

@@ -0,0 +1,66 @@
+require 'fog'
+require 'pp'
+
+#
+# This example sets the account quota (in bytes) for the tenant demo@test.lan
+# using an admin account (admin has the reseller user role).
+#
+# Uses the account impersonation feature recently added to the
+# OpenStack Storage service in Fog (See https://github.com/fog/fog/pull/1632).
+# 
+# Should be available in Fog 1.10.0+1.
+#
+# Setting account quotas is only supported in Swift 1.8.0+ 
+# using the brand new account_quota middleware introduced in 
+# OpenStack Grizzly (currently unreleased as of 2013/04/03).
+#
+# https://github.com/openstack/swift/blob/master/swift/common/middleware/account_quotas.py
+#
+
+auth_url = 'https://identity.test.lan/v2.0/tokens'
+user = 'admin@test.lan'
+password = 'secret'
+
+Excon.defaults[:ssl_verify_peer] = false
+
+# 
+# We are going to use the Identity (Keystone) service
+# to retrieve the list of tenants available and find
+# the tenant we want to set the quotas for.
+#
+id = Fog::Identity.new :provider => 'OpenStack',
+                       :openstack_auth_url => auth_url,
+                       :openstack_username => user,
+                       :openstack_api_key  => password
+
+#
+# Storage service (Swift)
+#
+st = Fog::Storage.new :provider => 'OpenStack',
+                      :openstack_auth_url => auth_url,
+                      :openstack_username => user,
+                      :openstack_api_key  => password
+
+id.tenants.each do |t|
+  # We want to set the account quota for tenant demo@test.lan
+  next unless t.name == 'demo@test.lan'
+
+  # We've found the tenant, impersonate the account
+  # (the account prefix AUTH_ may be different for you, double check it).
+  puts "Changing account to #{t.name}"
+  st.change_account "AUTH_#{t.id}"
+
+  # Now we're adding the required header to the demo@test.lan 
+  # tenant account, limiting the account bytes to 1048576 (1MB)
+  #
+  # Uploading more than 1MB will return 413: Request Entity Too Large
+  st.request :method => 'POST',
+             :headers => { 'X-Account-Meta-Quota-Bytes' => '1048576' }
+
+  # We can list the account details to verify the new 
+  # header has been added
+  pp st.request :method => 'HEAD'
+end
+
+# Restore the account we were using initially (admin@test.lan)
+st.reset_account_name

data/lib/fog/openstack/identity.rb

@@ -8,7 +8,8 @@ module Fog
       recognizes :openstack_auth_token, :openstack_management_url, :persistent,
                  :openstack_service_type, :openstack_service_name, :openstack_tenant,
                  :openstack_api_key, :openstack_username, :openstack_current_user_id,
-                 :current_user, :current_tenant
+                 :current_user, :current_tenant,
+                 :openstack_endpoint_type
 
       model_path 'fog/openstack/models/identity'
       model       :tenant
@@ -62,7 +63,6 @@ module Fog
 
       class Mock
         attr_reader :auth_token
-        attr_reader :unscoped_token
         attr_reader :auth_token_expiration
         attr_reader :current_user
         attr_reader :current_tenant
@@ -192,6 +192,8 @@ module Fog
           @connection_options = options[:connection_options] || {}
 
           @openstack_current_user_id = options[:openstack_current_user_id]
+          
+          @openstack_endpoint_type = options[:openstack_endpoint_type] || 'adminURL'
 
           @current_user = options[:current_user]
           @current_tenant = options[:current_tenant]
@@ -227,8 +229,6 @@ module Fog
               }.merge!(params[:headers] || {}),
               :host     => @host,
               :path     => "#{@path}/#{params[:path]}"#,
-              # Causes errors for some requests like tenants?limit=1
-              # :query    => ('ignore_awful_caching' << Time.now.to_i.to_s)
             }))
           rescue Excon::Errors::Unauthorized => error
             raise if retried
@@ -263,7 +263,7 @@ module Fog
               :openstack_tenant   => @openstack_tenant,
               :openstack_service_type => @openstack_service_type,
               :openstack_service_name => @openstack_service_name,
-              :openstack_endpoint_type => 'adminURL'
+              :openstack_endpoint_type => @openstack_endpoint_type
             }
 
             credentials = Fog::OpenStack.authenticate_v2(options, @connection_options)

data/lib/fog/openstack/image.rb

@@ -3,6 +3,8 @@ require 'fog/openstack'
 module Fog
   module Image
     class OpenStack < Fog::Service
+      SUPPORTED_VERSIONS = /v1(\.(0|1))*/
+
       requires :openstack_auth_url
       recognizes :openstack_auth_token, :openstack_management_url, :persistent,
                  :openstack_service_type, :openstack_service_name, :openstack_tenant,
@@ -148,8 +150,6 @@ module Fog
               }.merge!(params[:headers] || {}),
               :host     => @host,
               :path     => "#{@path}/#{params[:path]}"#,
-              # Causes errors for some requests like tenants?limit=1
-              # :query    => ('ignore_awful_caching' << Time.now.to_i.to_s)
             }))
           rescue Excon::Errors::Unauthorized => error
             if error.response.body != 'Bad username or password' # token expiration
@@ -206,6 +206,12 @@ module Fog
           @host   = uri.host
           @path   = uri.path
           @path.sub!(/\/$/, '')
+          unless @path.match(SUPPORTED_VERSIONS)
+            @path = "/" + Fog::OpenStack.get_supported_version(SUPPORTED_VERSIONS,
+                                                               uri,
+                                                               @auth_token,
+                                                               @connection_options)
+          end
           @port   = uri.port
           @scheme = uri.scheme
           true

data/lib/fog/openstack/metering.rb

@@ -0,0 +1,215 @@
+require 'fog/metering'
+require 'fog/openstack'
+
+module Fog
+  module Metering
+    class OpenStack < Fog::Service
+
+      requires :openstack_auth_url
+      recognizes :openstack_auth_token, :openstack_management_url, :persistent,
+                 :openstack_service_type, :openstack_service_name, :openstack_tenant,
+                 :openstack_api_key, :openstack_username,
+                 :current_user, :current_tenant,
+                 :openstack_endpoint_type
+
+      model_path 'fog/openstack/models/metering'
+
+      model       :resource
+      collection  :resources
+
+
+      request_path 'fog/openstack/requests/metering'
+
+      # Metering
+      request :get_resource
+      request :get_samples
+      request :get_statistics
+      request :list_meters
+      request :list_resources
+
+
+      class Mock
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            hash[key] = {
+              :users => {},
+              :tenants => {}
+            }
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options={})
+          require 'multi_json'
+          @openstack_username = options[:openstack_username]
+          @openstack_tenant   = options[:openstack_tenant]
+          @openstack_auth_uri = URI.parse(options[:openstack_auth_url])
+
+          @auth_token = Fog::Mock.random_base64(64)
+          @auth_token_expiration = (Time.now.utc + 86400).iso8601
+
+          management_url = URI.parse(options[:openstack_auth_url])
+          management_url.port = 8776
+          management_url.path = '/v1'
+          @openstack_management_url = management_url.to_s
+
+          @data ||= { :users => {} }
+          unless @data[:users].find {|u| u['name'] == options[:openstack_username]}
+            id = Fog::Mock.random_numbers(6).to_s
+            @data[:users][id] = {
+              'id'       => id,
+              'name'     => options[:openstack_username],
+              'email'    => "#{options[:openstack_username]}@mock.com",
+              'tenantId' => Fog::Mock.random_numbers(6).to_s,
+              'enabled'  => true
+            }
+          end
+        end
+
+        def data
+          self.class.data[@openstack_username]
+        end
+
+        def reset_data
+          self.class.data.delete(@openstack_username)
+        end
+
+        def credentials
+          { :provider                 => 'openstack',
+            :openstack_auth_url       => @openstack_auth_uri.to_s,
+            :openstack_auth_token     => @auth_token,
+            :openstack_management_url => @openstack_management_url }
+        end
+      end
+
+      class Real
+        attr_reader :current_user
+        attr_reader :current_tenant
+
+        def initialize(options={})
+          require 'multi_json'
+
+          @openstack_auth_token = options[:openstack_auth_token]
+
+          unless @openstack_auth_token
+            missing_credentials = Array.new
+            @openstack_api_key  = options[:openstack_api_key]
+            @openstack_username = options[:openstack_username]
+
+            missing_credentials << :openstack_api_key  unless @openstack_api_key
+            missing_credentials << :openstack_username unless @openstack_username
+            raise ArgumentError, "Missing required arguments: #{missing_credentials.join(', ')}" unless missing_credentials.empty?
+          end
+
+          @openstack_tenant               = options[:openstack_tenant]
+          @openstack_auth_uri             = URI.parse(options[:openstack_auth_url])
+          @openstack_management_url       = options[:openstack_management_url]
+          @openstack_must_reauthenticate  = false
+          @openstack_service_type         = options[:openstack_service_type] || ['metering']
+          @openstack_service_name         = options[:openstack_service_name]
+
+          @openstack_endpoint_type        = options[:openstack_endpoint_type] || 'adminURL'
+          @connection_options = options[:connection_options] || {}
+
+          @current_user = options[:current_user]
+          @current_tenant = options[:current_tenant]
+
+          authenticate
+
+          @persistent = options[:persistent] || false
+          @connection = Fog::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+        end
+
+        def credentials
+          { :provider                 => 'openstack',
+            :openstack_auth_url       => @openstack_auth_uri.to_s,
+            :openstack_auth_token     => @auth_token,
+            :openstack_management_url => @openstack_management_url,
+            :current_user             => @current_user,
+            :current_tenant           => @current_tenant }
+        end
+
+        def reload
+          @connection.reset
+        end
+
+        def request(params)
+          begin
+            response = @connection.request(params.merge({
+              :headers  => {
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json',
+                'X-Auth-Token' => @auth_token
+              }.merge!(params[:headers] || {}),
+              :host     => @host,
+              :path     => "#{@path}/v2/#{params[:path]}"#,
+              # Causes errors for some requests like tenants?limit=1
+              # :query    => ('ignore_awful_caching' << Time.now.to_i.to_s)
+            }))
+          rescue Excon::Errors::Unauthorized => error
+            if error.response.body != 'Bad username or password' # token expiration
+              @openstack_must_reauthenticate = true
+              authenticate
+              retry
+            else # bad credentials
+              raise error
+            end
+          rescue Excon::Errors::HTTPStatusError => error
+            raise case error
+            when Excon::Errors::NotFound
+              Fog::Compute::OpenStack::NotFound.slurp(error)
+            else
+              error
+            end
+          end
+          unless response.body.empty?
+            response.body = MultiJson.decode(response.body)
+          end
+          response
+        end
+
+        private
+
+        def authenticate
+          if !@openstack_management_url || @openstack_must_reauthenticate
+            options = {
+              :openstack_tenant   => @openstack_tenant,
+              :openstack_api_key  => @openstack_api_key,
+              :openstack_username => @openstack_username,
+              :openstack_auth_uri => @openstack_auth_uri,
+              :openstack_auth_token => @openstack_auth_token,
+              :openstack_service_type => @openstack_service_type,
+              :openstack_service_name => @openstack_service_name,
+              :openstack_endpoint_type => @openstack_endpoint_type
+            }
+
+            credentials = Fog::OpenStack.authenticate_v2(options, @connection_options)
+
+            @current_user = credentials[:user]
+            @current_tenant = credentials[:tenant]
+
+            @openstack_must_reauthenticate = false
+            @auth_token = credentials[:token]
+            @openstack_management_url = credentials[:server_management_url]
+            uri = URI.parse(@openstack_management_url)
+          else
+            @auth_token = @openstack_auth_token
+            uri = URI.parse(@openstack_management_url)
+          end
+
+          @host   = uri.host
+          @path   = uri.path
+          @path.sub!(/\/$/, '')
+          @port   = uri.port
+          @scheme = uri.scheme
+          true
+        end
+
+      end
+    end
+  end
+end
+