vagrant-bhyve 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 834cbbeb31e90df1fd8c9249f2c32873804857e1
+  data.tar.gz: 947fe959a6ba8fd5727adb5d9e6e7862f6468151
+SHA512:
+  metadata.gz: 1ba2aab48080e9e3f7049927fb6559718c8c1521ecfd63df1dfd2d9a329ca7ed420af31cc69109598dfaef941bad172039d8d21c72f32819c67f576948ff8fb5
+  data.tar.gz: 158a4f95c3878b63ba6040ee8f3d8959644c6389a8aa8b9b8cc48cb0ac9ed6aa8decc8d894a923ee172685f15f70e6447faeb82c5b21f2541f33e874863c8e66

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/svn-commit.tmp
+/vendor/
+/example_box/*img
+/example_box/*raw
+/bin/
+/Vagrantfile
+/.vagrant

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'vagrant', :git => 'https://github.com/mitchellh/vagrant.git', tag: 'v1.8.4'
+end
+
+group :plugins do
+  gem 'vagrant-bhyve', path: '.'
+  #gem 'vagrant-sshfs', '1.1.0'
+  #gem 'vagrant-mutate', :git => 'https://github.com/swills/vagrant-mutate'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tong Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# vagrant-bhyve
+
+This is a Vagrant plugin which enable FreeBSD's hypervisor bhyve as its backend.
+
+- [Status](#status)
+  - [Functions](#functions)
+  - [Boxes](#boxes)
+- [Test](#test)
+  - [Setup environment](#setup-environment)
+  - [Create a box](#create-a-box)
+  - [Add the box](#add-the-box)
+  - [Run the box](#run-the-box)
+  - [SSH into the box](#ssh-into-the-box)
+  - [Shutdown the box and cleanup](#shutdown-the-box-and-cleanup)
+
+## Status
+
+### Functions
+
+| Function            | Status
+| :----------         | :-----
+| Box format          | Defined
+| Check bhyve support | Working
+| Cloning	      | Working(needs gcp package to copy image)
+| Booting(BIOS)	      | Working
+| Network             | Working(needs pf and dnsmasq to provider NAT and DHCP)
+| SSH/SSH run         | Working(SSH run may needs bash)
+| Graceful shutdown   | Working
+| ACPI shutdown       | Working
+| Destroying          | Working
+| Provision           | Working
+| File sharing        | Working(NFS and vagrant-sshfs, maybe switch to VirtFS in the future)
+| Booting(UEFI)	      | Not working
+| Port forwarding     | Not working
+| Suspend             | Not supported by bhyve yet
+| Resume              | Not supported by bhyve yet
+
+### Boxes
+
+Collecting status of boxes from [Atlas](https://atlas.hashicorp.com/boxes/search) other than those provided by [FreeBSD](https://atlas.hashicorp.com/freebsd)
+
+| Function										| Status
+| :---------------------------------------------------------------------------------	| :------
+| [ubuntu/trusty64](https://atlas.hashicorp.com/ubuntu/boxes/trusty64)			| Working
+| [laravel/homestead](https://atlas.hashicorp.com/laravel/boxes/homestead)		| Untested
+| [hashicorp/precise64](https://atlas.hashicorp.com/hashicorp/boxes/precise64)		| Untested 	
+| [hashicorp/precise32](https://atlas.hashicorp.com/hashicorp/boxes/precise32)		| Untested 	
+| [centos/7](https://atlas.hashicorp.com/centos/boxes/7)				| Working 	
+| [puphpet/ubuntu1404-x64](https://atlas.hashicorp.com/puphpet/boxes/ubuntu1404-x64)	| Untested 	
+| [ubuntu/trusty32](https://atlas.hashicorp.com/ubuntu/boxes/trusty32)			| Untested 	
+| [puphpet/debian75-x64](https://atlas.hashicorp.com/puphpet/boxes/debian75-x64)	| Untested 	
+| [debian/jessie64](https://atlas.hashicorp.com/debian/boxes/jessie64)			| Working 	
+| [scotch/box](https://atlas.hashicorp.com/scotch/boxes/box)				| Untested 	
+| [centos/6](https://atlas.hashicorp.com/centos/boxes/6)				| Working 	
+
+## Test
+
+### Setup environment
+
+    $ git clone https://github.com/jesa7955/vagrant-bhyve.git
+    $ cd vagrant-bhyve
+    $ bundle install --path vendor/bundle --binstubs
+
+Note we will need package coreutils and dnsmasq(and of course we will need grub-bhyve to boot Linux box), vagrant-bhyve will try to install them with pkg.
+
+### Create a box
+
+Thanks to [Steve Wills](https://github.com/swills)'s work, now you can convert a VirtualBox box to a bhyve one with [vagrant-mutate](https://github.com/sciurus/vagrant-mutate).
+
+### Run the box
+
+After a box is created, you should create another Vagrantfile.
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "boxname"
+end
+```
+
+then execute this command to start the box with bhyve
+
+    $ /path/to/vagrant-bhyve/bin/vagrant up --provider=bhyve
+
+### SSH into the box
+
+After the box is booted(uped), you can ssh into by executing this command. Note that you will have to use password to authorize for now.
+
+    $ /path/to/vagrant-bhyve/bin/vagrant ssh
+
+### Shutdown the box and cleanup
+
+This command will shutdown the booted VM and clean up environment
+
+    $ /path/to/vagrant-bhyve/bin/vagrant halt
+
+### Destroy the box
+
+    $ /path/to/vagrant-bhyve/vagrant destroy
+
+## Installation
+
+## Usage
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jesa7955/vagrant-bhyve.
+
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Vagrantfiles/Vagrantfile_CentOS-6

@@ -0,0 +1,14 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :bhyve do |vm|
+    vm.grub_config_file = %{
+    linux (hd0,msdos1)/vmlinuz-2.6.32-642.1.1.el6.x86_64 root=/dev/mapper/VolGroup00-LogVol00
+    initrd (hd0,msdos1)/initramfs-2.6.32-642.1.1.el6.x86_64.img 
+    boot
+    }
+    vm.memory = "512M"
+    vm.cpus = "1"
+  end
+end

data/Vagrantfiles/Vagrantfile_CentOS-7

@@ -0,0 +1,11 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :bhyve do |vm|
+    vm.grub_run_partition = "msdos2"
+    vm.grub_run_dir = "/grub2"
+    vm.memory = "512M"
+    vm.cpus = "1"
+  end
+end

data/Vagrantfiles/Vagrantfile_Debian_Ubuntu

@@ -0,0 +1,11 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :bhyve do |vm|
+    vm.grub_run_partition = "msdos1"
+    vm.memory = "512M"
+    vm.cpus = "1"
+  end
+end
+

data/example_box/README.md

@@ -0,0 +1,46 @@
+# Vagrant Bhyve Example Box
+
+Box format of bhyve provider is a plain directory consist of `Vagrantfile`, `metadata.json`, bhyve disk file, and an optional `uefi.fd`
+
+```
+|
+|- Vagrantfile      This is where Bhyve is configured.
+|- disk.img         The disk image including basic OS.
+|- metadata.json    Box metadata.
+`- uefi.fd          UEFI firmware (only for guests who use uefi as firmware).
+```
+
+Available configurations for the provider are:
+
+* `memory`: Amount of memory, e.g. `512M`
+* `cpus`: Number of CPUs, e.g. `1`
+* `disks`: An array of disks which users want to attach to the guest other than the box shipped one. Each disk is described by a hash which has three members.
+	* **path/name**: path is used to specify a image file outside .vagrant direcotory while name is used to specify an image file name which will be created inside .vagrant directory for the box. Only one of these two arguments is needed to describe an additional disk file.
+	* **size**: specify the image file's virutal size.
+	* **format**: specify the format of disk image file. Bhyve only support raw images now but maybe we can extend vagrant-bhyve when bhyve supports more.
+* `cdroms`: Like `disks`, this is an array contains all ISO files which users want to attach to bhyve. Now, each cdrom is described by a hash contains only the path to a ISO file.
+* ~~`grub_config_file`:~~
+* ~~`grub_run_partition`:~~
+:* ~~`grub_run_dir`:~~
+
+Put everything we need in a directory and run the command below to package them as a box file.
+```
+$ tar cvzf test.box ./metadata.json ./Vagrantfile ./disk.img
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for Bhyve. These defaults can easily be overwritten by higher-level
+Vagrantfiles (such as project root Vagrantfiles).
+
+## Box Metadata
+
+Bhyve box should define at least two data fields in `metadata.json` file.
+
+* provider - Provider name is bhyve.
+
+## Converting Boxes
+
+Instead of creating a box from scratch, you can use
+[vagrant-mutate](https://github.com/sciurus/vagrant-mutate)
+to take boxes created for other Vagrant providers and use them
+with vagrant-bhyve

data/example_box/Vagrantfile

@@ -0,0 +1,9 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.vm.provider :bhyve do |vm|
+    vm.memory = "512M"
+    vm.cpus = "1"
+  end
+end

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider"     : "bhyve"
+}

data/lib/vagrant-bhyve.rb

@@ -0,0 +1,21 @@
+require "pathname"
+
+module VagrantPlugins
+  module ProviderBhyve
+    lib_path = Pathname.new(File.expand_path("../vagrant-bhyve", __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Executor, lib_path.join('executor')
+    autoload :Driver, lib_path.join('driver')
+    autoload :Errors, lib_path.join('errors')
+
+
+    # This function returns the path to the source of this plugin
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end
+
+require "vagrant-bhyve/plugin"

data/lib/vagrant-bhyve/action.rb

@@ -0,0 +1,215 @@
+require "pathname"
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module ProviderBhyve
+    module Action
+      include Vagrant::Action::Builtin
+
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :Boot, action_root.join('boot')
+      autoload :CreateBridge, action_root.join('create_bridge')
+      autoload :CreateTap, action_root.join('create_tap')
+      autoload :Cleanup, action_root.join('cleanup')
+      autoload :Destroy, action_root.join('destroy')
+      autoload :ForwardPorts, action_root.join('forward_ports')
+      autoload :Import, action_root.join('import')
+      autoload :Load, action_root.join('load')
+      autoload :PrepareNFSSettings, action_root.join('prepare_nfs_settings')
+      autoload :PrepareNFSValidIds, action_root.join('prepare_nfs_valid_ids')
+      autoload :Setup, action_root.join('setup')
+      autoload :Shutdown, action_root.join('shutdown')
+      autoload :WaitUntilUP, action_root.join('wait_until_up')
+
+      def self.action_boot
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use CreateBridge
+	  b.use CreateTap
+	  b.use Load
+	  b.use Boot
+	  b.use Call, WaitUntilUP do |env, b1|
+	    if env[:uncleaned]
+	      b1.use action_reload
+	    else
+	      b1.use ForwardPorts
+	    end
+	  end
+	  b.use PrepareNFSValidIds
+	  b.use SyncedFolderCleanup
+	  b.use SyncedFolders
+	  b.use PrepareNFSSettings
+	end
+      end
+
+      def self.action_halt
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, :running do |env, b1|
+	    if env[:result]
+	      b1.use Call, GracefulHalt, :uncleaned, :running do |env1, b2|
+	        if !env1[:result]
+		  b3.use Shutdown
+	        end
+	      end
+	    end
+	  end
+	  b.use Call, IsState, :uncleaned do |env, b1|
+	    if env[:result]
+	      b1.use Cleanup
+	    end
+	  end
+	end
+      end
+
+      def self.action_reload
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use Message, I18n.t('vagrant_bhyve.action.vm.reload.reloading')
+	  b.use Call, IsState, Vagrant::MachineState::NOT_CREATED_ID do |env, b1|
+	    if env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_created')
+	      next
+	    end
+	    b1.use Call, IsState, :stopped do |env1, b2|
+	      if !env1[:result]
+		b2.use action_halt
+	      end
+	    end
+	    b1.use ConfigValidate
+	    b1.use action_start
+	  end
+	end
+      end
+
+      def self.action_ssh
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, :running do |env, b1|
+	    if !env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_running')
+	      next
+	    end
+	    b1.use SSHExec
+	  end
+	end
+      end
+
+      def self.action_ssh_run
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, :running do |env, b1|
+	    if !env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_running')
+	      next
+	    end
+	    b1.use SSHRun
+	  end
+	end
+      end
+
+      def self.action_start
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, :running do |env, b1|
+	    if env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_already_running')
+	      next
+	    end
+	    b1.use Call, IsState, :uncleaned do |env1, b2|
+	      if env1[:result]
+		b2.use Cleanup
+	      end
+	    end
+	    b1.use Setup
+	    b1.use action_boot
+	  end
+	end
+      end
+
+      def self.action_up
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use Call, IsState, Vagrant::MachineState::NOT_CREATED_ID do |env, b1|
+	    if env[:result]
+	      b1.use HandleBox
+	    end
+	  end
+
+	  b.use ConfigValidate
+	  b.use Call, IsState, Vagrant::MachineState::NOT_CREATED_ID do |env,b1|
+	    if env[:result]
+	      b1.use Import
+	      b1.use Provision
+	    end
+	  end
+	  b.use action_start
+	end
+      end
+
+      def self.action_destroy
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, Vagrant::MachineState::NOT_CREATED_ID do |env, b1|
+	    if env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_created')
+	      next
+	    end
+
+	    b1.use Call, DestroyConfirm do |env1, b2|
+	      if !env1[:result]
+		b2.use Message, I18n.t(
+		  'vagrant.commands.destroy.will_not_destroy',
+		  name: env1[:machine].name)
+		next
+	      end
+	      b2.use Call, IsState, :running do |env2, b3|
+		if env2[:result]
+		  b3.use action_halt
+		end
+	      end
+	      b2.use Call, IsState, :uncleaned do |env2, b3|
+		if env2[:result]
+		  b3.use Cleanup
+		end
+	      end
+	      b2.use Destroy
+	      b2.use ProvisionerCleanup
+	      b2.use PrepareNFSValidIds
+	      b2.use SyncedFolderCleanup
+	    end
+	  end
+	end
+      end
+
+      def self.action_provision
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use ConfigValidate
+	  b.use Call, IsState, Vagrant::MachineState::NOT_CREATED_ID do |env,b1|
+	    if env[:result]
+	      b1.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_created')
+	      next
+	    end
+	    b1.use Call, IsState, :running do |env1, b2|
+	      if !env1[:result]
+		b2.use Message, I18n.t('vagrant_bhyve.commands.common.vm_not_running')
+		next
+	      end
+	      b2.use Provision
+	    end
+	  end
+	end
+      end
+
+      def self.action_suspend
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use Warn, I18n.t('vagrant_bhyve.actions.vm.suspend.not_supported')
+	end
+      end
+
+      def self.action_resume
+	Vagrant::Action::Builder.new.tap do |b|
+	  b.use Warn, I18n.t('vagrant_bhyve.actions.vm.resume.not_supported')
+	end
+      end
+
+    end
+  end
+end