Class: VagrantPlugins::Cloudstack::Action::RunInstance

Inherits:
Object
  • Object
show all
Includes:
Vagrant::Util::Retryable
Defined in:
lib/vagrant-cloudstack/action/run_instance.rb

Overview

This runs the configured instance.

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ RunInstance

Returns a new instance of RunInstance.



12
13
14
15
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 12

def initialize(app, env)
  @app    = app
  @logger = Log4r::Logger.new("vagrant_cloudstack::action::run_instance")
end

Instance Method Details

#call(env) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 17

def call(env)
  # Initialize metrics if they haven't been
  env[:metrics]         ||= {}

  # Get the domain we're going to booting up in
  domain                = env[:machine].provider_config.domain_id

  # Get the configs
  domain_config         = env[:machine].provider_config.get_domain_config(domain)
  hostname              = domain_config.name
  zone_id               = domain_config.zone_id
  zone_name             = domain_config.zone_name
  network_id            = domain_config.network_id
  network_name          = domain_config.network_name
  network_type          = domain_config.network_type
  #TODO: Fog currently does not support the project apis, when that is fixed we should add that here too.
  project_id            = domain_config.project_id
  service_offering_id   = domain_config.service_offering_id
  service_offering_name = domain_config.service_offering_name
  template_id           = domain_config.template_id
  template_name         = domain_config.template_name
  keypair               = domain_config.keypair
  static_nat            = domain_config.static_nat
  pf_ip_address_id      = domain_config.pf_ip_address_id
  pf_ip_address         = domain_config.pf_ip_address
  pf_public_port        = domain_config.pf_public_port
  pf_private_port       = domain_config.pf_private_port
  pf_open_firewall      = domain_config.pf_open_firewall
  port_forwarding_rules = domain_config.port_forwarding_rules
  firewall_rules        = domain_config.firewall_rules
  display_name          = domain_config.display_name
  group                 = domain_config.group
  security_group_ids    = domain_config.security_group_ids
  security_group_names  = domain_config.security_group_names
  security_groups       = domain_config.security_groups
  user_data             = domain_config.user_data
  ssh_key               = domain_config.ssh_key
  ssh_user              = domain_config.ssh_user

  # If for some reason the user have specified both network_name and network_id, take the id since that is
  # more specific than the name. But always try to fetch the name of the network to present to the user.
  if network_id.nil? and network_name
    network_id = name_to_id(env, network_name, "network")
  elsif network_id
    network_name = id_to_name(env, network_id, "network")
  end

  if zone_id.nil? and zone_name
    zone_id = name_to_id(env, zone_name, "zone", {'available' => true})
  elsif zone_id
    zone_name = id_to_name(env, zone_id, "zone", {'available' => true})
  end

  if service_offering_id.nil? and service_offering_name
    service_offering_id = name_to_id(env, service_offering_name, "service_offering")
  elsif service_offering_id
    service_offering_name = id_to_name(env, service_offering_id, "service_offering")
  end

  if template_id.nil? and template_name
    template_id = name_to_id(env, template_name, "template", {'zoneid'         => zone_id,
                                                              'templatefilter' => 'executable'})
  elsif template_id
    template_name = id_to_name(env, template_id, "template", {'zoneid'         => zone_id,
                                                              'templatefilter' => 'executable'})
  end

  # Can't use Security Group IDs and Names at the same time
  # Let's use IDs by default...
  if security_group_ids.empty? and !security_group_names.empty?
    security_group_ids = security_group_names.map { |name| name_to_id(env, name, "security_group") }
  elsif !security_group_ids.empty?
    security_group_names = security_group_ids.map { |id| id_to_name(env, id, "security_group") }
  end

  # Still no security group ids huh?
  # Let's try to create some security groups from specifcation, if provided.
  if !security_groups.empty? and security_group_ids.empty?
    security_groups.each do |security_group|
      sgname, sgid = create_security_group(env, security_group)
      security_group_names.push(sgname)
      security_group_ids.push(sgid)
    end
  end

  # If there is no keypair then warn the user
  if !keypair
    env[:ui].warn(I18n.t("vagrant_cloudstack.launch_no_keypair"))
  end

  if display_name.nil?
    local_user = ENV['USER'].dup
    local_user.gsub!(/[^-a-z0-9_]/i, "")
    prefix = env[:root_path].basename.to_s
    prefix.gsub!(/[^-a-z0-9_]/i, "")
    display_name = local_user + "_" + prefix + "_#{Time.now.to_i}"
  end

  # Launch!
  env[:ui].info(I18n.t("vagrant_cloudstack.launching_instance"))
  env[:ui].info(" -- Display Name: #{display_name}")
  env[:ui].info(" -- Group: #{group}") if group
  env[:ui].info(" -- Service offering: #{service_offering_name} (#{service_offering_id})")
  env[:ui].info(" -- Template: #{template_name} (#{template_id})")
  env[:ui].info(" -- Project UUID: #{project_id}") if project_id != nil
  env[:ui].info(" -- Zone: #{zone_name} (#{zone_id})")
  env[:ui].info(" -- Network: #{network_name} (#{network_id})") if !network_id.nil? or !network_name.nil?
  env[:ui].info(" -- Keypair: #{keypair}") if keypair
  env[:ui].info(" -- User Data: Yes") if user_data
  security_group_names.zip(security_group_ids).each do |security_group_name, security_group_id|
      env[:ui].info(" -- Security Group: #{security_group_name} (#{security_group_id})")
  end

  begin
    options = {
        :display_name => display_name,
        :group        => group,
        :zone_id      => zone_id,
        :flavor_id    => service_offering_id,
        :image_id     => template_id
    }

    if network_type == "Advanced"
      options['network_ids'] = [network_id] if !network_id.nil?
    elsif network_type == "Basic"
      options['security_group_ids'] = security_group_ids
    end
    options['project_id'] = project_id if project_id != nil
    options['key_name']   = keypair if keypair != nil
    options['name']       = hostname if hostname != nil

    if user_data != nil
      options['user_data'] = Base64.urlsafe_encode64(user_data)
      if options['user_data'].length > 2048
        raise Errors::UserdataError,
              :userdataLength => options['user_data'].length
      end
    end

    server = env[:cloudstack_compute].servers.create(options)
  rescue Fog::Compute::Cloudstack::NotFound => e
    # Invalid subnet doesn't have its own error so we catch and
    # check the error message here.
    # XXX FIXME vpc?
    if e.message =~ /subnet ID/
      raise Errors::FogError,
            :message => "Subnet ID not found: #{network_id}"
    end

    raise
  rescue Fog::Compute::Cloudstack::Error => e
    raise Errors::FogError, :message => e.message
  end

  # Immediately save the ID since it is created at this point.
  env[:machine].id                     = server.id

  # Wait for the instance to be ready first
  env[:metrics]["instance_ready_time"] = Util::Timer.time do
    tries = domain_config.instance_ready_timeout / 2

    env[:ui].info(I18n.t("vagrant_cloudstack.waiting_for_ready"))
    begin
      retryable(:on => Fog::Errors::TimeoutError, :tries => tries) do
        # If we're interrupted don't worry about waiting
        next if env[:interrupted]

        # Wait for the server to be ready
        server.wait_for(2) { ready? }
      end
    rescue Fog::Errors::TimeoutError
      # Delete the instance
      terminate(env)

      # Notify the user
      raise Errors::InstanceReadyTimeout,
            timeout: domain_config.instance_ready_timeout
    end
  end

  @logger.info("Time to instance ready: #{env[:metrics]["instance_ready_time"]}")

  if !static_nat.empty?
    static_nat.each do |rule|
      enable_static_nat(env, rule)
    end
  end

  if (pf_ip_address_id or pf_ip_address) and pf_public_port and pf_private_port
    port_forwarding_rule = {
      :ipaddressid  => pf_ip_address_id,
      :ipaddress    => pf_ip_address,
      :protocol     => "tcp",
      :publicport   => pf_public_port,
      :privateport  => pf_private_port,
      :openfirewall => pf_open_firewall
    }
    create_port_forwarding_rule(env, port_forwarding_rule)
  end

  if !port_forwarding_rules.empty?
    port_forwarding_rules.each do |port_forwarding_rule|
      create_port_forwarding_rule(env, port_forwarding_rule)
    end
  end

  if !firewall_rules.empty?
    firewall_rules.each do |firewall_rule|
      create_firewall_rule(env, firewall_rule)
    end
  end

  if !env[:interrupted]
    env[:metrics]["instance_ssh_time"] = Util::Timer.time do
      # Wait for SSH to be ready.
      env[:ui].info(I18n.t("vagrant_cloudstack.waiting_for_ssh"))
      while true
        # If we're interrupted then just back out
        break if env[:interrupted]
        break if env[:machine].communicate.ready?
        sleep 2
      end
    end

    @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")

    # Ready and booted!
    env[:ui].info(I18n.t("vagrant_cloudstack.ready"))
  end

  # Terminate the instance if we were interrupted
  terminate(env) if env[:interrupted]

  @app.call(env)
end

#create_firewall_rule(env, rule) ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 406

def create_firewall_rule(env, rule)
  env[:ui].info(I18n.t("vagrant_cloudstack.creating_firewall_rule"))

  ip_address_id = rule[:ipaddressid]
  ip_address    = rule[:ipaddress]

  if ip_address_id.nil? and ip_address.nil?
    @logger.info("IP address is not specified. Skip creating firewall rule.")
    env[:ui].info(I18n.t("IP address is not specified. Skip creating firewall rule."))
    return
  end

  if ip_address_id.nil? and ip_address
    ip_address_id = ip_to_id(env, ip_address)
  elsif ip_address_id
    ip_address = id_to_ip(env, ip_address_id)
  end

  env[:ui].info(" -- IP address : #{ip_address} (#{ip_address_id})")
  env[:ui].info(" -- Protocol   : #{rule[:protocol]}")
  env[:ui].info(" -- CIDR list  : #{rule[:cidrlist]}")
  env[:ui].info(" -- Start port : #{rule[:startport]}")
  env[:ui].info(" -- End port   : #{rule[:endport]}")
  env[:ui].info(" -- ICMP code  : #{rule[:icmpcode]}")
  env[:ui].info(" -- ICMP type  : #{rule[:icmptype]}")

  options = {
      :command          => "createFirewallRule",
      :ipaddressid      => ip_address_id,
      :protocol         => rule[:protocol],
      :cidrlist         => rule[:cidrlist],
      :startport        => rule[:startport],
      :endeport         => rule[:endport],
      :icmpcode         => rule[:icmpcode],
      :icmptype         => rule[:icmptype]
  }

  begin
    resp = env[:cloudstack_compute].request(options)
    job_id = resp["createfirewallruleresponse"]["jobid"]

    if job_id.nil?
      env[:ui].warn(" -- Failed to create firewall rule: #{resp["createfirewallruleresponse"]["errortext"]}")
      return
    end

    while true
      response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
      if response["queryasyncjobresultresponse"]["jobstatus"] != 0
        firewall_rule = response["queryasyncjobresultresponse"]["jobresult"]["firewallrule"]
        break
      else
        sleep 2
      end
    end
  rescue Fog::Compute::Cloudstack::Error => e
    raise Errors::FogError, :message => e.message
  end

  # Save firewall rule id to the data dir so it can be released when the instance is destroyed
  firewall_file = env[:machine].data_dir.join('firewall')
  firewall_file.open('a+') do |f|
    f.write("#{firewall_rule["id"]}\n")
  end
end

#create_port_forwarding_rule(env, rule) ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 344

def create_port_forwarding_rule(env, rule)
  env[:ui].info(I18n.t("vagrant_cloudstack.creating_port_forwarding_rule"))

  ip_address_id = rule[:ipaddressid]
  ip_address    = rule[:ipaddress]

  if ip_address_id.nil? and ip_address.nil?
    @logger.info("IP address is not specified. Skip creating port forwarding rule.")
    env[:ui].info(I18n.t("IP address is not specified. Skip creating port forwarding rule."))
    return
  end

  if ip_address_id.nil? and ip_address
    ip_address_id = ip_to_id(env, ip_address)
  elsif ip_address_id
    ip_address = id_to_ip(env, ip_address_id)
  end

  env[:ui].info(" -- IP address    : #{ip_address} (#{ip_address_id})")
  env[:ui].info(" -- Protocol      : #{rule[:protocol]}")
  env[:ui].info(" -- Public port   : #{rule[:publicport]}")
  env[:ui].info(" -- Private port  : #{rule[:privateport]}")
  env[:ui].info(" -- Open Firewall : #{rule[:openfirewall]}")

  options = {
      :ipaddressid      => ip_address_id,
      :publicport       => rule[:publicport],
      :privateport      => rule[:privateport],
      :protocol         => rule[:protocol],
      :openfirewall     => rule[:openfirewall],
      :virtualmachineid => env[:machine].id
  }

  begin
    resp = env[:cloudstack_compute].create_port_forwarding_rule(options)
    job_id = resp["createportforwardingruleresponse"]["jobid"]

    if job_id.nil?
      env[:ui].warn(" -- Failed to create port forwarding rule: #{resp["createportforwardingruleresponse"]["errortext"]}")
      return
    end

    while true
      response = env[:cloudstack_compute].query_async_job_result({:jobid => job_id})
      if response["queryasyncjobresultresponse"]["jobstatus"] != 0
        port_forwarding_rule = response["queryasyncjobresultresponse"]["jobresult"]["portforwardingrule"]
        break
      else
        sleep 2
      end
    end
  rescue Fog::Compute::Cloudstack::Error => e
    raise Errors::FogError, :message => e.message
  end

  # Save port forwarding rule id to the data dir so it can be released when the instance is destroyed
  port_forwarding_file = env[:machine].data_dir.join('port_forwarding')
  port_forwarding_file.open('a+') do |f|
    f.write("#{port_forwarding_rule["id"]}\n")
  end
end

#create_security_group(env, security_group) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 253

def create_security_group(env, security_group)
  begin
    sgid = env[:cloudstack_compute].create_security_group(:name        => security_group[:name],
                                                          :description => security_group[:description])["createsecuritygroupresponse"]["securitygroup"]["id"]
    env[:ui].info(" -- Security Group #{security_group[:name]} created with ID: #{sgid}")
  rescue Exception => e
    if e.message =~ /already exis/
      sgid = name_to_id(env, security_group[:name], "security_group")
      env[:ui].info(" -- Security Group #{security_group[:name]} found with ID: #{sgid}")
    end
  end

  # security group is created and we have it's ID
  # so we add the rules... Does it really matter if they already exist ? CLoudstack seems to take care of that!
  security_group[:rules].each do |rule|
    rule_options = {
        :securityGroupId => sgid,
        :protocol        => rule[:protocol],
        :startport       => rule[:startport],
        :endport         => rule[:endport],
        :cidrlist        => rule[:cidrlist]
    }

    # The rule[:type] is either ingress or egress, but the method call looks the same.
    # We build a dynamic method name and then send it off.
    env[:cloudstack_compute].send("authorize_security_group_#{rule[:type]}".to_sym, rule_options)
    env[:ui].info(" --- #{rule[:type].capitalize} Rule added: #{rule[:protocol]} from #{rule[:startport]} to #{rule[:endport]} (#{rule[:cidrlist]})")
  end

  # and record the security group ids for future deletion (of rules and groups if possible)
  security_groups_file = env[:machine].data_dir.join('security_groups')
  security_groups_file.open('a+') do |f|
    f.write("#{sgid}\n")
  end
  [security_group[:name], sgid]
end

#enable_static_nat(env, rule) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 299

def enable_static_nat(env, rule)
  env[:ui].info(I18n.t("vagrant_cloudstack.enabling_static_nat"))

  ip_address_id = rule[:ipaddressid]
  ip_address    = rule[:ipaddress]

  if ip_address_id.nil? and ip_address.nil?
    @logger.info("IP address is not specified. Skip enabling static nat.")
    env[:ui].info(I18n.t("IP address is not specified. Skip enabling static nat."))
    return
  end

  if ip_address_id.nil? and ip_address
    ip_address_id = ip_to_id(env, ip_address)
  elsif ip_address_id
    ip_address = id_to_ip(env, ip_address_id)
  end

  env[:ui].info(" -- IP address : #{ip_address} (#{ip_address_id})")

  options = {
      :command          => "enableStaticNat",
      :ipaddressid      => ip_address_id,
      :virtualmachineid => env[:machine].id
  }

  begin
    resp = env[:cloudstack_compute].request(options)
    is_success = resp["enablestaticnatresponse"]["success"]

    if is_success != "true"
      env[:ui].warn(" -- Failed to enable static nat: #{resp["enablestaticnatresponse"]["errortext"]}")
      return
    end
  rescue Fog::Compute::Cloudstack::Error => e
    raise Errors::FogError, :message => e.message
  end

  # Save ipaddress id to the data dir so it can be disabled when the instance is destroyed
  static_nat_file = env[:machine].data_dir.join('static_nat')
  static_nat_file.open('a+') do |f|
    f.write("#{ip_address_id}\n")
  end
end

#recover(env) ⇒ Object 



290
291
292
293
294
295
296
297
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 290

def recover(env)
  return if env["vagrant.error"].is_a?(Vagrant::Errors::VagrantError)

  if env[:machine].provider.state.id != :not_created
    # Undo the import
    terminate(env)
  end
end

#terminate(env) ⇒ Object 



472
473
474
475
476
477
478
 
# File 'lib/vagrant-cloudstack/action/run_instance.rb', line 472

def terminate(env)
  destroy_env = env.dup
  destroy_env.delete(:interrupted)
  destroy_env[:config_validate]       = false
  destroy_env[:force_confirm_destroy] = true
  env[:action_runner].run(Action.action_destroy, destroy_env)
end