Class: VagrantPlugins::ProviderLibvirt::Action::SetBootOrder

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

Overview

boot order useful for pxe in discovery workflow

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ SetBootOrder

Returns a new instance of SetBootOrder.


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

def initialize(app, env)
  @app    = app
  @logger = Log4r::Logger.new('vagrant_libvirt::action::set_boot_order')
  config = env[:machine].provider_config
  @boot_order = config.boot_order
end

Instance Method Details

#call(env) ⇒ Object


16
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
# File 'lib/vagrant-libvirt/action/set_boot_order.rb', line 16

def call(env)
  # Get domain first
  begin
    domain = env[:machine].provider
                          .driver
                          .connection
                          .client
                          .lookup_domain_by_uuid(
                            env[:machine].id.to_s
                          )
  rescue => e
    raise Errors::NoDomainError,
          error_message: e.message
  end

  # Only execute specific boot ordering if this is defined
  # in the Vagrant file
  if @boot_order.count >= 1

    # If a domain is initially defined with no box or disk or
    # with an explicit boot order, Libvirt adds <boot dev="foo">
    # This conflicts with an explicit boot_order configuration,
    # so we need to remove it from the domain xml and feed it back.
    # Also see https://bugzilla.redhat.com/show_bug.cgi?id=1248514
    # as to why we have to do this after all devices have been defined.
    xml = Nokogiri::XML(domain.xml_desc)
    xml.search('/domain/os/boot').each(&:remove)

    # Parse the XML and find each defined drive and network interfacee
    hd = xml.search("/domain/devices/disk[@device='disk']")
    cdrom = xml.search("/domain/devices/disk[@device='cdrom']")
    # implemented only for 1 network
    nets = @boot_order.flat_map do |x|
      x.class == Hash ? x : nil
    end.compact
    raise 'Defined only for 1 network for boot' if nets.size > 1
    network = search_network(nets, xml)

    # Generate an array per device group and a flattened
    # array from all of those
    devices = { 'hd' => hd,
                'cdrom' => cdrom,
                'network' => network }

    final_boot_order = final_boot_order(@boot_order, devices)
    # Loop over the entire defined boot order array and
    # create boot order entries in the domain XML
    final_boot_order.each_with_index do |node, index|
      boot = "<boot order='#{index + 1}'/>"
      node.add_child(boot)
      logger_msg(node, index)
    end

    # Finally redefine the domain XML through Libvirt
    # to apply the boot ordering
    env[:machine].provider
                 .driver
                 .connection
                 .client
                 .define_domain_xml(xml.to_s)
  end

  @app.call(env)
end

#final_boot_order(boot_order, devices) ⇒ Object


81
82
83
84
85
# File 'lib/vagrant-libvirt/action/set_boot_order.rb', line 81

def final_boot_order(boot_order, devices)
  boot_order.flat_map do |category|
    devices[category.class == Hash ? category.keys.first : category]
  end
end

#logger_msg(node, index) ⇒ Object


98
99
100
101
102
103
104
105
# File 'lib/vagrant-libvirt/action/set_boot_order.rb', line 98

def logger_msg(node, index)
  name = if node.name == 'disk'
           node['device']
         elsif node.name == 'interface'
           node.name
         end
  @logger.debug "Setting #{name} to boot index #{index + 1}"
end

#search_network(nets, xml) ⇒ Object


87
88
89
90
91
92
93
94
95
96
# File 'lib/vagrant-libvirt/action/set_boot_order.rb', line 87

def search_network(nets, xml)
  str = '/domain/devices/interface'
  str += "[(@type='network' or @type='udp' or @type='bridge')"
  unless nets.empty?
    str += " and source[@network='#{nets.first['network']}']"
  end
  str += ']'
  @logger.debug(str)
  xml.search(str)
end