Class: OpenStack::Volume::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/openstack/volume/connection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Connection

Returns a new instance of Connection.



9
10
11
12
13
14
 
# File 'lib/openstack/volume/connection.rb', line 9

def initialize(connection)
  @connection = connection
  OpenStack::Authentication.init(@connection)
  @volumes_native, @volume_path = check_if_native("volumes")
  @snapshots_native, @snapshot_path = check_if_native("snapshots")
end

Instance Attribute Details

#connection ⇒ Object

Returns the value of attribute connection.



6
7
8
 
# File 'lib/openstack/volume/connection.rb', line 6

def connection
  @connection
end

#volumes_native ⇒ Object (readonly)

Returns the value of attribute volumes_native.



7
8
9
 
# File 'lib/openstack/volume/connection.rb', line 7

def volumes_native
  @volumes_native
end

Instance Method Details

#authok? ⇒ Boolean

Returns true if the authentication was successful and returns false otherwise.

cs.authok?
=> true

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/openstack/volume/connection.rb', line 20

def authok?
  @connection.authok
end

#create_snapshot(options) ⇒ Object

require params: :volume_id optional params: :metadata=>{:key=>val, …, :availability_zone, :volume_type } returns OpenStack::Volume::Snapshot object

Raises:



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openstack/volume/connection.rb', line 75

def create_snapshot(options)
  raise OpenStack::Exception::MissingArgument, ":volume_id and :display_name must be specified to create a snapshot" unless (options[:display_name] && options[:volume_id])
  #:force documented in API but not explained... clarify (fails without)
  options.merge!({:force=>"true"})
  data = JSON.generate(:snapshot => options)
  response = @connection.csreq("POST",@connection.service_host,"#{@connection.service_path}/#{@snapshot_path}",@connection.service_port,@connection.service_scheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  snapshot_info = JSON.parse(response.body)["snapshot"]
  OpenStack::Volume::Snapshot.new(snapshot_info)
end

#create_volume(options) ⇒ Object

require params: :size optional params: :metadata=>{:key=>val, …, :availability_zone, :volume_type } returns OpenStack::Volume::Volume object

Raises:



27
28
29
30
31
32
33
34
 
# File 'lib/openstack/volume/connection.rb', line 27

def create_volume(options)
  raise OpenStack::Exception::MissingArgument, ":display_name and :size must be specified to create a volume" unless (options[:display_name] && options[:size])
  data = JSON.generate(:volume => options)
  response = @connection.csreq("POST",@connection.service_host,"#{@connection.service_path}/#{@volume_path}",@connection.service_port,@connection.service_scheme,{'content-type' => 'application/json'},data)
  OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
  volume_info = JSON.parse(response.body)["volume"]
  volume = OpenStack::Volume::Volume.new(volume_info)
end

#delete_snapshot(snap_id) ⇒ Object 



86
87
88
89
 
# File 'lib/openstack/volume/connection.rb', line 86

def delete_snapshot(snap_id)
  @connection.req("DELETE", "/#{@snapshot_path}/#{snap_id}")
  true
end

#delete_volume(vol_id) ⇒ Object 



53
54
55
56
 
# File 'lib/openstack/volume/connection.rb', line 53

def delete_volume(vol_id)
  response = @connection.req("DELETE", "/#{@volume_path}/#{vol_id}")
  true
end

#get_snapshot(snap_id) ⇒ Object Also known as: snapshot 



65
66
67
68
69
 
# File 'lib/openstack/volume/connection.rb', line 65

def get_snapshot(snap_id)
  response = @connection.req("GET", "/#{@snapshot_path}/#{snap_id}")
  snapshot_hash = JSON.parse(response.body)["snapshot"]
  OpenStack::Volume::Snapshot.new(snapshot_hash)
end

#get_volume(vol_id) ⇒ Object Also known as: volume 



46
47
48
49
50
 
# File 'lib/openstack/volume/connection.rb', line 46

def get_volume(vol_id)
  response = @connection.req("GET", "/#{@volume_path}/#{vol_id}")
  volume_hash = JSON.parse(response.body)["volume"]
  OpenStack::Volume::Volume.new(volume_hash)
end

#list_snapshots ⇒ Object Also known as: snapshots 



58
59
60
61
62
 
# File 'lib/openstack/volume/connection.rb', line 58

def list_snapshots
  response = @connection.req("GET", "/#{@snapshot_path}")
  snapshot_hash = JSON.parse(response.body)["snapshots"]
  snapshot_hash.inject([]){|res, current| res << OpenStack::Volume::Snapshot.new(current); res}
end

#list_volumes ⇒ Object Also known as: volumes

no options documented in API at Nov 2012 (e.g. like limit/marker as used in Nova for servers)



38
39
40
41
42
 
# File 'lib/openstack/volume/connection.rb', line 38

def list_volumes
  response = @connection.req("GET", "/#{@volume_path}")
  volumes_hash = JSON.parse(response.body)["volumes"]
  volumes_hash.inject([]){|res, current| res << OpenStack::Volume::Volume.new(current); res}
end