fog-libvirt 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8a924f47a387da6a04d3f10ca5528ad6df73153b
-  data.tar.gz: 9f578e6cfe50d4994a610e2b427e819d633d76ba
+SHA256:
+  metadata.gz: 6c5d75c89309efc19a2a8e70db7f95dc754fe127358089bd8ebe0cd0f2ecf896
+  data.tar.gz: 2270fa713728f8824dffc45dca9344c1b244feeb3add91130d26fff493c00f18
 SHA512:
-  metadata.gz: 66e744dc9c9b7e0072b9f5c10912f0626e7355d3c1bacf2dad20a102033dc62213fd5bc9237ea66ac38d48115bc7bfa183043d59bff2f1faffa66a804e683c95
-  data.tar.gz: e2f735103f4af3889a9679f6ba5c8bf578e5ba2966c8bcb9a902996232bee239631d433092fa90ee88073e08af29902c54f18875ec0334a4c0552212108617e5
+  metadata.gz: 1834c04363667e8bb7632055010f7544ec72aec0f49254e8c708bc1b73c0d731aa6474acd01644de9fa35d43491bfd5d7e60d3a6636d6301ba2446f6470b80cd
+  data.tar.gz: f6834023432a36058571b78e8c1b8f5ec5a5043990d8f738cbf7c986a9038a8a723415214fa702bc7ad09c83fbd119b961ea4ee5c0bc6ebd328b0ab744f12158

data/README.md

@@ -2,7 +2,7 @@
 
 fog-libvirt is a libvirt provider for [fog](https://github.com/fog/fog).
 
-[![Build Status](https://secure.travis-ci.org/fog/fog.png?branch=master)](http://travis-ci.org/fog/fog-libvirt)
+[![Build Status](https://github.com/fog/fog-libvirt/actions/workflows/ruby.yml/badge.svg)](https://github.com/fog/fog-libvirt/actions/workflows/ruby.yml)
 [![Dependency Status](https://gemnasium.com/fog/fog.png)](https://gemnasium.com/fog/fog-libvirt)
 [![Code Climate](https://codeclimate.com/github/fog/fog.png)](https://codeclimate.com/github/fog/fog-libvirt)
 [![Gem Version](https://fury-badge.herokuapp.com/rb/fog.png)](http://badge.fury.io/rb/fog-libvirt)

data/fog-libvirt.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.md]
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.5.0'
 
-  s.add_dependency("fog-core", "~> 1.27", ">= 1.27.4")
+  s.add_dependency("fog-core", ">= 1.27.4")
   s.add_dependency("fog-json")
   s.add_dependency("fog-xml", "~> 0.1.1")
   s.add_dependency('ruby-libvirt','>= 0.7.0')
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("shindo", "~> 0.3.4")
   s.add_development_dependency("simplecov")
   s.add_development_dependency("yard")
-  s.add_development_dependency("mocha", "~> 1.1.0")
+  s.add_development_dependency("mocha", "~> 1.13.0")
 
   # Let's not ship dot files and gemfiles
   git_files = `git ls-files`.split("\n")

data/lib/fog/bin/libvirt.rb

@@ -3,7 +3,7 @@ module Libvirt # deviates from other bin stuff to accommodate gem
     def class_for(key)
       case key
       when :compute
-        Fog::Compute::Libvirt
+        Fog::Libvirt::Compute
       else
         raise ArgumentError, "Unrecognized service: #{key}"
       end

data/lib/fog/libvirt.rb

@@ -9,9 +9,7 @@ module Fog
   module Libvirt
     extend Fog::Provider
 
-    module Compute
-      autoload :Libvirt, File.expand_path('../libvirt/compute', __FILE__)
-    end
+    autoload :Compute, File.expand_path('../libvirt/compute', __FILE__)
 
     service(:compute, 'Compute')
   end

data/lib/fog/libvirt/compute.rb

@@ -2,8 +2,8 @@ require 'fog/libvirt/models/compute/util/util'
 require 'fog/libvirt/models/compute/util/uri'
 
 module Fog
-  module Compute
-    class Libvirt < Fog::Service
+  module Libvirt
+    class Compute < Fog::Service
       requires   :libvirt_uri
       recognizes :libvirt_username, :libvirt_password
       recognizes :libvirt_ip_command
@@ -44,11 +44,12 @@ module Fog
       request :list_interfaces
       request :destroy_interface
       request :get_node_info
+      request :update_autostart
       request :update_display
       request :libversion
 
       module Shared
-        include Fog::Compute::LibvirtUtil
+        include Fog::Libvirt::Util
       end
 
       class Mock
@@ -78,7 +79,7 @@ module Fog
         attr_reader :ip_command
 
         def initialize(options={})
-          @uri = ::Fog::Compute::LibvirtUtil::URI.new(enhance_uri(options[:libvirt_uri]))
+          @uri = ::Fog::Libvirt::Util::URI.new(enhance_uri(options[:libvirt_uri]))
           @ip_command = options[:libvirt_ip_command]
 
           # libvirt is part of the gem => ruby-libvirt
@@ -119,16 +120,16 @@ module Fog
           # on macosx, chances are we are using libvirt through homebrew
           # the client will default to a socket location based on it's own location (/opt)
           # we conveniently point it to /var/run/libvirt/libvirt-sock
-          # if no socket option has been specified explicitly
+          # if no socket option has been specified explicitly and
+          # if the socket exists
 
-          if RUBY_PLATFORM =~ /darwin/
+          socketpath="/var/run/libvirt/libvirt-sock"
+          if RUBY_PLATFORM =~ /darwin/ && File.exist?(socketpath)
             querystring=::URI.parse(uri).query
             if querystring.nil?
-              append="?socket=/var/run/libvirt/libvirt-sock"
-            else
-              if !::CGI.parse(querystring).key?("socket")
-                append="&socket=/var/run/libvirt/libvirt-sock"
-              end
+              append="?socket=#{socketpath}"
+            elsif !::CGI.parse(querystring).key?("socket")
+              append="&socket=#{socketpath}"
             end
           end
           uri+append

data/lib/fog/libvirt/models/compute/README.md

@@ -26,6 +26,22 @@ Only ssh is supported as the transport for remote URI's. TLS is NOT supported, a
 - To check the connection you need to override your libvirt socket location in the URI
   - "qemu+ssh://patrick@myserver/system?socket=/var/run/libvirt/libvirt-sock"
 
+## Ceph RBD volumes
+To configure Ceph RBD volumes, the file ``/etc/foreman/ceph.conf`` is used.
+After adding the authentication key to a libvirt secret, it can be configured as follows:
+```
+monitor=mon001.example.com,mon002.example.com,mon003.example.com
+port=6789
+libvirt_ceph_pool=rbd_pool_name
+auth_username=libvirt
+auth_uuid=uuid_of_libvirt_secret
+bus_type=virtio
+```
+For more recent versions of libvirt which support using the secret by name (`usage` attribute in the `secret` tag),
+you can also drop `auth_uuid` and specify `auth_usage` instead. If both are specified, `auth_uuid` will be preferred for maximum compatibility.
+
+The `bus_type` can be set to `virtio` or `scsi`. If it is ommited, the default is `scsi`.
+
 ## Configuration
 
 The URI can be configured in two ways:

data/lib/fog/libvirt/models/compute/interface.rb

@@ -1,8 +1,8 @@
 require 'fog/core/model'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Interface < Fog::Model
         identity :name
         attribute :mac

data/lib/fog/libvirt/models/compute/interfaces.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/interface'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Interfaces < Fog::Collection
-        model Fog::Compute::Libvirt::Interface
+        model Fog::Libvirt::Compute::Interface
 
         def all(filter={})
           load(service.list_interfaces(filter))

data/lib/fog/libvirt/models/compute/network.rb

@@ -2,10 +2,10 @@ require 'fog/core/model'
 require 'fog/libvirt/models/compute/util/util'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Network < Fog::Model
-        include Fog::Compute::LibvirtUtil
+        include Fog::Libvirt::Util
 
         identity :uuid
         attribute :name

data/lib/fog/libvirt/models/compute/networks.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/network'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Networks < Fog::Collection
-        model Fog::Compute::Libvirt::Network
+        model Fog::Libvirt::Compute::Network
 
         def all(filter={})
           load(service.list_networks(filter))

data/lib/fog/libvirt/models/compute/nic.rb

@@ -1,8 +1,8 @@
 require 'fog/core/model'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Nic < Fog::Model
         identity :mac
         attribute :id

data/lib/fog/libvirt/models/compute/nics.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/nic'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Nics < Fog::Collection
-        model Fog::Compute::Libvirt::Nic
+        model Fog::Libvirt::Compute::Nic
       end
     end
   end

data/lib/fog/libvirt/models/compute/node.rb

@@ -1,8 +1,8 @@
 require 'fog/core/model'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Node < Fog::Model
         identity :uuid
 

data/lib/fog/libvirt/models/compute/nodes.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/node'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Nodes < Fog::Collection
-        model Fog::Compute::Libvirt::Node
+        model Fog::Libvirt::Compute::Node
 
         def all(filter={ })
           load(service.get_node_info)

data/lib/fog/libvirt/models/compute/pool.rb

@@ -1,8 +1,8 @@
 require 'fog/core/model'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Pool < Fog::Model
         attr_reader :xml
 

data/lib/fog/libvirt/models/compute/pools.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/pool'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Pools < Fog::Collection
-        model Fog::Compute::Libvirt::Pool
+        model Fog::Libvirt::Compute::Pool
 
         def all(filter = {})
           load(service.list_pools(filter))

data/lib/fog/libvirt/models/compute/server.rb

@@ -3,10 +3,10 @@ require 'fog/libvirt/models/compute/util/util'
 require 'fileutils'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Server < Fog::Compute::Server
-        include Fog::Compute::LibvirtUtil
+        include Fog::Libvirt::Util
         attr_reader :xml
 
         identity :id, :aliases => 'uuid'
@@ -28,6 +28,9 @@ module Fog
         attribute :boot_order
         attribute :display
         attribute :cpu
+        attribute :hugepages
+        attribute :guest_agent
+        attribute :virtio_rng
 
         attribute :state
 
@@ -75,6 +78,10 @@ module Fog
           action_status
         end
 
+        def update_autostart(value)
+          service.update_autostart(uuid, value)
+        end
+
         def mac
           nics.first.mac if nics && nics.first
         end
@@ -129,9 +136,10 @@ module Fog
         end
 
         #alias methods
-        alias_method :halt,    :poweroff
-        alias_method :stop,    :shutdown
-        alias_method :active?, :active
+        alias_method :halt,       :poweroff
+        alias_method :stop,       :shutdown
+        alias_method :active?,    :active
+        alias_method :autostart?, :autostart
 
         def volumes
           # lazy loading of volumes
@@ -339,6 +347,9 @@ module Fog
           ip_address.chomp
         end
 
+        # Locale-friendly removal of non-alpha nums
+        DOMAIN_CLEANUP_REGEXP = Regexp.compile('[\W_-]')
+
         # This retrieves the ip address of the mac address using ip_command
         # It returns an array of public and private ip addresses
         # Currently only one ip address is returned, but in the future this could be multiple
@@ -352,7 +363,7 @@ module Fog
           ip_command_global=service_arg.ip_command.nil? ? 'grep $mac /var/log/arpwatch.log|sed -e "s/new station//"|sed -e "s/changed ethernet address//g" |sed -e "s/reused old ethernet //" |tail -1 |cut -d ":" -f 4-| cut -d " " -f 3' : service_arg.ip_command
           ip_command_local=options[:ip_command].nil? ? ip_command_global : options[:ip_command]
 
-          ip_command="mac=#{mac}; server_name=#{name}; "+ip_command_local
+          ip_command="mac=#{mac}; server_name=#{name.gsub(DOMAIN_CLEANUP_REGEXP, '_')}; "+ip_command_local
 
           ip_address=nil
 
@@ -471,13 +482,17 @@ module Fog
             :os_type                => "hvm",
             :arch                   => "x86_64",
             :domain_type            => "kvm",
+            :autostart              => false,
             :iso_dir                => default_iso_dir,
             :network_interface_type => "network",
             :network_nat_network    => "default",
             :network_bridge_name    => "br0",
             :boot_order             => %w[hd cdrom network],
             :display                => default_display,
-            :cpu                    => {}
+            :cpu                    => {},
+            :hugepages              => false,
+            :guest_agent            => true,
+            :virtio_rng             => {},
           }
         end
 

data/lib/fog/libvirt/models/compute/servers.rb

@@ -2,10 +2,10 @@ require 'fog/core/collection'
 require 'fog/libvirt/models/compute/server'
 
 module Fog
-  module Compute
-    class Libvirt
+  module Libvirt
+    class Compute
       class Servers < Fog::Collection
-        model Fog::Compute::Libvirt::Server
+        model Fog::Libvirt::Compute::Server
 
         def all(filter={})
           load(service.list_domains(filter))

data/lib/fog/libvirt/models/compute/templates/server.xml.erb

@@ -1,6 +1,11 @@
 <domain type='<%= domain_type %>'>
   <name><%= name %></name>
   <memory><%= memory_size %></memory>
+<% if hugepages -%>
+  <memoryBacking>
+    <hugepages/>
+  </memoryBacking>
+<% end -%>
   <vcpu><%= cpus %></vcpu>
   <os>
     <type arch='<%= arch %>'><%= os_type %></type>
@@ -32,13 +37,48 @@
 <% end -%>
   <clock offset='utc'/>
   <devices>
+<% args = {}
+   if File.file?('/etc/foreman/ceph.conf')
+     File.readlines('/etc/foreman/ceph.conf').each do |line|
+       pair = line.strip.split("=")
+       key = pair[0]
+       value = pair[1]
+       args[key] = value
+     end
+   end
+%>
 <% volumes.each do |vol| -%>
+  <% if File.file?('/etc/foreman/ceph.conf') && vol.pool_name.include?(args["libvirt_ceph_pool"]) %>
+    <disk type='network' device='disk'>
+      <driver name='qemu' type='<%= vol.format_type %>' cache='writeback' discard='unmap'/>
+      <source protocol='rbd' name='<%= vol.path %>'>
+      <% if args.key?("monitor") -%>
+        <% args["monitor"].split(",").each do |mon| %>
+        <host name='<%= mon %>' port='<%= args["port"] %>'/>
+        <% end %>
+      <% end %>
+      </source>
+      <auth username='<%= args["auth_username"] %>'>
+       <% if args.key?("auth_uuid") -%>
+        <secret type='ceph' uuid='<%= args["auth_uuid"] %>'/>
+       <% else -%>
+        <secret type='ceph' usage='<%= args["auth_usage"] %>'/>
+       <% end -%>
+      </auth>
+      <% if args['bus_type'] == 'virtio' %>
+        <target dev='vd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='virtio'/>
+      <% else %>
+        <target dev='sd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='scsi'/>
+      <% end %>
+    </disk>
+  <% else %>
     <disk type='file' device='disk'>
       <driver name='qemu' type='<%= vol.format_type %>'/>
       <source file='<%= vol.path %>'/>
       <%# we need to ensure a unique target dev -%>
       <target dev='vd<%= ('a'..'z').to_a[volumes.index(vol)] %>' bus='virtio'/>
     </disk>
+  <% end %>
 <% end -%>
 <% if iso_file -%>
     <disk type='file' device='cdrom'>
@@ -55,6 +95,28 @@
       <model type='<%= nic.model %>'/>
     </interface>
 <% end -%>
+<% if guest_agent -%>
+    <channel type='unix'>
+      <target type='virtio' name='org.qemu.guest_agent.0'/>
+    </channel>
+<% end -%>
+    <rng model='virtio'>
+<%
+  rng_backend_model = virtio_rng[:backend_model] ? virtio_rng[:backend_model] : 'random'
+-%>
+<% if virtio_rng[:backend_path] -%>
+      <backend model='<%= rng_backend_model %>'><%= virtio_rng[:backend_path] %></backend>
+<% else -%>
+      <backend model='<%= rng_backend_model %>'/>
+<% end -%>
+    </rng>
+<% if arch == "s390x" -%>
+    <controller type="scsi" index="0" model="virtio-scsi"/>
+    <console type="pty">
+      <target type="sclp"/>
+    </console>
+    <memballoon model="virtio"/>
+<% else -%>
     <serial type='pty'>
       <target port='0'/>
     </serial>
@@ -63,6 +125,7 @@
     </console>
     <input type='tablet' bus='usb'/>
     <input type='mouse' bus='ps2'/>
+<% end -%>
 <%
 display_type = display[:type]
 
@@ -82,9 +145,11 @@ unless display[:password].empty?
   display_password = "passwd='#{display[:password]}'"
 end
 -%>
+<% if arch != "s390x" -%>
     <graphics type='<%= display_type %>' port='<%= display_port %>' autoport='<%= autoport %>' <%= display_listen %> <%= display_password %> />
     <video>
       <model type='cirrus' vram='9216' heads='1'/>
     </video>
+<% end -%>
   </devices>
 </domain>