Class: Fog::Compute::OpenStack::Server

Inherits:
Server
  • Object
show all
Defined in:
lib/fog/openstack/models/compute/server.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Server

Returns a new instance of Server.



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/fog/openstack/models/compute/server.rb', line 55

def initialize(attributes={})
  # Old 'connection' is renamed as service and should be used instead
  prepare_service_value(attributes)

  self.security_groups = attributes.delete(:security_groups)
  self.min_count = attributes.delete(:min_count)
  self.max_count = attributes.delete(:max_count)
  self.nics = attributes.delete(:nics)
  self.os_scheduler_hints = attributes.delete(:os_scheduler_hints)
  self.block_device_mapping = attributes.delete(:block_device_mapping)

  super
end

Instance Attribute Details

#block_device_mapping ⇒ Object

Returns the value of attribute block_device_mapping.



53
54
55
 
# File 'lib/fog/openstack/models/compute/server.rb', line 53

def block_device_mapping
  @block_device_mapping
end

#flavor_ref ⇒ Object 



161
162
163
 
# File 'lib/fog/openstack/models/compute/server.rb', line 161

def flavor_ref
  @flavor_ref
end

#image_ref ⇒ Object 



153
154
155
 
# File 'lib/fog/openstack/models/compute/server.rb', line 153

def image_ref
  @image_ref
end

#nics=(value) ⇒ Object (writeonly)

Sets the attribute nics

Parameters:

  • value —

    the value to set the attribute nics to.



52
53
54
 
# File 'lib/fog/openstack/models/compute/server.rb', line 52

def nics=(value)
  @nics = value
end

#os_scheduler_hints=(value) ⇒ Object (writeonly)

Sets the attribute os_scheduler_hints

Parameters:

  • value —

    the value to set the attribute os_scheduler_hints to.



52
53
54
 
# File 'lib/fog/openstack/models/compute/server.rb', line 52

def os_scheduler_hints=(value)
  @os_scheduler_hints = value
end

#password ⇒ Object (readonly)

Returns the value of attribute password.



51
52
53
 
# File 'lib/fog/openstack/models/compute/server.rb', line 51

def password
  @password
end

#personality ⇒ Hash

Note:

This attribute is only used for server creation. This field will be nil on subsequent retrievals.

Returns Hash containing data to inject into the file system of the cloud server instance during server creation.

Examples:

To inject fog.txt into file system

:personality => [{ :path => '/root/fog.txt',
                   :contents => Base64.encode64('Fog was here!')
                }]

Returns:

  • (Hash) —

    Hash containing data to inject into the file system of the cloud server instance during server creation.

See Also:



28
 
# File 'lib/fog/openstack/models/compute/server.rb', line 28

attribute :personality

Instance Method Details

#all_addresses ⇒ Object 



100
101
102
103
104
105
 
# File 'lib/fog/openstack/models/compute/server.rb', line 100

def all_addresses
  # currently openstack API does not tell us what is a floating ip vs a fixed ip for the vm listing,
  # we fall back to get all addresses and filter sadly.
  # Only includes manually-assigned addresses, not auto-assigned
  @all_addresses ||= service.list_all_addresses.body["floating_ips"].select{|data| data['instance_id'] == id}
end

#associate_address(floating_ip) ⇒ Object 



275
276
277
278
 
# File 'lib/fog/openstack/models/compute/server.rb', line 275

def associate_address(floating_ip)
  requires :id
  service.associate_address id, floating_ip
end

#attach_volume(volume_id, device_name) ⇒ Object 



314
315
316
317
318
 
# File 'lib/fog/openstack/models/compute/server.rb', line 314

def attach_volume(volume_id, device_name)
  requires :id
  service.attach_volume(volume_id, id, device_name)
  true
end

#change_password(admin_password) ⇒ Object 



177
178
179
180
181
 
# File 'lib/fog/openstack/models/compute/server.rb', line 177

def change_password(admin_password)
  requires :id
  service.change_server_password(id, admin_password)
  true
end

#confirm_resize ⇒ Object 



201
202
203
204
205
 
# File 'lib/fog/openstack/models/compute/server.rb', line 201

def confirm_resize
  requires :id
  service.confirm_resize_server(id)
  true
end

#console(log_length = nil) ⇒ Object 



260
261
262
263
 
# File 'lib/fog/openstack/models/compute/server.rb', line 260

def console(log_length = nil)
  requires :id
  service.get_console_output(id, log_length)
end

#create_image(name, metadata = {}) ⇒ Object 



255
256
257
258
 
# File 'lib/fog/openstack/models/compute/server.rb', line 255

def create_image(name, metadata={})
  requires :id
  service.create_image(id, name, metadata)
end

#destroy ⇒ Object 



89
90
91
92
93
 
# File 'lib/fog/openstack/models/compute/server.rb', line 89

def destroy
  requires :id
  service.delete_server(id)
  true
end

#detach_volume(volume_id) ⇒ Object 



320
321
322
323
324
 
# File 'lib/fog/openstack/models/compute/server.rb', line 320

def detach_volume(volume_id)
  requires :id
  service.detach_volume(id, volume_id)
  true
end

#disassociate_address(floating_ip) ⇒ Object 



280
281
282
283
 
# File 'lib/fog/openstack/models/compute/server.rb', line 280

def disassociate_address(floating_ip)
  requires :id
  service.disassociate_address id, floating_ip
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/fog/openstack/models/compute/server.rb', line 173

def failed?
  self.state == 'ERROR'
end

#floating_ip_address ⇒ Object Also known as: public_ip_address 



139
140
141
 
# File 'lib/fog/openstack/models/compute/server.rb', line 139

def floating_ip_address
  floating_ip_addresses.first
end

#floating_ip_addresses ⇒ Object Also known as: public_ip_addresses 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/fog/openstack/models/compute/server.rb', line 118

def floating_ip_addresses
  all_floating=addresses.values.flatten.select{ |data| data["OS-EXT-IPS:type"]=="floating" }.map{|addr| addr["addr"] }

  # Return them all, leading with manually assigned addresses
  manual = all_addresses.map{|addr| addr["ip"]}

  all_floating.sort{ |a,b|
    a_manual = manual.include? a
    b_manual = manual.include? b

    if a_manual and !b_manual
      -1
    elsif !a_manual and b_manual
      1
    else 0 end
  }
  all_floating.empty? ? manual : all_floating
end

#images ⇒ Object 



95
96
97
98
 
# File 'lib/fog/openstack/models/compute/server.rb', line 95

def images
  requires :id
  service.images(:server => self)
end

#ip_addresses ⇒ Object

returns all ip_addresses for a given instance this includes both the fixed ip(s) and the floating ip(s)



114
115
116
 
# File 'lib/fog/openstack/models/compute/server.rb', line 114

def ip_addresses
  addresses.values.flatten.map{|x| x['addr']}
end

#live_migrate(host, block_migration, disk_over_commit) ⇒ Object 



270
271
272
273
 
# File 'lib/fog/openstack/models/compute/server.rb', line 270

def live_migrate(host, block_migration, disk_over_commit)
  requires :id
  service.live_migrate_server(id, host, block_migration, disk_over_commit)
end

#max_count=(new_max_count) ⇒ Object 



294
295
296
 
# File 'lib/fog/openstack/models/compute/server.rb', line 294

def max_count=(new_max_count)
  @max_count = new_max_count
end

#metadata ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/fog/openstack/models/compute/server.rb', line 69

def metadata
  @metadata ||= begin
    Fog::Compute::OpenStack::Metadata.new({
      :service => service,
      :parent => self
    })
  end
end

#metadata=(new_metadata = {}) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/fog/openstack/models/compute/server.rb', line 78

def metadata=(new_metadata={})
  return unless new_metadata
  metas = []
  new_metadata.each_pair {|k,v| metas << {"key" => k, "value" => v} }
  @metadata = metadata.load(metas)
end

#migrate ⇒ Object 



265
266
267
268
 
# File 'lib/fog/openstack/models/compute/server.rb', line 265

def migrate
  requires :id
  service.migrate_server(id)
end

#min_count=(new_min_count) ⇒ Object 



290
291
292
 
# File 'lib/fog/openstack/models/compute/server.rb', line 290

def min_count=(new_min_count)
  @min_count = new_min_count
end

#networks ⇒ Object 



298
299
300
 
# File 'lib/fog/openstack/models/compute/server.rb', line 298

def networks
  service.networks(:server => self)
end

#pause ⇒ Object 



232
233
234
235
 
# File 'lib/fog/openstack/models/compute/server.rb', line 232

def pause
  requires :id
  service.pause_server(id)
end

#private_ip_address ⇒ Object 



149
150
151
 
# File 'lib/fog/openstack/models/compute/server.rb', line 149

def private_ip_address
  private_ip_addresses.first
end

#private_ip_addresses ⇒ Object 



145
146
147
 
# File 'lib/fog/openstack/models/compute/server.rb', line 145

def private_ip_addresses
  ip_addresses - floating_ip_addresses
end

#ready? ⇒ Boolean

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/fog/openstack/models/compute/server.rb', line 169

def ready?
  self.state == 'ACTIVE'
end

#reboot(type = 'SOFT') ⇒ Object 



221
222
223
224
225
 
# File 'lib/fog/openstack/models/compute/server.rb', line 221

def reboot(type = 'SOFT')
  requires :id
  service.reboot_server(id, type)
  true
end

#rebuild(image_ref, name, admin_pass = nil, metadata = nil, personality = nil) ⇒ Object 



183
184
185
186
187
 
# File 'lib/fog/openstack/models/compute/server.rb', line 183

def rebuild(image_ref, name, admin_pass=nil, metadata=nil, personality=nil)
  requires :id
  service.rebuild_server(id, image_ref, name, admin_pass, metadata, personality)
  true
end

#reload ⇒ Object 



107
108
109
110
 
# File 'lib/fog/openstack/models/compute/server.rb', line 107

def reload
  @all_addresses = nil
  super
end

#reset_vm_state(vm_state) ⇒ Object 



285
286
287
288
 
# File 'lib/fog/openstack/models/compute/server.rb', line 285

def reset_vm_state(vm_state)
  requires :id
  service.reset_server_state id, vm_state
end

#resize(flavor_ref) ⇒ Object 



189
190
191
192
193
 
# File 'lib/fog/openstack/models/compute/server.rb', line 189

def resize(flavor_ref)
  requires :id
  service.resize_server(id, flavor_ref)
  true
end

#revert_resize ⇒ Object 



195
196
197
198
199
 
# File 'lib/fog/openstack/models/compute/server.rb', line 195

def revert_resize
  requires :id
  service.revert_resize_server(id)
  true
end

#save ⇒ Object

Raises:

  • (Fog::Errors::Error) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/fog/openstack/models/compute/server.rb', line 326

def save
  raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if persisted?
  requires :flavor_ref, :name
  requires_one :image_ref, :block_device_mapping
  options = {
    'personality' => personality,
    'accessIPv4' => accessIPv4,
    'accessIPv6' => accessIPv6,
    'availability_zone' => availability_zone,
    'user_data' => user_data_encoded,
    'key_name'    => key_name,
    'config_drive' => config_drive,
    'security_groups' => @security_groups,
    'min_count'   => @min_count,
    'max_count'   => @max_count,
    'nics' => @nics,
    'os:scheduler_hints' => @os_scheduler_hints,
    'block_device_mapping' => @block_device_mapping
  }
  options['metadata'] = metadata.to_hash unless @metadata.nil?
  options = options.reject {|key, value| value.nil?}
  data = service.create_server(name, image_ref, flavor_ref, options)
  merge_attributes(data.body['server'])
  true
end

#security_groups ⇒ Object 



207
208
209
210
211
212
213
214
215
 
# File 'lib/fog/openstack/models/compute/server.rb', line 207

def security_groups
  requires :id

  groups = service.list_security_groups(id).body['security_groups']

  groups.map do |group|
    Fog::Compute::OpenStack::SecurityGroup.new group.merge({:service => service})
  end
end

#security_groups=(new_security_groups) ⇒ Object 



217
218
219
 
# File 'lib/fog/openstack/models/compute/server.rb', line 217

def security_groups=(new_security_groups)
  @security_groups = new_security_groups
end

#setup(credentials = {}) ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/fog/openstack/models/compute/server.rb', line 352

def setup(credentials = {})
  requires :ssh_ip_address, :identity, :public_key, :username
  Fog::SSH.new(ssh_ip_address, username, credentials).run([
    %{mkdir .ssh},
    %{echo "#{public_key}" >> ~/.ssh/authorized_keys},
    %{passwd -l #{username}},
    %{echo "#{Fog::JSON.encode(attributes)}" >> ~/attributes.json},
    %{echo "#{Fog::JSON.encode(metadata)}" >> ~/metadata.json}
  ])
rescue Errno::ECONNREFUSED
  sleep(1)
  retry
end

#start ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/fog/openstack/models/compute/server.rb', line 242

def start
  requires :id

  case state.downcase
  when 'paused'
    service.unpause_server(id)
  when 'suspended'
    service.resume_server(id)
  else
    service.start_server(id)
  end
end

#stop ⇒ Object 



227
228
229
230
 
# File 'lib/fog/openstack/models/compute/server.rb', line 227

def stop
  requires :id
  service.stop_server(id)
end

#suspend ⇒ Object 



237
238
239
240
 
# File 'lib/fog/openstack/models/compute/server.rb', line 237

def suspend
  requires :id
  service.suspend_server(id)
end

#user_data=(ascii_userdata) ⇒ Object 



85
86
87
 
# File 'lib/fog/openstack/models/compute/server.rb', line 85

def user_data=(ascii_userdata)
  self.user_data_encoded = [ascii_userdata].pack('m')
end

#volume_attachments ⇒ Object 



309
310
311
312
 
# File 'lib/fog/openstack/models/compute/server.rb', line 309

def volume_attachments
  requires :id
  service.get_server_volumes(id).body['volumeAttachments']
end

#volumes ⇒ Object 



302
303
304
305
306
307
 
# File 'lib/fog/openstack/models/compute/server.rb', line 302

def volumes
  requires :id
  service.volumes.select do |vol|
    vol.attachments.find { |attachment| attachment["serverId"] == id }
  end
end