vagrant-libvirt: Cannot install on OS X because of ruby-libvirt

This actually works. vagrant on macOS, libvirt on Ubuntu 17.04

macOS Sierra 10.12.6 Vagrant 2.0.0

1. Install Homebrew

2. Install necessary Homebrew recipes.

   brew install libiconv gcc libvirt
   

3. Find the version of ruby used by your version of vagrant. Mine was 2.3.4

   /opt/vagrant/embedded/bin/ruby --version
   

4. Install the vagrant plugin.

   CONFIGURE_ARGS='with-ldflags=-L/opt/vagrant/embedded/lib with-libvirt-include=/usr/local/include/libvirt with-libvirt-lib=/usr/local/lib' \
   GEM_HOME=~/.vagrant.d/gems/2.3.4 \
   GEM_PATH=$GEM_HOME:/opt/vagrant/embedded/gems \
   PATH=/opt/vagrant/embedded/bin:$PATH \
   vagrant plugin install vagrant-libvirt
   

Remote Host: Ubuntu 17.04 (zesty) @ 192.168.15.127 libvirt-daemon 2.5.0-3ubuntu5.5

This Vagrantfile will start a debian/jessie64 box on the host at 192.168.15.127. TCP:4242 on your local machine will be forwarded to the box.

Example Vagrantfile:

Vagrant.configure("2") do |config|
  config.vm.box = "debian/jessie64"
  config.vm.provider :libvirt do |libvirt|
    libvirt.host = "192.168.15.127"
    libvirt.connect_via_ssh = true
  end
  config.vm.network "forwarded_port", guest: 4242, host: 4242, host_ip: "127.0.0.1"
  config.vm.synced_folder ".", "/vagrant", disabled: true
end

Travis and Azure DevOps both provide free builders for MacOS, quite useful for testing and assuring that the plugin is at least builable and instalable.

I can confirm that adding the mentioned environment variables allows me to install the plugin, which means that the build code needs to be updated to avoid the need for them.

vagrant version                                                                                                                                                                                                               Installed Version: 2.2.4
Latest Version: 2.2.4

CONFIGURE_ARGS='with-ldflags=-L/opt/vagrant/embedded/lib with-libvirt-include=/usr/local/include/libvirt with-libvirt-lib=/usr/local/lib' GEM_HOME=~/.vagrant.d/gems/2.4.4 GEM_PATH=$GEM_HOME:/opt/vagrant/embedded/gems PATH=/opt/vagrant/embedded/bin:$PATH vagrant plugin install vagrant-libvirt
Installing the 'vagrant-libvirt' plugin. This can take a few minutes...
Building native extensions.  This could take a while...
Fetching: fog-libvirt-0.6.0.gem (100%)
Fetching: vagrant-libvirt-0.0.45.gem (100%)
Installed the plugin 'vagrant-libvirt (0.0.45)'!

PS. If any maintainer needs access to a macos shell, please ping me on private and I will create an account for you on my box.

Few things said in this thread are a little confusing

• should CONFIGURE_ARGS have flags with double-dash or without?
  • turns out both styles work (with-libvirt-lib= is same as --with-libvirt-lib=)
• is with-ldflags=-L/opt/vagrant/embedded/lib actually needed?
  • turns out it is not needed (at least with vagrant 2.2.7 and ruby-libvirt 0.7.1)
• some folks mentioned NOKOGIRI_USE_SYSTEM_LIBRARIES=true
  • this didn’t make any difference (at least with vagrant 2.2.7 and nokogiri 1.10.9)
• it’s not clear if libiconv is actually needed or not

However, key details that are more critical are these:

• above everyone seem so use with-libvirt-include=${prefix}/include/libvirt
  • that doesn’t work because the C code has #include <libvirt/libvirt.h>, so this will have to be with-libvirt-include=${prefix}/include (note: it’s not the subdirectory)

Here is what worked for me:

brew cask install vagrant && brew install libvirt
env CONFIGURE_ARGS="with-libvirt-lib=$(brew --prefix libvirt)/lib with-libvirt-include=$(brew --prefix libvirt)/include" vagrant plugin install vagrant-libvirt

</details>

For those finding this thread… the tail continues by installing virt-manager using this repo: https://github.com/jeffreywildman/homebrew-virt-manager/

Once that’s done with brew you should start the daemon with virt-manager -c qemu+ssh://@/system?socket=/var/run/libvirt/libvirt-sock.

Maybe troubleshoot: brew install py2cairo.

Good luck!

ccosby’s steps worked for me, i think i am past the ruby error however i get:

Error while connecting to libvirt: Error making a connection to libvirt URI qemu+ssh://192.168.15.127/system?no_verify=1&keyfile=/Users/myuser/.ssh/id_rsa&socket=/var/run/libvirt/libvirt-sock: Call to virConnectOpen failed: internal error: received hangup event on socket

As a easier workaround:

CFLAGS="-DHAVE_VIRDOMAINQEMUMONITORCOMMAND" vagrant plugin install vagrant-libvirt

Howevr I didn’t manage to start a VM on OSX anyway

I got it working with the following:

brew install ruby ruby-build rbenv libiconv gcc
export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
vagrant plugin install vagrant-libvirt

Turns out there is a brew package available, for those who use homebrew.

brew install libvirt

I managed to work around this issue on my Linux by following this guide: https://wiki.archlinux.org/index.php/Vagrant#vagrant-libvirt

I hope someone with knowledge of how plugins installation works could patch the code to enable these parameters for MacOS by default. We had at least 3 people confirming the fix and none saying that it would not work.

@ssbarnea I think someone with a Mac to test and verify the exact steps required, I don’t use Mac’s myself, not sure if any of the other maintainers have access to one

Did you port the patches manually to your ruby-libvirt 0.6.0 source tree? The repository from @kontrafiktion is ruby-libvirt 0.5.2, so to install 0.6.0 you need to port the following changes manually: https://github.com/kontrafiktion/ruby-libvirt/compare/bug-1161338 and https://github.com/kontrafiktion/ruby-libvirt/commit/3f768dc492353a143b45c08180fcd690885c2b09 (OSX specific).

You should also make sure that you are installing the local gem and not installing from source the remote one. Instead of

/opt/vagrant/embedded/bin/gem install -i ~/.vagrant.d/gems/ ruby-libvirt

you should try:

/opt/vagrant/embedded/bin/gem install -i ~/.vagrant.d/gems/ --local pkg/ruby-libvirt-0.6.0.gem

(after you did /opt/vagrant/embedded/bin/rake package of course).

I am running ruby-libvirt 0.6.0 on OS X El Capitan (10.11.3) without an issue.

// Added missing patch.

On High Sierra - 10.13.6

$ vagrant version
Installed Version: 2.1.5
Latest Version: 2.1.5

You're running an up-to-date version of Vagrant!

Fails though:

$ vagrant up
Bringing machine 'default' up with 'libvirt' provider...
Error while connecting to libvirt: Error making a connection to libvirt URI qemu+ssh://192.168.15.127/system?no_verify=1&keyfile=/Users/smingolelli/.ssh/id_rsa&socket=/var/run/libvirt/libvirt-sock:
Call to virConnectOpen failed: internal error: received hangup event on socket

Plugin was built like so:

$ CONFIGURE_ARGS='with-ldflags=-L/opt/vagrant/embedded/lib with-libvirt-include=/usr/local/include/libvirt with-libvirt-lib=/usr/local/lib' GEM_HOME=~/.vagrant.d/gems/2.4.4 GEM_PATH=$GEM_HOME:/opt/vagrant/embedded/gems PATH=/opt/vagrant/embedded/bin:$PATH vagrant plugin install vagrant-libvirt

@mcandre

I can confirm that it doesn’t work on High Sierra + Vagrant 2.0.1 with the same error that you posted. Still works on High Sierra 10.13.1 + Vagrant 2.0.0. I’ll investigate more and see what I find.

Look through https://github.com/hashicorp/vagrant/blob/master/CHANGELOG.md and see if there’s anything you absolutely need from there. If not, 2.0.0 is still available for download.

Same issue with vagrant-libvirt on Mac OSX El Capitan 10.11.6

$ git branch

• (HEAD detached at origin/bug-1161338)

/opt/vagrant/embedded/include/ruby-2.2.0/ruby/backward/st.h:2:2: warning: use “ruby/st.h” instead of bare “st.h” [-W#warnings] #warning use “ruby/st.h” instead of bare “st.h”

here is the full log --> http://pastebin.ca/3760772

Please retest this against current master which updates fog-libvirt and ruby-libvirt.

You can git clone the repo and do a gem build vagrant-libvirt.gemspec which generates a .gem that can be installed with vagrant plugin install /path/to/gem

Sigh