Class: VagrantPlugins::ProviderLibvirt::Action::CreateDomain

Inherits:
Object
  • Object
show all
Includes:
Util::ErbTemplate
Defined in:
lib/vagrant-libvirt/action/create_domain.rb

Instance Method Summary collapse

Methods included from Util::ErbTemplate

#to_xml

Constructor Details

#initialize(app, _env) ⇒ CreateDomain

Returns a new instance of CreateDomain.


9
10
11
12
# File 'lib/vagrant-libvirt/action/create_domain.rb', line 9

def initialize(app, _env)
  @logger = Log4r::Logger.new('vagrant_libvirt::action::create_domain')
  @app = app
end

Instance Method Details

#_cdroms_print(cdroms) ⇒ Object


24
25
26
# File 'lib/vagrant-libvirt/action/create_domain.rb', line 24

def _cdroms_print(cdroms)
  cdroms.collect { |x| x[:dev] }.join(', ')
end

#_disk_name(name, disk) ⇒ Object


14
15
16
# File 'lib/vagrant-libvirt/action/create_domain.rb', line 14

def _disk_name(name, disk)
  "#{name}-#{disk[:device]}.#{disk[:type]}" # disk name
end

#_disks_print(disks) ⇒ Object


18
19
20
21
22
# File 'lib/vagrant-libvirt/action/create_domain.rb', line 18

def _disks_print(disks)
  disks.collect do |x|
    "#{x[:device]}(#{x[:type]},#{x[:size]})"
  end.join(', ')
end

#call(env) ⇒ Object


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
252
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
289
290
291
292
293
294
295
296
297
298
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
343
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
# File 'lib/vagrant-libvirt/action/create_domain.rb', line 28

def call(env)
  # Get config.
  config = env[:machine].provider_config

  # Gather some info about domain
  @name = env[:domain_name]
  @title = config.title
  @description = config.description
  @uuid = config.uuid
  @cpus = config.cpus.to_i
  @cpuset = config.cpuset
  @cpu_features = config.cpu_features
  @cpu_topology = config.cpu_topology
  @nodeset = config.nodeset
  @features = config.features
  @features_hyperv = config.features_hyperv
  @shares = config.shares
  @cpu_mode = config.cpu_mode
  @cpu_model = config.cpu_model
  @cpu_fallback = config.cpu_fallback
  @numa_nodes = config.numa_nodes
  @loader = config.loader
  @nvram = config.nvram
  @machine_type = config.machine_type
  @machine_arch = config.machine_arch
  @disk_bus = config.disk_bus
  @disk_device = config.disk_device
  @nested = config.nested
  @memory_size = config.memory.to_i * 1024
  @memory_backing = config.memory_backing
  @management_network_mac = config.management_network_mac
  @domain_volume_cache = config.volume_cache
  @kernel = config.kernel
  @cmd_line = config.cmd_line
  @emulator_path = config.emulator_path
  @initrd = config.initrd
  @dtb = config.dtb
  @graphics_type = config.graphics_type
  @graphics_autoport = config.graphics_autoport
  @graphics_port = config.graphics_port
  @graphics_ip = config.graphics_ip
  @graphics_passwd = if config.graphics_passwd.to_s.empty?
                       ''
                     else
                       "passwd='#{config.graphics_passwd}'"
                      end
  @video_type = config.video_type
  @sound_type = config.sound_type
  @video_vram = config.video_vram
  @keymap = config.keymap
  @kvm_hidden = config.kvm_hidden

  @tpm_model = config.tpm_model
  @tpm_type = config.tpm_type
  @tpm_path = config.tpm_path

  # Boot order
  @boot_order = config.boot_order

  # Storage
  @storage_pool_name = config.storage_pool_name
  @snapshot_pool_name = config.snapshot_pool_name
  @disks = config.disks
  @cdroms = config.cdroms

  # Input
  @inputs = config.inputs

  # Channels
  @channels = config.channels

  # PCI device passthrough
  @pcis = config.pcis

  # Watchdog device
  @watchdog_dev = config.watchdog_dev

  # USB controller
  @usbctl_dev = config.usbctl_dev

  # USB device passthrough
  @usbs = config.usbs

  # Redirected devices
  @redirdevs = config.redirdevs
  @redirfilters = config.redirfilters

  # Additional QEMU commandline arguments
  @qemu_args = config.qemu_args

  # Additional QEMU commandline environment variables
  @qemu_env = config.qemu_env

  # smartcard device
  @smartcard_dev = config.smartcard_dev

  # RNG device passthrough
  @rng = config.rng

  config = env[:machine].provider_config
  @domain_type = config.driver

  @os_type = 'hvm'

  # Get path to domain image from the storage pool selected if we have a box.
  if env[:machine].config.vm.box
    if @snapshot_pool_name != @storage_pool_name
        pool_name = @snapshot_pool_name
    else
        pool_name = @storage_pool_name
    end
    @logger.debug "Search for volume in pool: #{pool_name}"
    domain_volume = env[:machine].provider.driver.connection.volumes.all(
      name: "#{@name}.img"
    ).find { |x| x.pool_name == pool_name }
    raise Errors::DomainVolumeExists if domain_volume.nil?
    @domain_volume_path = domain_volume.path
  end

  # If we have a box, take the path from the domain volume and set our storage_prefix.
  # If not, we dump the storage pool xml to get its defined path.
  # the default storage prefix is typically: /var/lib/libvirt/images/
  if !config.qemu_use_session
    if env[:machine].config.vm.box
      storage_prefix = File.dirname(@domain_volume_path) + '/' # steal
    else
      storage_prefix = get_disk_storage_prefix(env, @storage_pool_name)
    end
  end

  @disks.each do |disk|
    disk[:path] ||= _disk_name(@name, disk)

    # On volume creation, the <path> element inside <target>
    # is oddly ignored; instead the path is taken from the
    # <name> element:
    # http://www.redhat.com/archives/libvir-list/2008-August/msg00329.html
    disk[:name] = disk[:path]

    disk[:absolute_path] = storage_prefix + disk[:path]

    if not disk[:pool].nil?
      disk_pool_name = disk[:pool]
      @logger.debug "Overriding pool name with: #{disk_pool_name}"
      disk_storage_prefix = get_disk_storage_prefix(env, disk_pool_name)
      disk[:absolute_path] = disk_storage_prefix + disk[:path]
      @logger.debug "Overriding disk path with: #{disk[:absolute_path]}"
    else
      disk_pool_name = @storage_pool_name
    end

    # make the disk. equivalent to:
    # qemu-img create -f qcow2 <path> 5g
    begin
      env[:machine].provider.driver.connection.volumes.create(
        name: disk[:name],
        format_type: disk[:type],
        path: disk[:absolute_path],
        capacity: disk[:size],
        #:allocation => ?,
        pool_name: disk_pool_name
      )
    rescue Libvirt::Error => e
      # It is hard to believe that e contains just a string
      # and no useful error code!
      msg = "Call to virStorageVolCreateXML failed: " +
            "storage volume '#{disk[:path]}' exists already"
      if e.message == msg and disk[:allow_existing]
        disk[:preexisting] = true
      else
        raise Errors::FogCreateDomainVolumeError,
              error_message: e.message
      end
    end
  end

  # Output the settings we're going to use to the user
  env[:ui].info(I18n.t('vagrant_libvirt.creating_domain'))
  env[:ui].info(" -- Name:              #{@name}")
  env[:ui].info(" -- Title:             #{@title}") if @title != ''
  env[:ui].info(" -- Description:       #{@description}") if @description != ''
  env[:ui].info(" -- Forced UUID:       #{@uuid}") if @uuid != ''
  env[:ui].info(" -- Domain type:       #{@domain_type}")
  env[:ui].info(" -- Cpus:              #{@cpus}")
  unless @cpuset.nil?
    env[:ui].info(" -- Cpuset:            #{@cpuset}")
  end
  if not @cpu_topology.empty?
    env[:ui].info(" -- CPU topology:   sockets=#{@cpu_topology[:sockets]}, cores=#{@cpu_topology[:cores]}, threads=#{@cpu_topology[:threads]}")
  end
  @cpu_features.each do |cpu_feature|
    env[:ui].info(" -- CPU Feature:       name=#{cpu_feature[:name]}, policy=#{cpu_feature[:policy]}")
  end
  @features.each do |feature|
    env[:ui].info(" -- Feature:           #{feature}")
  end
  @features_hyperv.each do |feature|
    env[:ui].info(" -- Feature (HyperV):  name=#{feature[:name]}, state=#{feature[:state]}")
  end
  env[:ui].info(" -- Memory:            #{@memory_size / 1024}M")
  unless @nodeset.nil?
    env[:ui].info(" -- Nodeset:           #{@nodeset}")
  end
  @memory_backing.each do |backing|
    env[:ui].info(" -- Memory Backing:    #{backing[:name]}: #{backing[:config].map { |k,v| "#{k}='#{v}'"}.join(' ')}")
  end
  unless @shares.nil?
    env[:ui].info(" -- Shares:            #{@shares}")
  end
  env[:ui].info(" -- Management MAC:    #{@management_network_mac}")
  env[:ui].info(" -- Loader:            #{@loader}")
  env[:ui].info(" -- Nvram:             #{@nvram}")
  if env[:machine].config.vm.box
    env[:ui].info(" -- Base box:          #{env[:machine].box.name}")
  end
  env[:ui].info(" -- Storage pool:      #{@storage_pool_name}")
  env[:ui].info(" -- Image:             #{@domain_volume_path} (#{env[:box_virtual_size]}G)")
  env[:ui].info(" -- Volume Cache:      #{@domain_volume_cache}")
  env[:ui].info(" -- Kernel:            #{@kernel}")
  env[:ui].info(" -- Initrd:            #{@initrd}")
  env[:ui].info(" -- Graphics Type:     #{@graphics_type}")
  env[:ui].info(" -- Graphics Port:     #{@graphics_port}")
  env[:ui].info(" -- Graphics IP:       #{@graphics_ip}")
  env[:ui].info(" -- Graphics Password: #{@graphics_passwd.empty? ? 'Not defined' : 'Defined'}")
  env[:ui].info(" -- Video Type:        #{@video_type}")
  env[:ui].info(" -- Video VRAM:        #{@video_vram}")
  env[:ui].info(" -- Sound Type:	#{@sound_type}")
  env[:ui].info(" -- Keymap:            #{@keymap}")
  env[:ui].info(" -- TPM Path:          #{@tpm_path}")

  @boot_order.each do |device|
    env[:ui].info(" -- Boot device:        #{device}")
  end

  unless @disks.empty?
    env[:ui].info(" -- Disks:         #{_disks_print(@disks)}")
  end

  @disks.each do |disk|
    msg = " -- Disk(#{disk[:device]}):     #{disk[:absolute_path]}"
    msg += ' Shared' if disk[:shareable]
    msg += ' (Remove only manually)' if disk[:allow_existing]
    msg += ' Not created - using existed.' if disk[:preexisting]
    env[:ui].info(msg)
  end

  unless @cdroms.empty?
    env[:ui].info(" -- CDROMS:            #{_cdroms_print(@cdroms)}")
  end

  @cdroms.each do |cdrom|
    env[:ui].info(" -- CDROM(#{cdrom[:dev]}):        #{cdrom[:path]}")
  end

  @inputs.each do |input|
    env[:ui].info(" -- INPUT:             type=#{input[:type]}, bus=#{input[:bus]}")
  end

  @channels.each do |channel|
    env[:ui].info(" -- CHANNEL:             type=#{channel[:type]}, mode=#{channel[:source_mode]}")
    env[:ui].info(" -- CHANNEL:             target_type=#{channel[:target_type]}, target_name=#{channel[:target_name]}")
  end

  @pcis.each do |pci|
    env[:ui].info(" -- PCI passthrough:   #{pci[:domain]}:#{pci[:bus]}:#{pci[:slot]}.#{pci[:function]}")
  end

  unless @rng[:model].nil?
    env[:ui].info(" -- RNG device model:  #{@rng[:model]}")
  end

  if not @watchdog_dev.empty?
    env[:ui].info(" -- Watchdog device:   model=#{@watchdog_dev[:model]}, action=#{@watchdog_dev[:action]}")
  end

  if not @usbctl_dev.empty?
    msg = " -- USB controller:    model=#{@usbctl_dev[:model]}"
    msg += ", ports=#{@usbctl_dev[:ports]}" if @usbctl_dev[:ports]
    env[:ui].info(msg)
  end

  @usbs.each do |usb|
    usb_dev = []
    usb_dev.push("bus=#{usb[:bus]}") if usb[:bus]
    usb_dev.push("device=#{usb[:device]}") if usb[:device]
    usb_dev.push("vendor=#{usb[:vendor]}") if usb[:vendor]
    usb_dev.push("product=#{usb[:product]}") if usb[:product]
    env[:ui].info(" -- USB passthrough:   #{usb_dev.join(', ')}")
  end

  unless @redirdevs.empty?
    env[:ui].info(' -- Redirected Devices: ')
    @redirdevs.each do |redirdev|
      msg = "    -> bus=usb, type=#{redirdev[:type]}"
      env[:ui].info(msg)
    end
  end

  unless @redirfilters.empty?
    env[:ui].info(' -- USB Device filter for Redirected Devices: ')
    @redirfilters.each do |redirfilter|
      msg = "    -> class=#{redirfilter[:class]}, "
      msg += "vendor=#{redirfilter[:vendor]}, "
      msg += "product=#{redirfilter[:product]}, "
      msg += "version=#{redirfilter[:version]}, "
      msg += "allow=#{redirfilter[:allow]}"
      env[:ui].info(msg)
    end
  end

  if not @smartcard_dev.empty?
    env[:ui].info(" -- smartcard device:  mode=#{@smartcard_dev[:mode]}, type=#{@smartcard_dev[:type]}")
  end

  unless @qemu_args.empty?
    env[:ui].info(' -- Command line args: ')
    @qemu_args.each do |arg|
      msg = "    -> value=#{arg[:value]}, "
      env[:ui].info(msg)
    end
  end

  unless @qemu_env.empty?
    env[:ui].info(' -- Command line environment variables: ')
    @qemu_env.each do |env_var, env_value|
      msg = "    -> #{env_var}=#{env_value}, "
      env[:ui].info(msg)
    end
  end

  env[:ui].info(" -- Command line : #{@cmd_line}") unless @cmd_line.empty?

  # Create Libvirt domain.
  # Is there a way to tell fog to create new domain with already
  # existing volume? Use domain creation from template..
  begin
    server = env[:machine].provider.driver.connection.servers.create(
      xml: to_xml('domain')
    )
  rescue Fog::Errors::Error => e
    raise Errors::FogCreateServerError, error_message: e.message
  end

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

  @app.call(env)
end