tree: 534707b6bb3a948900202fef688fab1235ebfb3a [path history] [tgz]
  1. README.md
  2. bnd.bnd
  3. pom.xml
  4. src/
vagrant/README.md

Vagrant provider for jclouds

Building

  • git clone https://github.com/jclouds/jclouds-labs
  • cd jclouds-labs/vagrant
  • mvn clean install
  • Copy target/vagrant-2.0.0-SNAPSHOT.jar to your classpath

Local caching proxy

Polipo

Use polipo for caching proxy. On OS X install with

brew install polipo

From SO:

  • Create a config file at ~/.polipo/config
# logLevel = 0xFF
dnsNameServer=8.8.8.8
diskCacheRoot = "~/.polipo/cache/"

  • As root create the file /Library/LaunchDaemons/fr.jussieu.pps.polipo.plist, replace $USER with your username:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>Disabled</key>
    <false/>
        <key>Label</key>
        <string>fr.jussieu.pps.polipo</string>
        <key>ProgramArguments</key>
        <array>
                <string>/usr/local/bin/polipo</string>
                <string>-c</string>
                <string>/Users/$USER/.polipo/config</string>
        </array>
        <key>RunAtLoad</key>
        <true/>
    <key>OnDemand</key>
    <false/>
    <key>UserName</key>
    <string>$USER</string>
    <key>GroupName</key>
    <string>daemon</string>
    <key>StandardOutPath</key>
    <string>/Users/$USER/.polipo/polipo.log</string>
    <key>StandardErrorPath</key>
    <string>/Users/$USER/.polipo/polipo.log</string>
</dict>
</plist>
  • sudo chown root:wheel /Library/LaunchDaemons/fr.jussieu.pps.polipo.plist
  • sudo chmod 755 /Library/LaunchDaemons/fr.jussieu.pps.polipo.plist
  • sudo launchctl load -w /Library/LaunchDaemons/fr.jussieu.pps.polipo.plist

Vagrant

  • vagrant plugin install vagrant-proxyconf
  • add to ~/.vagrant.d/Vagrantfile:
Vagrant.configure("2") do |config|
  if Vagrant.has_plugin?("vagrant-proxyconf")
    config.proxy.http     = "http://10.0.2.2:8123/"
    config.proxy.https    = "http://10.0.2.2:8123/"
    config.proxy.no_proxy = "localhost,127.0.0.1"
  end
end

Where 10.0.2.2 is the IP of your host as seen from the vagrant machines (in this case the NAT interface). Optionally could add all your private network IPs from your Vagrant subnet to no_proxy to skip the proxy for inter-VM communications.

Testing

vagrant box add ubuntu/xenial64
vagrant box add ubuntu/trusty64
# Refer to the "Windows boxes" section below on how to create the "boxcutter/eval-win7x86-enterprise" image (optional)
mvn clean install -Plive

Windows boxes

The easiest way to create a Windows Vagrant test image is using the boxcutter-windows packer templates.

brew install packer # or the corresponding alternative for your distribution
git clone https://github.com/boxcutter/windows.git boxcutter-windows
cd boxcutter-windows
make virtualbox/eval-win2012r2-standard
vagrant box add boxcutter/eval-win2012r2-standard ./box/virtualbox/eval-win2012r2-standard-nocm-1.0.4.box

Vagrant providers

jclouds supports the virtualbox an libvirt providers out of the box. To use additional providers users need to let jclouds know how to configure them. For example how to turn configuration like number of cpus or amount of memory to the provider specific configuration. Additional configuration might be needed as well. This is not required, but not providing it will lead to VMs which ignore configuration passed in from jclouds.

To let jclouds configure additional providers create a Ruby file in ~/.jclouds/vagrant/providers. In the file register a block to do the configuration, by calling into CustomProviders.register. The block will be passed two arguments - config which is the Vagrant provided machine config and machine_config which is the configuration coming from jclouds. Here's an example file for libvirt.

CustomProviders.register do |config, machine_config|
  config.vm.provider "libvirt" do |v|
    v.memory = machine_config["memory"] if machine_config.key?("memory")
    v.cpus = machine_config["cpus"] if machine_config.key?("cpus")
  end
end

jclouds selects the provider to use based on the selected box. Each box lists the provider it's been created for. The current implementation supports just a single provider per box name.

Cleaning up

Sometimes users (or tests) do not stop correctly the machines so they need to be destroyed manually periodically. All machines live in ~/.jclouds/vagrant. Create cleanup.sh in the folder and execute it to destroy machines created by the provider:

for node in `find ~/.jclouds/vagrant -name Vagrantfile | xargs -n1 dirname`; do
  pushd $node > /dev/null
  echo Destroying $node
  vagrant destroy --force
  popd> /dev/null
  rm -rf $machine
done

Same as a one-liner

for f in `find ~/.jclouds/vagrant/tests -name Vagrantfile | xargs -n1 dirname`; do pushd $f; vagrant destroy --force; popd; rm -rf $f; done

Limitations

  • Machines are created sequentially, no support for parallel execution from virtualbox provider