Parent

Class/Module Index [+]

Quicksearch

Fog::Volume::OpenStack::Real

Attributes

current_tenant[R]
current_user[R]

Public Class Methods

new(options={}) click to toggle source
# File lib/fog/openstack/volume.rb, line 104
def initialize(options={})
  @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] || ['volume']
  @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

Public Instance Methods

create_volume(name, description, size, options={}) click to toggle source
# File lib/fog/openstack/requests/volume/create_volume.rb, line 6
def create_volume(name, description, size, options={})
  data = {
    'volume' => {
      'display_name'        => name,
      'display_description' => description,
      'size'                => size
    }
  }

  vanilla_options = ['snapshot_id']
  vanilla_options.select{|o| options[o]}.each do |key|
    data['volume'][key] = options[key]
  end
  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'POST',
    :path     => "volumes"
  )
end
create_volume_snapshot(volume_id, name, description, force=false) click to toggle source
# File lib/fog/openstack/requests/volume/create_volume_snapshot.rb, line 6
def create_volume_snapshot(volume_id, name, description, force=false)
  data = {
    'snapshot' => {
      'volume_id'           => volume_id,
      'display_name'        => name,
      'display_description' => description,
      'force'               => force
    }
  }

  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'POST',
    :path     => "snapshots"
  )
end
credentials() click to toggle source
# File lib/fog/openstack/volume.rb, line 136
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
delete_snapshot(snapshot_id) click to toggle source
# File lib/fog/openstack/requests/volume/delete_snapshot.rb, line 6
def delete_snapshot(snapshot_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "snapshots/#{snapshot_id}"
  )
end
delete_volume(volume_id) click to toggle source
# File lib/fog/openstack/requests/volume/delete_volume.rb, line 6
def delete_volume(volume_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "volumes/#{volume_id}"
  )
end
get_quota(tenant_id) click to toggle source
# File lib/fog/openstack/requests/volume/get_quota.rb, line 6
def get_quota(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}"
  )
end
get_quota_defaults(tenant_id) click to toggle source
# File lib/fog/openstack/requests/volume/get_quota_defaults.rb, line 6
def get_quota_defaults(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}/defaults"
  )
end
get_snapshot_details(snapshot_id) click to toggle source
# File lib/fog/openstack/requests/volume/get_snapshot_details.rb, line 6
def get_snapshot_details(snapshot_id)

  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "snapshots/#{snapshot_id}"
  )
end
get_volume_details(volume_id) click to toggle source
# File lib/fog/openstack/requests/volume/get_volume_details.rb, line 6
def get_volume_details(volume_id)

  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "volumes/#{volume_id}"
  )
end
list_snapshots(detailed=true) click to toggle source
# File lib/fog/openstack/requests/volume/list_snapshots.rb, line 6
def list_snapshots(detailed=true)

  path = detailed ? 'snapshots/detail' : 'snapshots'
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => path
  )
end
list_volumes(detailed=true) click to toggle source
# File lib/fog/openstack/requests/volume/list_volumes.rb, line 6
def list_volumes(detailed=true)

  path = detailed ? 'volumes/detail' : 'volumes'
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => path
  )
end
reload() click to toggle source
# File lib/fog/openstack/volume.rb, line 145
def reload
  @connection.reset
end
request(params) click to toggle source
# File lib/fog/openstack/volume.rb, line 149
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}/#{params[:path]}"#,
    }))
  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 = Fog::JSON.decode(response.body)
  end
  response
end
set_tenant(tenant) click to toggle source
# File lib/fog/openstack/requests/volume/set_tenant.rb, line 6
def set_tenant(tenant)
  @openstack_must_reauthenticate = true
  @openstack_tenant = tenant.to_s
  authenticate
end
update_quota(tenant_id, options = {}) click to toggle source
# File lib/fog/openstack/requests/volume/update_quota.rb, line 6
def update_quota(tenant_id, options = {})
  options['tenant_id'] = tenant_id
  request(
    :body => Fog::JSON.encode({ 'quota_set' => options }),
    :expects => 200,
    :method => 'PUT',
    :path => "/os-quota-sets/#{tenant_id}"
  )
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.