fog-openstack 0.1.0

data/lib/fog/openstack/errors.rb

@@ -0,0 +1,42 @@
+module Fog
+  module OpenStack
+    module Errors
+      class ServiceError < Fog::Errors::Error
+        attr_reader :response_data
+
+        def self.slurp(error)
+          if error.response.body.empty?
+            data = nil
+            message = nil
+          else
+            data = Fog::JSON.decode(error.response.body)
+            message = data['message']
+            if message.nil? and !data.values.first.nil?
+              message = data.values.first['message']
+            end
+          end
+
+          new_error = super(error, message)
+          new_error.instance_variable_set(:@response_data, data)
+          new_error
+        end
+      end
+
+      class ServiceUnavailable < ServiceError; end
+
+      class BadRequest < ServiceError
+        attr_reader :validation_errors
+
+        def self.slurp(error)
+          new_error = super(error)
+          unless new_error.response_data.nil? or new_error.response_data['badRequest'].nil?
+            new_error.instance_variable_set(:@validation_errors, new_error.response_data['badRequest']['validationErrors'])
+          end
+          new_error
+        end
+      end
+
+      class InterfaceNotImplemented < Fog::Errors::Error; end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# OpenStack Compute (Nova) Example
+
+require 'fog'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+tenant   = 'My Compute Tenant' # String
+
+compute_client ||= ::Fog::Compute.new(:provider           => :openstack,
+                                      :openstack_api_key  => password  ,
+                                      :openstack_username => username  ,
+                                      :openstack_auth_url => auth_url  ,
+                                      :openstack_tenant   => tenant)
+
+# Create VM
+# Options include metadata, availability zone, etc...
+
+begin
+  vm = compute_client.servers.create(:name => 'lucky',
+                                     :image_ref => 'fcd8f8a9',
+                                     :flavor_ref => 4)
+rescue => e
+  puts JSON.parse(e.response.body)['badRequest']['message']
+end
+
+# Destroy VM
+
+vm = compute_client.servers.get(vm.id) # Retrieve previously created vm by UUID
+floating_ips = vm.all_addresses # fetch and release its floating IPs
+floating_ips.each do |address|
+  compute_client.disassociate_address(uuid, address['ip'])
+  compute_client.release_address(address['id'])
+end
+vm.destroy
+
+# Images available at tenant
+image_names = compute_client.images.map { |image| image['name'] }
+
+# Floating IP address pools available at tenant
+compute_client.addresses.get_address_pools
+# response.body #=> { 'name' => 'pool1' }, { 'name' => 'pool2' }
+
+# VNC console
+vm.console.body # returns VNC url
+
+# "console" => {
+#                "url"  => "http://vmvncserver:6080/vnc_auto.html?token=231",
+#                "type" => "novnc"
+#              }

data/lib/fog/openstack/examples/compute/block_device_mapping_v2.rb

@@ -0,0 +1,32 @@
+# OpenStack Compute (Nova) Example
+
+require 'fog'
+require 'fog/openstack'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+tenant   = 'My Compute Tenant' # String
+
+compute_client ||= ::Fog::Compute.new(
+  :provider           => :openstack,
+  :openstack_api_key  => password,
+  :openstack_username => username,
+  :openstack_auth_url => auth_url,
+  :openstack_tenant   => tenant,
+)
+
+vm = compute_client.servers.create(
+  :name                    => name,
+  :flavor_ref              => flavor,
+  :block_device_mapping_v2 => [
+    {
+      :boot_index            => 0
+      :device_name           => "vda",
+      :source_type           => "volume",  # Or "snapshot"
+      :destination_type      => "volume",
+      :delete_on_termination => false,
+      :uuid                  => cinder_uddi,
+    }
+  ]
+)

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

@@ -0,0 +1,68 @@
+# 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,62 @@
+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/planning/basics.rb

@@ -0,0 +1,53 @@
+# OpenStack Planning Service (Tuskar) Example
+
+require 'fog'
+require 'pp'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+tenant   = 'My Compute Tenant' # String
+
+planning ||= ::Fog::Openstack.new(
+  :service            => :planning,
+  :openstack_api_key  => password,
+  :openstack_username => username,
+  :openstack_auth_url => auth_url,
+  :openstack_tenant   => tenant
+)
+
+pp planning
+
+#
+# Listing of Tuskar roles
+#
+roles = planning.roles.each do |role|
+  pp role
+end
+
+#
+# Listing of Tuskar plans
+#
+plans = planning.plans.each do |plan|
+  pp plan
+end
+
+#
+# Creating new Tuskar plan
+#
+plan = planning.plans.new({
+  :name        => 'New Plan Name',
+  :description => 'New Plan Description'
+})
+pp plan
+
+#
+# Assign role to plan
+#
+role_uuid = roles.first.uuid
+plan.add_role(role_uuid)
+
+#
+# Output Heat templates for plan
+#
+pp plan.templates

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