Class: VagrantPlugins::Openstack::NovaClient
- Inherits:
-
Object
- Object
- VagrantPlugins::Openstack::NovaClient
show all
- Includes:
- Singleton, Domain, HttpUtils
- Defined in:
- lib/vagrant-openstack-provider/client/nova.rb
Instance Method Summary
collapse
-
#add_floating_ip(env, server_id, floating_ip) ⇒ Object
-
#allocate_floating_ip(env, pool) ⇒ Object
-
#attach_volume(env, server_id, volume_id, device = nil) ⇒ Object
-
#create_server(env, options) ⇒ Object
-
#create_snapshot(env, server_id, snapshot_name) ⇒ void
Create a named snapsot for a given VM.
-
#delete_keypair_if_vagrant(env, server_id) ⇒ Object
-
#delete_server(env, server_id) ⇒ Object
-
#delete_snapshot(env, snapshot_id) ⇒ void
Delete an identified snapshot.
-
#get_all_flavors(env) ⇒ Object
-
#get_all_floating_ips(env) ⇒ Object
-
#get_all_images(env, headers = {}) ⇒ Object
-
#get_floating_ip_pools(env) ⇒ Object
-
#get_floating_ips(env) ⇒ Object
-
#get_image_details(env, image_id) ⇒ Hash
Get detailed information about an image.
-
#get_server_details(env, server_id) ⇒ Object
-
#import_keypair(env, public_key) ⇒ Object
-
#import_keypair_from_file(env, public_key_path) ⇒ Object
-
#initialize ⇒ NovaClient
constructor
A new instance of NovaClient.
-
#list_snapshots(env, server_id) ⇒ Array<VagrantPlugins::Openstack::Domain::Image>
List snapshot images associated with a particular server.
-
#restore_snapshot(env, server_id, snapshot_id) ⇒ void
Restore a VM to an identified snapshot.
-
#resume_server(env, server_id) ⇒ Object
-
#start_server(env, server_id) ⇒ Object
-
#stop_server(env, server_id) ⇒ Object
-
#suspend_server(env, server_id) ⇒ Object
Methods included from HttpUtils
#delete, #get, #get_api_version_list, #post
#log_request, #log_response
Constructor Details
Returns a new instance of NovaClient.
14
15
16
17
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 14
def initialize
@logger = Log4r::Logger.new('vagrant_openstack::nova')
@session = VagrantPlugins::Openstack.session
end
|
Instance Method Details
#add_floating_ip(env, server_id, floating_ip) ⇒ Object
139
140
141
142
143
144
145
146
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 139
def add_floating_ip(env, server_id, floating_ip)
instance_exists do
check_floating_ip(env, floating_ip)
post(env, "#{@session.endpoints[:compute]}/servers/#{server_id}/action",
{ addFloatingIp: { address: floating_ip } }.to_json)
end
end
|
#allocate_floating_ip(env, pool) ⇒ Object
33
34
35
36
37
38
39
40
41
42
43
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 33
def allocate_floating_ip(env, pool)
ips_json = post(env, "#{@session.endpoints[:compute]}/os-floating-ips",
{
pool: pool
}.to_json,
'X-Auth-Token' => @session.token,
:accept => :json,
:content_type => :json)
floating_ip = JSON.parse(ips_json)['floating_ip']
FloatingIP.new(floating_ip['ip'], floating_ip['pool'], floating_ip['instance_id'])
end
|
#attach_volume(env, server_id, volume_id, device = nil) ⇒ Object
186
187
188
189
190
191
192
193
194
195
196
197
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 186
def attach_volume(env, server_id, volume_id, device = nil)
instance_exists do
attachment = post(env, "#{@session.endpoints[:compute]}/servers/#{server_id}/os-volume_attachments",
{
volumeAttachment: {
volumeId: volume_id,
device: device
}
}.to_json)
JSON.parse(attachment)['volumeAttachment']
end
end
|
#create_server(env, options) ⇒ Object
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 71
def create_server(env, options)
server = {}.tap do |s|
s['name'] = options[:name]
if options[:image_ref].nil?
s['block_device_mapping'] = [{ volume_id: options[:volume_boot][:id],
device_name: options[:volume_boot][:device] }] if options[:volume_boot].key?(:id)
s['block_device_mapping_v2'] = [{ boot_index: '0',
volume_size: options[:volume_boot][:size],
uuid: options[:volume_boot][:image],
device_name: options[:volume_boot][:device],
source_type: 'image',
destination_type: 'volume',
delete_on_termination: options[:volume_boot][:delete_on_destroy] }]\
if options[:volume_boot].key?(:image)
else
s['imageRef'] = options[:image_ref]
end
s['flavorRef'] = options[:flavor_ref]
s['key_name'] = options[:keypair]
s['availability_zone'] = options[:availability_zone] unless options[:availability_zone].nil?
s['security_groups'] = options[:security_groups] unless options[:security_groups].nil?
s['user_data'] = Base64.encode64(options[:user_data]) unless options[:user_data].nil?
s['metadata'] = options[:metadata] unless options[:metadata].nil?
s['networks'] = options[:networks] unless options[:networks].nil? || options[:networks].empty?
end
object = { server: server }
object['os:scheduler_hints'] = options[:scheduler_hints] unless options[:scheduler_hints].nil?
server = post(env, "#{@session.endpoints[:compute]}/servers", object.to_json)
JSON.parse(server)['server']['id']
end
|
#create_snapshot(env, server_id, snapshot_name) ⇒ void
This method returns an undefined value.
Create a named snapsot for a given VM
216
217
218
219
220
221
222
223
224
225
226
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 216
def create_snapshot(env, server_id, snapshot_name)
instance_exists do
post(
env,
"#{@session.endpoints[:compute]}/servers/#{server_id}/action",
{ createImage: {
name: snapshot_name,
metadata: { vagrant_snapshot: 'true' }
} }.to_json)
end
end
|
#delete_keypair_if_vagrant(env, server_id) ⇒ Object
167
168
169
170
171
172
173
174
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 167
def delete_keypair_if_vagrant(env, server_id)
instance_exists do
keyname = get_server_details(env, server_id)['key_name']
if keyname
delete(env, "#{@session.endpoints[:compute]}/os-keypairs/#{keyname}") if keyname.start_with?('vagrant-generated-')
end
end
end
|
#delete_server(env, server_id) ⇒ Object
102
103
104
105
106
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 102
def delete_server(env, server_id)
instance_exists do
delete(env, "#{@session.endpoints[:compute]}/servers/#{server_id}")
end
end
|
#delete_snapshot(env, snapshot_id) ⇒ void
This method returns an undefined value.
Delete an identified snapshot
234
235
236
237
238
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 234
def delete_snapshot(env, snapshot_id)
delete(
env,
"#{@session.endpoints[:compute]}/images/#{snapshot_id}")
end
|
#get_all_flavors(env) ⇒ Object
19
20
21
22
23
24
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 19
def get_all_flavors(env)
flavors_json = get(env, "#{@session.endpoints[:compute]}/flavors/detail")
JSON.parse(flavors_json)['flavors'].map do |fl|
Flavor.new(fl['id'], fl['name'], fl['vcpus'], fl['ram'], fl['disk'])
end
end
|
#get_all_floating_ips(env) ⇒ Object
26
27
28
29
30
31
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 26
def get_all_floating_ips(env)
ips_json = get(env, "#{@session.endpoints[:compute]}/os-floating-ips",
'X-Auth-Token' => @session.token,
:accept => :json)
JSON.parse(ips_json)['floating_ips'].map { |n| FloatingIP.new(n['ip'], n['pool'], n['instance_id']) }
end
|
#get_all_images(env, headers = {}) ⇒ Object
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 45
def get_all_images(env, = {})
images_json = get(env, "#{@session.endpoints[:compute]}/images/detail", )
JSON.parse(images_json)['images'].map do |fl|
Image.new(
fl['id'],
fl['name'],
'unknown',
nil,
fl['minRam'],
fl['minDisk'],
fl['metadata']
)
end
end
|
#get_floating_ip_pools(env) ⇒ Object
176
177
178
179
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 176
def get_floating_ip_pools(env)
floating_ips = get(env, "#{@session.endpoints[:compute]}/os-floating-ip-pools")
JSON.parse(floating_ips)['floating_ip_pools']
end
|
#get_floating_ips(env) ⇒ Object
181
182
183
184
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 181
def get_floating_ips(env)
floating_ips = get(env, "#{@session.endpoints[:compute]}/os-floating-ips")
JSON.parse(floating_ips)['floating_ips']
end
|
#get_image_details(env, image_id) ⇒ Hash
Get detailed information about an image
66
67
68
69
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 66
def get_image_details(env, image_id)
image_json = get(env, "#{@session.endpoints[:compute]}/images/#{image_id}")
JSON.parse(image_json)['image']
end
|
#get_server_details(env, server_id) ⇒ Object
132
133
134
135
136
137
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 132
def get_server_details(env, server_id)
instance_exists do
server_details = get(env, "#{@session.endpoints[:compute]}/servers/#{server_id}")
JSON.parse(server_details)['server']
end
end
|
#import_keypair(env, public_key) ⇒ Object
148
149
150
151
152
153
154
155
156
157
158
159
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 148
def import_keypair(env, public_key)
keyname = "vagrant-generated-#{Kernel.rand(36**8).to_s(36)}"
key_details = post(env, "#{@session.endpoints[:compute]}/os-keypairs",
{ keypair:
{
name: keyname,
public_key: public_key
}
}.to_json)
JSON.parse(key_details)['keypair']['name']
end
|
#import_keypair_from_file(env, public_key_path) ⇒ Object
161
162
163
164
165
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 161
def import_keypair_from_file(env, public_key_path)
fail "File specified in public_key_path #{public_key_path} doesn't exist" unless File.exist?(public_key_path)
file = File.open(public_key_path)
import_keypair(env, file.read)
end
|
List snapshot images associated with a particular server
205
206
207
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 205
def list_snapshots(env, server_id)
get_all_images(env, params: { server: server_id })
end
|
#restore_snapshot(env, server_id, snapshot_id) ⇒ void
This method returns an undefined value.
Restore a VM to an identified snapshot
247
248
249
250
251
252
253
254
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 247
def restore_snapshot(env, server_id, snapshot_id)
instance_exists do
post(
env,
"#{@session.endpoints[:compute]}/servers/#{server_id}/action",
{ rebuild: { imageRef: snapshot_id } }.to_json)
end
end
|
#resume_server(env, server_id) ⇒ Object
114
115
116
117
118
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 114
def resume_server(env, server_id)
instance_exists do
change_server_state(env, server_id, :resume)
end
end
|
#start_server(env, server_id) ⇒ Object
126
127
128
129
130
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 126
def start_server(env, server_id)
instance_exists do
change_server_state(env, server_id, :start)
end
end
|
#stop_server(env, server_id) ⇒ Object
120
121
122
123
124
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 120
def stop_server(env, server_id)
instance_exists do
change_server_state(env, server_id, :stop)
end
end
|
#suspend_server(env, server_id) ⇒ Object
108
109
110
111
112
|
# File 'lib/vagrant-openstack-provider/client/nova.rb', line 108
def suspend_server(env, server_id)
instance_exists do
change_server_state(env, server_id, :suspend)
end
end
|