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

#initializeConfig

Returns a new instance of Config.


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

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

  # Domain specific settings.
  @memory            = UNSET_VALUE
  @cpus              = UNSET_VALUE
  @cpu_mode          = 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

  # Storage
  @disks             = UNSET_VALUE
end

Instance Attribute Details

#cmd_lineObject

Returns the value of attribute cmd_line


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

def cmd_line
  @cmd_line
end

#connect_via_sshObject

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_modeObject

Returns the value of attribute cpu_mode


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

def cpu_mode
  @cpu_mode
end

#cpusObject

Returns the value of attribute cpus


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

def cpus
  @cpus
end

#default_prefixObject

Default host prefix (alternative to use project folder name)


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

def default_prefix
  @default_prefix
end

#disk_busObject

Returns the value of attribute disk_bus


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

def disk_bus
  @disk_bus
end

#disksObject

Storage


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

def disks
  @disks
end

#driverObject

A hypervisor name to access via Libvirt.


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

def driver
  @driver
end

#graphics_autoportObject

Returns the value of attribute graphics_autoport


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

def graphics_autoport
  @graphics_autoport
end

#graphics_ipObject

Returns the value of attribute graphics_ip


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

def graphics_ip
  @graphics_ip
end

#graphics_passwdObject

Returns the value of attribute graphics_passwd


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

def graphics_passwd
  @graphics_passwd
end

#graphics_portObject

Returns the value of attribute graphics_port


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

def graphics_port
  @graphics_port
end

#graphics_typeObject

Returns the value of attribute graphics_type


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

def graphics_type
  @graphics_type
end

#hostObject

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_fileObject

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

#initrdObject

Returns the value of attribute initrd


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

def initrd
  @initrd
end

#kernelObject

Returns the value of attribute kernel


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

def kernel
  @kernel
end

#management_network_addressObject

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_modeObject

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_nameObject

Libvirt default network


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

def management_network_name
  @management_network_name
end

#memoryObject

Domain specific settings used while creating new domain.


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

def memory
  @memory
end

#nestedObject

Returns the value of attribute nested


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

def nested
  @nested
end

#nic_model_typeObject

Returns the value of attribute nic_model_type


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

def nic_model_type
  @nic_model_type
end

#passwordObject

Password for Libvirt connection.


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

def password
  @password
end

#random_hostnameObject

Turn on to prevent hostname conflicts


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

def random_hostname
  @random_hostname
end

#socketObject

Path towards the libvirt socket


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

def socket
  @socket
end

#storage_pool_nameObject

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

#uriObject

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

#usernameObject

The username to access Libvirt.


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

def username
  @username
end

#video_typeObject

Returns the value of attribute video_type


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

def video_type
  @video_type
end

#video_vramObject

Returns the value of attribute video_vram


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

def video_vram
  @video_vram
end

#volume_cacheObject

Returns the value of attribute volume_cache


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

def volume_cache
  @volume_cache
end

Instance Method Details

#_generate_uriObject

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


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

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
    home_dir = `echo ${HOME}`.chomp
    uri << "\&keyfile=#{home_dir}/.ssh/"+@id_ssh_key_file
  end
  # set path to libvirt socket
  uri << "\&socket="+@socket if @socket
  return uri
end

#_get_device(disks) ⇒ Object


113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/vagrant-libvirt/config.rb', line 113

def _get_device(disks)
  disks = [] if disks == UNSET_VALUE
  # 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

#finalize!Object


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

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

  # 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
  @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_port != '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

  # Storage
  @disks = [] if @disks == UNSET_VALUE
end

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

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


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

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

  #puts "storage(#{storage_type} --- #{options.to_s})"
  @disks = [] if @disks == UNSET_VALUE

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

  if storage_type == :file
    @disks << disk	# append
  end
end

#validate(machine) ⇒ Object


245
246
247
248
249
250
251
252
253
254
255
# File 'lib/vagrant-libvirt/config.rb', line 245

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