Class: VagrantPlugins::ProviderLibvirt::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant-libvirt/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



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
 
# File 'lib/vagrant-libvirt/config.rb', line 92

def initialize
  @uri               = UNSET_VALUE
  @driver            = UNSET_VALUE
  @host              = UNSET_VALUE
  @connect_via_ssh   = UNSET_VALUE
  @username          = UNSET_VALUE
  @password          = UNSET_VALUE
  @id_ssh_key_file   = UNSET_VALUE
  @storage_pool_name = UNSET_VALUE
  @random_hostname   = UNSET_VALUE
  @management_network_name    = UNSET_VALUE
  @management_network_address = UNSET_VALUE
  @management_network_mode = UNSET_VALUE
  @management_network_mac  = UNSET_VALUE

  # Domain specific settings.
  @memory            = UNSET_VALUE
  @cpus              = UNSET_VALUE
  @cpu_mode          = UNSET_VALUE
  @loader            = UNSET_VALUE
  @machine_type      = UNSET_VALUE
  @machine_arch      = UNSET_VALUE
  @machine_virtual_size = UNSET_VALUE
  @disk_bus          = UNSET_VALUE
  @nic_model_type    = UNSET_VALUE
  @nested            = UNSET_VALUE
  @volume_cache      = UNSET_VALUE
  @kernel            = UNSET_VALUE
  @initrd            = UNSET_VALUE
  @cmd_line          = UNSET_VALUE
  @graphics_type     = UNSET_VALUE
  @graphics_autoport = UNSET_VALUE
  @graphics_port     = UNSET_VALUE
  @graphics_ip       = UNSET_VALUE
  @graphics_passwd   = UNSET_VALUE
  @video_type        = UNSET_VALUE
  @video_vram        = UNSET_VALUE
  @keymap            = UNSET_VALUE

  @nic_adapter_count = UNSET_VALUE

  # Boot order
  @boot_order = []
  # Storage
  @disks             = []
  @cdroms			   = []

  # Inputs
  @inputs            = UNSET_VALUE
end

Instance Attribute Details

#boot_order ⇒ Object

Returns the value of attribute boot_order.



60
61
62
 
# File 'lib/vagrant-libvirt/config.rb', line 60

def boot_order
  @boot_order
end

#cdroms ⇒ Object

Returns the value of attribute cdroms.



87
88
89
 
# File 'lib/vagrant-libvirt/config.rb', line 87

def cdroms
  @cdroms
end

#cmd_line ⇒ Object

Returns the value of attribute cmd_line.



69
70
71
 
# File 'lib/vagrant-libvirt/config.rb', line 69

def cmd_line
  @cmd_line
end

#connect_via_ssh ⇒ Object

If use ssh tunnel to connect to Libvirt.



26
27
28
 
# File 'lib/vagrant-libvirt/config.rb', line 26

def connect_via_ssh
  @connect_via_ssh
end

#cpu_mode ⇒ Object

Returns the value of attribute cpu_mode.



58
59
60
 
# File 'lib/vagrant-libvirt/config.rb', line 58

def cpu_mode
  @cpu_mode
end

#cpus ⇒ Object

Returns the value of attribute cpus.



57
58
59
 
# File 'lib/vagrant-libvirt/config.rb', line 57

def cpus
  @cpus
end

#default_prefix ⇒ Object

Default host prefix (alternative to use project folder name)



53
54
55
 
# File 'lib/vagrant-libvirt/config.rb', line 53

def default_prefix
  @default_prefix
end

#disk_bus ⇒ Object

Returns the value of attribute disk_bus.



64
65
66
 
# File 'lib/vagrant-libvirt/config.rb', line 64

def disk_bus
  @disk_bus
end

#disks ⇒ Object

Storage



86
87
88
 
# File 'lib/vagrant-libvirt/config.rb', line 86

def disks
  @disks
end

#driver ⇒ Object

A hypervisor name to access via Libvirt.



20
21
22
 
# File 'lib/vagrant-libvirt/config.rb', line 20

def driver
  @driver
end

#graphics_autoport ⇒ Object

Returns the value of attribute graphics_autoport.



72
73
74
 
# File 'lib/vagrant-libvirt/config.rb', line 72

def graphics_autoport
  @graphics_autoport
end

#graphics_ip ⇒ Object

Returns the value of attribute graphics_ip.



75
76
77
 
# File 'lib/vagrant-libvirt/config.rb', line 75

def graphics_ip
  @graphics_ip
end

#graphics_passwd ⇒ Object

Returns the value of attribute graphics_passwd.



74
75
76
 
# File 'lib/vagrant-libvirt/config.rb', line 74

def graphics_passwd
  @graphics_passwd
end

#graphics_port ⇒ Object

Returns the value of attribute graphics_port.



73
74
75
 
# File 'lib/vagrant-libvirt/config.rb', line 73

def graphics_port
  @graphics_port
end

#graphics_type ⇒ Object

Returns the value of attribute graphics_type.



71
72
73
 
# File 'lib/vagrant-libvirt/config.rb', line 71

def graphics_type
  @graphics_type
end

#host ⇒ Object

The name of the server, where libvirtd is running.



23
24
25
 
# File 'lib/vagrant-libvirt/config.rb', line 23

def host
  @host
end

#id_ssh_key_file ⇒ Object

ID SSH key file



37
38
39
 
# File 'lib/vagrant-libvirt/config.rb', line 37

def id_ssh_key_file
  @id_ssh_key_file
end

#initrd ⇒ Object

Returns the value of attribute initrd.



70
71
72
 
# File 'lib/vagrant-libvirt/config.rb', line 70

def initrd
  @initrd
end

#inputs ⇒ Object

Inputs



90
91
92
 
# File 'lib/vagrant-libvirt/config.rb', line 90

def inputs
  @inputs
end

#kernel ⇒ Object

Returns the value of attribute kernel.



68
69
70
 
# File 'lib/vagrant-libvirt/config.rb', line 68

def kernel
  @kernel
end

#keymap ⇒ Object

Returns the value of attribute keymap.



78
79
80
 
# File 'lib/vagrant-libvirt/config.rb', line 78

def keymap
  @keymap
end

#loader ⇒ Object

Returns the value of attribute loader.



59
60
61
 
# File 'lib/vagrant-libvirt/config.rb', line 59

def loader
  @loader
end

#machine_arch ⇒ Object

Returns the value of attribute machine_arch.



62
63
64
 
# File 'lib/vagrant-libvirt/config.rb', line 62

def machine_arch
  @machine_arch
end

#machine_type ⇒ Object

Returns the value of attribute machine_type.



61
62
63
 
# File 'lib/vagrant-libvirt/config.rb', line 61

def machine_type
  @machine_type
end

#machine_virtual_size ⇒ Object

Returns the value of attribute machine_virtual_size.



63
64
65
 
# File 'lib/vagrant-libvirt/config.rb', line 63

def machine_virtual_size
  @machine_virtual_size
end

#management_network_address ⇒ Object

Returns the value of attribute management_network_address.



48
49
50
 
# File 'lib/vagrant-libvirt/config.rb', line 48

def management_network_address
  @management_network_address
end

#management_network_mac ⇒ Object

Returns the value of attribute management_network_mac.



50
51
52
 
# File 'lib/vagrant-libvirt/config.rb', line 50

def management_network_mac
  @management_network_mac
end

#management_network_mode ⇒ Object

Returns the value of attribute management_network_mode.



49
50
51
 
# File 'lib/vagrant-libvirt/config.rb', line 49

def management_network_mode
  @management_network_mode
end

#management_network_name ⇒ Object

Libvirt default network



47
48
49
 
# File 'lib/vagrant-libvirt/config.rb', line 47

def management_network_name
  @management_network_name
end

#memory ⇒ Object

Domain specific settings used while creating new domain.



56
57
58
 
# File 'lib/vagrant-libvirt/config.rb', line 56

def memory
  @memory
end

#nested ⇒ Object

Returns the value of attribute nested.



66
67
68
 
# File 'lib/vagrant-libvirt/config.rb', line 66

def nested
  @nested
end

#nic_adapter_count ⇒ Object

Sets the max number of NICs that can be created Default set to 8. Don’t change the default unless you know what are doing



83
84
85
 
# File 'lib/vagrant-libvirt/config.rb', line 83

def nic_adapter_count
  @nic_adapter_count
end

#nic_model_type ⇒ Object

Returns the value of attribute nic_model_type.



65
66
67
 
# File 'lib/vagrant-libvirt/config.rb', line 65

def nic_model_type
  @nic_model_type
end

#password ⇒ Object

Password for Libvirt connection.



34
35
36
 
# File 'lib/vagrant-libvirt/config.rb', line 34

def password
  @password
end

#random_hostname ⇒ Object

Turn on to prevent hostname conflicts



44
45
46
 
# File 'lib/vagrant-libvirt/config.rb', line 44

def random_hostname
  @random_hostname
end

#socket ⇒ Object

Path towards the libvirt socket



28
29
30
 
# File 'lib/vagrant-libvirt/config.rb', line 28

def socket
  @socket
end

#storage_pool_name ⇒ Object

Libvirt storage pool name, where box image and instance snapshots will be stored.



41
42
43
 
# File 'lib/vagrant-libvirt/config.rb', line 41

def storage_pool_name
  @storage_pool_name
end

#uri ⇒ Object

manually specify URI will supercede most other options if provided



17
18
19
 
# File 'lib/vagrant-libvirt/config.rb', line 17

def uri
  @uri
end

#username ⇒ Object

The username to access Libvirt.



31
32
33
 
# File 'lib/vagrant-libvirt/config.rb', line 31

def username
  @username
end

#video_type ⇒ Object

Returns the value of attribute video_type.



76
77
78
 
# File 'lib/vagrant-libvirt/config.rb', line 76

def video_type
  @video_type
end

#video_vram ⇒ Object

Returns the value of attribute video_vram.



77
78
79
 
# File 'lib/vagrant-libvirt/config.rb', line 77

def video_vram
  @video_vram
end

#volume_cache ⇒ Object

Returns the value of attribute volume_cache.



67
68
69
 
# File 'lib/vagrant-libvirt/config.rb', line 67

def volume_cache
  @volume_cache
end

Instance Method Details

#_generate_uri ⇒ Object

code to generate URI from a config moved out of the connect action



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
 
# File 'lib/vagrant-libvirt/config.rb', line 253

def _generate_uri
  # builds the libvirt connection URI from the given driver config
  # Setup connection uri.
  uri = @driver.dup
  virt_path = case uri
  when 'qemu', 'openvz', 'uml', 'phyp', 'parallels', 'kvm'
    '/system'
  when '@en', 'esx'
    '/'
  when 'vbox', 'vmwarews', 'hyperv'
    '/session'
  else
    raise "Require specify driver #{uri}"
  end
  if uri == 'kvm'
    uri = 'qemu'	# use qemu uri for kvm domain type
  end

  if @connect_via_ssh
    uri << '+ssh://'
    if @username
      uri << @username + '@'
    end

    if @host
      uri << @host
    else
      uri << 'localhost'
    end
  else
    uri << '://'
    uri << @host if @host
  end

  uri << virt_path
  uri << '?no_verify=1'

  if @id_ssh_key_file
    # set ssh key for access to libvirt host
    uri << "\&keyfile="
    # if no slash, prepend $HOME/.ssh/
    @id_ssh_key_file.prepend("#{`echo ${HOME}`.chomp}/.ssh/") if @id_ssh_key_file !~ /\A\//
    uri << @id_ssh_key_file
  end
  # set path to libvirt socket
  uri << "\&socket="+@socket if @socket
  return uri
end

#_get_cdrom_dev(cdroms) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/vagrant-libvirt/config.rb', line 160

def _get_cdrom_dev(cdroms)
  exist = Hash[cdroms.collect{|x| [x[:dev],true]}]
  # hda - hdc
  curr = "a".ord
  while curr <= "d".ord
    dev = "hd" + curr.chr
    if exist[dev]
      curr += 1
      next
    else
      return dev
    end
  end

  # is it better to raise our own error, or let libvirt cause the exception?
  raise 'Only four cdroms may be attached at a time'
end

#_get_device(disks) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/vagrant-libvirt/config.rb', line 147

def _get_device(disks)
  # skip existing devices and also the first one (vda)
  exist = disks.collect {|x| x[:device]}+[1.vdev.to_s]
  skip = 1		# we're 1 based, not 0 based...
  while true do
    dev = skip.vdev	# get lettered device
    if !exist.include?(dev)
      return dev
    end
    skip+=1
  end
end

#_handle_cdrom_storage(options = {}) ⇒ Object 



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
 
# File 'lib/vagrant-libvirt/config.rb', line 204

def _handle_cdrom_storage(options={})
  # <disk type="file" device="cdrom">
  #   <source file="/home/user/virtio-win-0.1-100.iso"/>
  #   <target dev="hdc"/>
  #   <readonly/>
  #   <address type='drive' controller='0' bus='1' target='0' unit='0'/>
  # </disk>
  #
  # note the target dev will need to be changed with each cdrom drive (hdc, hdd, etc),
  # as will the address unit number (unit=0, unit=1, etc)

  options = {
    :dev => self._get_cdrom_dev(@cdroms),
    :bus => "ide",
    :path => nil,
  }.merge(options)

  cdrom = {
    :dev => options[:dev],
    :bus => options[:bus],
    :path => options[:path]
  }

  @cdroms << cdrom
end

#_handle_disk_storage(options = {}) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/vagrant-libvirt/config.rb', line 230

def _handle_disk_storage(options={})
  options = {
    :device => _get_device(@disks),
    :type => 'qcow2',
    :size => '10G',	# matches the fog default
    :path => nil,
    :bus => 'virtio'
  }.merge(options)

  disk = {
    :device => options[:device],
    :type => options[:type],
    :size => options[:size],
    :path => options[:path],
    :bus => options[:bus],
    :cache => options[:cache] || 'default',
    :allow_existing => options[:allow_existing],
  }

  @disks << disk	# append
end

#boot(device) ⇒ Object 



143
144
145
 
# File 'lib/vagrant-libvirt/config.rb', line 143

def boot(device)
  @boot_order << device	# append
end

#finalize! ⇒ Object 



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
 
# File 'lib/vagrant-libvirt/config.rb', line 302

def finalize!
  @driver = 'kvm' if @driver == UNSET_VALUE
  @host = nil if @host == UNSET_VALUE
  @connect_via_ssh = false if @connect_via_ssh == UNSET_VALUE
  @username = nil if @username == UNSET_VALUE
  @password = nil if @password == UNSET_VALUE
  @id_ssh_key_file = 'id_rsa' if @id_ssh_key_file == UNSET_VALUE
  @storage_pool_name = 'default' if @storage_pool_name == UNSET_VALUE
  @random_hostname = false if @random_hostname == UNSET_VALUE
  @management_network_name = 'vagrant-libvirt' if @management_network_name == UNSET_VALUE
  @management_network_address = '192.168.121.0/24' if @management_network_address == UNSET_VALUE
  @management_network_mode = 'nat' if @management_network_mode == UNSET_VALUE
  @management_network_mac = nil if @management_network_mac == UNSET_VALUE

  # generate a URI if none is supplied
  @uri = _generate_uri() if @uri == UNSET_VALUE

  # Domain specific settings.
  @memory = 512 if @memory == UNSET_VALUE
  @cpus = 1 if @cpus == UNSET_VALUE
  @cpu_mode = 'host-model' if @cpu_mode == UNSET_VALUE
  @loader = nil if @loader == UNSET_VALUE
  @machine_type = nil if @machine_type == UNSET_VALUE
  @machine_arch = nil if @machine_arch == UNSET_VALUE
  @machine_virtual_size = nil if @machine_virtual_size == UNSET_VALUE
  @disk_bus = 'virtio' if @disk_bus == UNSET_VALUE
  @nic_model_type = 'virtio' if @nic_model_type == UNSET_VALUE
  @nested = false if @nested == UNSET_VALUE
  @volume_cache = 'default' if @volume_cache == UNSET_VALUE
  @kernel = nil if @kernel == UNSET_VALUE
  @cmd_line = '' if @cmd_line == UNSET_VALUE
  @initrd = '' if @initrd == UNSET_VALUE
  @graphics_type = 'vnc' if @graphics_type == UNSET_VALUE
  @graphics_autoport = 'yes' if @graphics_port == UNSET_VALUE
  @graphics_autoport = 'no' if @graphics_port != UNSET_VALUE
  if (@graphics_type != 'vnc' && @graphics_type != 'spice') ||
      @graphics_passwd == UNSET_VALUE
    @graphics_passwd = nil
  end
  @graphics_port = 5900 if @graphics_port == UNSET_VALUE
  @graphics_ip = '127.0.0.1' if @graphics_ip == UNSET_VALUE
  @video_type = 'cirrus' if @video_type == UNSET_VALUE
  @video_vram = 9216 if @video_vram == UNSET_VALUE
  @keymap = 'en-us' if @keymap == UNSET_VALUE
  @nic_adapter_count = 8 if @nic_adapter_count == UNSET_VALUE

  # Boot order
  @boot_order = [] if @boot_order == UNSET_VALUE

  # Storage
  @disks = [] if @disks == UNSET_VALUE
  @cdroms = [] if @cdroms == UNSET_VALUE
  @inputs = [{:type => "mouse", :bus => "ps2"}] if @inputs == UNSET_VALUE
end

#input(options = {}) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/vagrant-libvirt/config.rb', line 178

def input(options={})
  if options[:type].nil? || options[:bus].nil?
    raise 'Input type AND bus must be specified'
  end

  if @inputs == UNSET_VALUE
    @inputs = []
  end

  @inputs.push({
    type: options[:type],
    bus:  options[:bus]
  })
end

#merge(other) ⇒ Object 



369
370
371
372
373
374
375
 
# File 'lib/vagrant-libvirt/config.rb', line 369

def merge(other)
  super.tap do |result|
    c = disks.dup
    c += other.disks
    result.disks = c
  end
end

#storage(storage_type, options = {}) ⇒ Object

NOTE: this will run twice for each time it’s needed- keep it idempotent



194
195
196
197
198
199
200
201
202
 
# File 'lib/vagrant-libvirt/config.rb', line 194

def storage(storage_type, options={})
  if storage_type == :file
    if options[:device] == :cdrom
      _handle_cdrom_storage(options)
    else
      _handle_disk_storage(options)
    end
  end
end

#validate(machine) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/vagrant-libvirt/config.rb', line 357

def validate(machine)
  errors = _detected_errors

  machine.provider_config.disks.each do |disk|
    if disk[:path] and disk[:path][0] == '/'
      errors << "absolute volume paths like '#{disk[:path]}' not yet supported"
    end
  end

   { "Libvirt Provider" => errors }
end