Class: VCloudCloud::Cloud

Inherits:
Bosh::Cloud
  • Object
show all
Defined in:
lib/cloud/vcloud/cloud.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Cloud

Returns a new instance of Cloud.

Raises:

  • (ArgumentError) 


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/cloud/vcloud/cloud.rb', line 13

def initialize(options)
  @logger = Bosh::Clouds::Config.logger
  @logger.debug "Input cloud options: #{options.inspect}"

  @agent_properties = options['agent'] || {}

  vcds = options['vcds']
  raise ArgumentError, 'Invalid number of VCDs' unless vcds && vcds.size == 1
  @vcd = vcds[0]

  @entities = @vcd['entities']
  raise ArgumentError, 'Invalid entities in VCD settings' unless @entities && @entities.is_a?(Hash)

  @client = VCloudClient.new(@vcd, @logger)
end

Instance Method Details

#attach_disk(vm_id, disk_id) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/cloud/vcloud/cloud.rb', line 269

def attach_disk(vm_id, disk_id)
  steps "attach_disk(#{vm_id}, #{disk_id})" do |s|
    vm = s.state[:vm] = client.resolve_entity vm_id

    # vm.hardware_section will change, save current state of disks
    previous_disks_list = Array.new(vm.hardware_section.hard_disks)

    s.state[:disk] = client.resolve_entity disk_id

    errors = [RuntimeError]
    Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
      begin
        s.next Steps::AttachDetachDisk, :attach

        # update environment
        s.state[:env_metadata_key] = @entities['vm_metadata_key']
        s.next Steps::LoadAgentEnv

        vm = s.state[:vm] = client.reload vm
        Steps::CreateOrUpdateAgentEnv.update_persistent_disk s.state[:env], vm, disk_id, previous_disks_list

        save_agent_env s
      rescue Exception => e
        @logger.warn "Caught an exception during attach_disk Exception #{e}, Type #{e.class} Message #{e.message}"
        @logger.warn "Exception trace #{e.backtrace.join('\n')}"
        raise "re raising exception #{e.message} in attach_disk"
      end
    end
  end
end

#client ⇒ Object 



352
353
354
 
# File 'lib/cloud/vcloud/cloud.rb', line 352

def client
  @client
end

#configure_networks(vm_id, networks) ⇒ Object

Raises:

  • (Bosh::Clouds::NotSupported) 


255
256
257
 
# File 'lib/cloud/vcloud/cloud.rb', line 255

def configure_networks(vm_id, networks)
  raise Bosh::Clouds::NotSupported, 'VDC CPI was configured to return NotSupported'
end

#cpi_call_wait_time ⇒ Object 



64
65
66
 
# File 'lib/cloud/vcloud/cloud.rb', line 64

def cpi_call_wait_time
  2
end

#cpi_retries ⇒ Object 



68
69
70
 
# File 'lib/cloud/vcloud/cloud.rb', line 68

def cpi_retries
  10
end

#create_disk(size_mb, cloud_properties, vm_locality = nil) ⇒ Object 



259
260
261
262
263
264
265
266
267
 
# File 'lib/cloud/vcloud/cloud.rb', line 259

def create_disk(size_mb, cloud_properties, vm_locality = nil)
  (steps "create_disk(#{size_mb}, #{cloud_properties.inspect}, #{vm_locality.inspect})" do |s|
    # vm_locality is used as vm_id
    vm = vm_locality.nil? ? nil : client.resolve_entity(vm_locality)
    storage_profiles = client.vdc.storage_profiles || []
    storage_profile = storage_profiles.find { |sp| sp['name'] == @entities['vapp_storage_profile'] }
    s.next Steps::CreateDisk, unique_name, size_mb, vm, storage_profile
  end)[:disk].urn
end

#create_stemcell(image, _) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/cloud/vcloud/cloud.rb', line 29

def create_stemcell(image, _)
  (steps "create_stemcell(#{image}, _)" do |s|
    s.next Steps::StemcellInfo, image
    catalog_type = :vapp
    s.next Steps::AddCatalog, @client.catalog_name(catalog_type)
    s.next Steps::CreateTemplate, "sc-#{unique_name}", catalog_type

    # Retry upload template file in case of timeout
    errors = [Timeout::Error]
    Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
      s.next Steps::UploadTemplateFiles
    end
  end)[:catalog_item].urn
end

#create_vm(agent_id, catalog_vapp_id, resource_pool, networks, disk_locality = nil, environment = nil) ⇒ Object 



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
 
# File 'lib/cloud/vcloud/cloud.rb', line 72

def create_vm(agent_id, catalog_vapp_id, resource_pool, networks, disk_locality = nil, environment = nil)
  (steps "create_vm(#{agent_id}, #{catalog_vapp_id}, #{resource_pool}, ...)" do |s|
    # disk_locality should be an array of disk ids
    disk_locality = independent_disks disk_locality

    # agent_id is used as vm name
    description = @entities['description']

    requested_name = environment && environment['vapp']
    vapp_name = requested_name ? "vapp-tmp-#{unique_name}" : agent_id

    storage_profiles = client.vdc.storage_profiles || []
    storage_profile = storage_profiles.find { |sp| sp['name'] == @entities['vapp_storage_profile'] }


    s.next Steps::Instantiate, catalog_vapp_id, vapp_name, description, disk_locality, storage_profile
    client.flush_cache # flush cached vdc which contains vapp list
    vapp = s.state[:vapp]
    vm = s.state[:vm] = vapp.vms[0]

    # save original disk configuration
    s.state[:disks] = Array.new(vm.hardware_section.hard_disks)
    reconfigure_vm s, agent_id, description, resource_pool, networks

    vapp, vm =[s.state[:vapp], s.state[:vm]]

    #set agent id of vm
    vm.agent_id=agent_id

    # To handle concurrent create_vm requests,
    # if the target vApp exists, creates a temp vApp, and then recomposes its VM to the target vApp.
    if requested_name
      container_vapp = nil

      errors = [RuntimeError]
      Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
        begin
          begin
            @logger.debug "Requesting container vApp: #{requested_name}"
            container_vapp = client.vapp_by_name requested_name
          rescue ObjectNotFoundError
            # ignored, keep container_vapp nil
            @logger.debug "Invalid container vApp: #{requested_name}"
          end

          if container_vapp
            @logger.debug "Enter recompose, container_vapp: #{container_vapp.name}"
            begin
              s.next Steps::Recompose, container_vapp.name, container_vapp, vm
            rescue VCloudCloud::ObjectExistsError => e
              @logger.debug "VM already exists, skip the error"
            end
          else
            # just rename the vApp
            container_vapp = vapp
            s.next Steps::Recompose, requested_name, container_vapp
          end
        rescue Exception => e
          @logger.warn "Caught an exception during create_vm Exception #{e}, Type #{e.class} Message #{e.message}"
          @logger.warn "Exception trace #{e.backtrace.join('\n')}"
          raise "re raising exception #{e.message} in create_vm"
        end
      end

      # delete tmp vapp only if the name is different from requested
      client.flush_cache
      vapp = client.reload vapp
      client.wait_entity vapp, true
      if vapp.name != requested_name
        begin
          s.next Steps::Delete, vapp, true
        rescue Exception => ex
          @logger.warn "Caught exception when trying to delete tmp vapp #{vapp.name}: #{ex.to_s}"
        end
      end

      # Wait for Delete/Recompose step to finish, retry if fails
      # reload all the stuff
      client.flush_cache
      vapp = client.reload container_vapp
      client.wait_entity vapp, true

      vms = vapp.vms.select { |v| v.name == vm.name }

      raise "New virtual machine not found in recomposed vApp" if vms.empty?
      s.state[:vm] = client.resolve_link vms[0].href
    end

    # create env and generate env ISO image
    s.state[:env_metadata_key] = @entities['vm_metadata_key']
    s.next Steps::CreateOrUpdateAgentEnv, networks, environment, @agent_properties

    # TODO refact this
    if requested_name
      errors = [RuntimeError]
      Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
        begin
          save_agent_env s
          s.next Steps::PowerOn, :vm
        rescue Exception => e
          @logger.warn "Caught an exception during create_vm Exception #{e}, Type #{e.class} Message #{e.message}"
          @logger.warn "Exception trace #{e.backtrace.join('\n')}"
          raise "re raising exception #{e.message} in create_vm"
        end
      end
    else
      save_agent_env s
      s.next Steps::PowerOn, :vm
    end

    s.state[:vapp] = vapp
    s.state
  end)[:vm].urn
end

#delete_disk(disk_id) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cloud/vcloud/cloud.rb', line 333

def delete_disk(disk_id)
  steps "delete_disk(#{disk_id})" do |s|
    begin
      disk = client.resolve_entity disk_id
      s.next Steps::Delete, disk, true
    rescue RestClient::Forbidden, ObjectNotFoundError => e
      @logger.warn "got #{e.message} error while deleting disk #{disk_id}, skip the error"
      return
    end
  end
end

#delete_stemcell(catalog_vapp_id) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cloud/vcloud/cloud.rb', line 44

def delete_stemcell(catalog_vapp_id)
  steps "delete_stemcell(#{catalog_vapp_id})" do |s|
    begin
      catalog_vapp = client.resolve_entity catalog_vapp_id
      if catalog_vapp.nil?
        @logger.warn "Catalog vApp #{catalog_vapp_id} not found, skip the error"
        return
      end

      vapp = client.resolve_link catalog_vapp.entity
      client.wait_entity vapp, true
      client.invoke :delete, vapp.remove_link
      client.invoke :delete, catalog_vapp.href
    rescue RestClient::Forbidden, ObjectNotFoundError => e
      @logger.warn "get #{e.message} error while deleting Catalog vApp #{catalog_vapp_id} in #delete_stemcell, skip the error"
      return
    end
  end
end

#delete_vm(vm_id) ⇒ Object 



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
252
253
 
# File 'lib/cloud/vcloud/cloud.rb', line 227

def delete_vm(vm_id)
  steps "delete_vm(#{vm_id})" do |s|
    begin
      vm = s.state[:vm] = client.resolve_entity vm_id

      # poweroff vm before we are able to delete it
      s.next Steps::PowerOff, :vm, true

      vapp = s.state[:vapp] = client.resolve_link vm.container_vapp_link
      #remove vapp if it is temporary vapp
      #vapp is temporary vapp if vapp name is same as agent id
      if vapp.name == vm.agent_id
        s.next Steps::PowerOff, :vapp, true
        s.next Steps::Undeploy, :vapp
        s.next Steps::Delete, s.state[:vapp], true
      else
        s.next Steps::Undeploy, :vm
        s.next Steps::Delete, s.state[:vm], true
      end

      s.next Steps::DeleteCatalogMedia, vm.name
    rescue RestClient::Forbidden, ObjectNotFoundError => e
      @logger.warn "get #{e.message} error while deleting vm #{vm_id} likely due to non-existence, skip the error"
      return
    end
  end
end

#detach_disk(vm_id, disk_id) ⇒ Object 



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
 
# File 'lib/cloud/vcloud/cloud.rb', line 300

def detach_disk(vm_id, disk_id)
  steps "detach_disk(#{vm_id}, #{disk_id})" do |s|
    vm = s.state[:vm] = client.resolve_entity vm_id
    s.state[:disk] = client.resolve_entity disk_id
    # if disk is not attached, just ignore
    next unless vm.find_attached_disk s.state[:disk]

    errors = [RuntimeError]
    Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
      begin
        if vm['status'] == VCloudSdk::Xml::RESOURCE_ENTITY_STATUS[:SUSPENDED].to_s
          s.next Steps::DiscardSuspendedState, :vm
        end
        s.next Steps::AttachDetachDisk, :detach

        # update environment
        s.state[:env_metadata_key] = @entities['vm_metadata_key']
        s.next Steps::LoadAgentEnv
        env = s.state[:env]
        if env['disks'] && env['disks']['persistent'].is_a?(Hash)
          env['disks']['persistent'].delete disk_id
        end

        save_agent_env s
      rescue Exception => e
        @logger.warn "Caught an exception during detach_disk Exception #{e}, Type #{e.class} Message #{e.message}"
        @logger.warn "Exception trace #{e.backtrace.join('\n')}"
        raise "re raising exception #{e.message} in detach_disk"
      end
    end
  end
end

#get_disk_size_mb(disk_id) ⇒ Object 



345
346
347
 
# File 'lib/cloud/vcloud/cloud.rb', line 345

def get_disk_size_mb(disk_id)
  client.resolve_entity(disk_id).size_mb
end

#has_vm?(vm_id) ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
221
222
223
224
225
 
# File 'lib/cloud/vcloud/cloud.rb', line 218

def has_vm?(vm_id)
  vm = client.resolve_entity vm_id
  vm.type == VCloudSdk::Xml::MEDIA_TYPE[:VM]
rescue RestClient::Exception # invalid ID will get 403
  false
rescue ObjectNotFoundError
  false
end

#reboot_vm(vm_id) ⇒ Object 



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
 
# File 'lib/cloud/vcloud/cloud.rb', line 187

def reboot_vm(vm_id)
  steps "reboot_vm(#{vm_id})" do |s|
    vm = s.state[:vm] = client.resolve_entity(vm_id)

    errors = [RuntimeError]
    Bosh::Common.retryable(sleep: cpi_call_wait_time, tries: cpi_retries, on: errors) do |tries, error|
      begin
        if vm['status'] == VCloudSdk::Xml::RESOURCE_ENTITY_STATUS[:SUSPENDED].to_s
          s.next Steps::DiscardSuspendedState, :vm
          s.next Steps::PowerOn, :vm
        elsif vm['status'] == VCloudSdk::Xml::RESOURCE_ENTITY_STATUS[:POWERED_OFF].to_s
          s.next Steps::PowerOn, :vm
        else
          begin
            s.next Steps::Reboot, :vm
          rescue => ex
            @logger.warn "Caught exception when trying to Reboot vm #{vm_id}: #{ex.to_s}"
            @logger.debug 'Force a hard-reboot when failed to perform a soft-reboot'
            s.next Steps::PowerOff, :vm, true
            s.next Steps::PowerOn, :vm
          end
        end
      rescue Exception => e
        @logger.warn "Caught an exception during reboot_vm Exception #{e}, Type #{e.class} Message #{e.message}"
        @logger.warn "Exception trace #{e.backtrace.join('\n')}"
        raise "re raising exception #{e.message} in reboot_vm"
      end
    end
  end
end

#validate_deployment(old_manifest, new_manifest) ⇒ Object 



349
350
 
# File 'lib/cloud/vcloud/cloud.rb', line 349

def validate_deployment(old_manifest, new_manifest)
end