vagrant-vlan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f55078a75af1e44111a5c49ae7928b90facdc47b
+  data.tar.gz: d39d272e37cc3eed46f20aab035d7f3a30442eaa
+SHA512:
+  metadata.gz: 5cf39e099e129a6ffddaadaea73eca4d14cc0ea417ab3658913108b5cdf9b86ea0abe00489bd48d7192e377654e6e0fab1e871601445e7d668cf4c5438073de6
+  data.tar.gz: bc5148510aba3ff4c232bf499eb6ae9badfb5dc8b427e62c109e5bc9af328954ea6d5a89f91102012f58acc6291ef0f2644a25b22d1807be8d4925009c56de88

data/.gitignore

@@ -0,0 +1,21 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-host-route.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-vlan", path: "."
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Arctic Wolf Networks
+
+MIT License
+
+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,58 @@
+# Vagrant VLAN Plugin
+
+A plugin to configure a VLAN within a guest.
+
+The implementation relies on Vagrant's guest capabilities. Currently, the plugin
+supports only Debian-derived guests and in particular has been tested only on
+Ubuntu. However, contributions to add support for other guests are more than
+welcome.
+
+## Installation
+
+Use `vagrant plugin install`:
+
+    $ vagrant plugin install vagrant-vlan
+
+## Usage
+
+Setting up a VLAN is accomplished using the `config.vlan.add`
+gestures. The gesture takes similar parameters to `config.vm.network`, with
+some exceptions. Valid parameters are as follows:
+
+* `vlan`
+   The VLAN identifier. An integer in the range [1, 4094].
+* `parent`
+  The parent (or physical) interface to which the VLAN interface should attach.
+* `type`
+  Method of IP assignment. Valid values are "dhcp" and "static".
+* `ip`
+  Required if `type` is "static". The IP address to be assigned to the interface.
+* `netmask`
+  Required if `type` is "static". The netmask to use for the interface.
+
+The name of the interface will be constructed automatically using the format
+`parent`.`vlan`.
+
+Note that the VLAN plugin runs immediately after Vagrant network configuration,
+so `parent` can include interfaces configured using `config.vm.network`.
+
+### Example
+
+Create VLAN 5 on interface `eth0`, and assign it the static IP 10.0.1.2/24.
+The name of the VLAN interface will be `eth0.5`.
+
+```ruby
+config.vlan.add vlan: 5, parent: "eth0",
+                type: "static", ip: "10.0.1.2", netmask: "255.255.255.0"
+```
+
+The `config` object in the example is what was passed by Vagrant to the
+`config.vm.define` block.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+

data/lib/vagrant-vlan/action.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+  module VLAN
+    class Action
+      def initialize(app, env)
+        @app = app
+      end
+
+      def call(env)
+        vlans = env[:machine].config.vlan.vlans.map do |vlan|
+          normalize_config(vlan)
+        end
+
+        # Call subsequent middleware steps. We'll do our setup at the
+        # end
+        @app.call(env)
+        
+        if !vlans.empty?
+          env[:ui].output("Configuring VLANs...")
+          env[:machine].guest.capability(:configure_vlans, vlans)
+        end
+      end
+
+      def normalize_config(config)
+        return {
+          :type => "dhcp",
+          :auto_config => true,
+          :ip => nil,
+          :netmask => "255.255.255.0"
+        }.merge(config || {})
+      end
+    end
+  end
+end

data/lib/vagrant-vlan/config.rb

@@ -0,0 +1,38 @@
+require "vagrant"
+
+module VagrantPlugins
+  module VLAN
+    class Config < Vagrant.plugin(2, :config)
+      def initialize
+        @__vlans = []
+      end
+
+      def add(**options)
+        @__vlans << options.dup
+      end
+
+      def vlans
+        @__vlans
+      end
+
+      def merge(other)
+        super.tap do |result|
+          result.instance_variable_set(:@__vlans, @__vlans + other.vlans)
+        end
+      end
+
+      def validate(machine)
+        errors = _detected_errors || []
+
+        vlans.each do |vlan|
+          errors << "The VLAN interface name will be constructed automatically." if vlan.include? :interface
+          errors << "A VLAN id must be specified." if !vlan.include? :vlan
+          errors << "The VLAN id must be an integer in the range [1, 4094]." if !vlan[:vlan].is_a?(Integer) || !vlan[:vlan].between?(1, 4094)
+          errors << "A parent interface must be specified." if !vlan.include? :parent
+        end
+
+        { "vlan" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-vlan/debian/configure_vlans.rb

@@ -0,0 +1,69 @@
+require "set"
+require "tempfile"
+
+require "vagrant/util/template_renderer"
+
+module VagrantPlugins
+  module GuestDebian
+    module Cap
+      class ConfigureVLANs
+        include Vagrant::Util
+
+        # Heavily borrowed from VagrantPlugins::Debian::Cap::ConfigureNetworks.
+        def self.configure_vlans(machine, vlans)
+          machine.communicate.tap do |comm|
+            # Verify the kernel module is installed and loaded.
+            if !comm.test("lsmod | grep 8021q")
+              comm.sudo("apt-get install vlan")
+              comm.sudo("modprobe 8021q")
+            end
+
+            # First, remove any previous network modifications
+            # from the interface file.
+            comm.sudo("sed -e '/^#VAGRANT-VLAN-BEGIN/,/^#VAGRANT-VLAN-END/ d' /etc/network/interfaces > /tmp/vagrant-network-interfaces")
+            comm.sudo("su -c 'cat /tmp/vagrant-network-interfaces > /etc/network/interfaces'")
+            comm.sudo("rm /tmp/vagrant-network-interfaces")
+
+            # Accumulate the configurations to add to the interfaces file as
+            # well as what interfaces we're actually configuring since we use that
+            # later.
+            interfaces = Set.new
+            entries = []
+            vlans.each do |vlan|
+              vlan[:interface] = "#{vlan[:parent]}.#{vlan[:vlan]}" 
+              interfaces.add(vlan[:interface])
+              entry = TemplateRenderer.render(File.join(File.dirname(__FILE__), "vlan"),
+                                              :options => vlan)
+
+              entries << entry
+            end
+
+            # Perform the careful dance necessary to reconfigure
+            # the network interfaces
+            temp = Tempfile.new("vagrant")
+            temp.binmode
+            temp.write(entries.join("\n"))
+            temp.close
+
+            comm.upload(temp.path, "/tmp/vagrant-network-entry")
+
+            # Bring down all the interfaces we're reconfiguring. By bringing down
+            # each specifically, we avoid reconfiguring eth0 (the NAT interface) so
+            # SSH never dies.
+            interfaces.each do |interface|
+              comm.sudo("/sbin/ifdown #{interface} 2> /dev/null")
+            end
+
+            comm.sudo("cat /tmp/vagrant-network-entry >> /etc/network/interfaces")
+            comm.sudo("rm /tmp/vagrant-network-entry")
+
+            # Bring back up each network interface, reconfigured
+            interfaces.each do |interface|
+              comm.sudo("/sbin/ifup #{interface}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vlan/debian/guest.rb

@@ -0,0 +1,12 @@
+require "vagrant"
+
+module VagrantPlugins
+  module GuestDebian
+    class Plugin < Vagrant.plugin("2")
+      guest_capability("debian", "configure_vlans") do
+        require_relative "configure_vlans"
+        Cap::ConfigureVLANs
+      end
+    end
+  end
+end

data/lib/vagrant-vlan/debian/vlan.erb

@@ -0,0 +1,19 @@
+#VAGRANT-VLAN-BEGIN
+# The contents below are automatically generated by Vagrant. Do not modify.
+auto <%= options[:interface] %>
+iface <%= options[:interface] %> inet <%= options[:type] %>
+    vlan-raw-device <%= options[:parent] %>
+<%- if options[:type] == "static" -%>
+    address <%= options[:ip] %>
+    netmask <%= options[:netmask] %>
+<%- else %>
+  <%- if !options[:use_dhcp_assigned_default_route] -%>
+    post-up route del default dev $IFACE
+  <%- else -%>
+    # Disable the NAT default route in favour of our own.
+    post-up route del default dev eth0
+    post-up dhclient $IFACE
+    pre-down route add default dev eth0
+  <%- end -%>
+<%- end -%>
+#VAGRANT-VLAN-END

data/lib/vagrant-vlan/plugin.rb

@@ -0,0 +1,28 @@
+require "vagrant"
+
+require_relative "debian/guest"
+
+module VagrantPlugins
+  module VLAN
+    class Plugin < Vagrant.plugin("2")
+      name "VLAN configuration"
+      description "Configure VLANs"
+
+      action_hook(:configure_vlans) do |hook|
+        require_relative "action"
+        # We're injecting ourselves before the Vagrant standard network
+        # configuration step because we (as well as the standard network
+        # configuration middleware) do the actual network configuration on the
+        # way up the middleware stack. Therefore, this ensures that we will
+        # configure the vlans after the rest of the interfaces.
+        hook.before(VagrantPlugins::ProviderVirtualBox::Action::Network,
+                    Action)
+      end
+
+      config "vlan" do
+        require_relative "config"
+        VagrantPlugins::VLAN::Config
+      end
+    end
+  end
+end

data/lib/vagrant-vlan/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module VLAN
+    VERSION = "1.0.0"
+  end
+end

data/lib/vagrant-vlan.rb

@@ -0,0 +1,10 @@
+require "vagrant-vlan/plugin"
+require "pathname"
+
+module VagrantPlugins
+  module VLAN
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/vagrant-vlan.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-vlan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-vlan"
+  spec.version       = VagrantPlugins::VLAN::VERSION
+  spec.authors       = ["Arctic Wolf Networks"]
+  spec.email         = ["dev@arcticwolf.com"]
+  spec.summary       = %q{Configure a VLAN inside a guest.}
+  spec.description   = %q{Configure a VLAN inside a guest.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-vlan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arctic Wolf Networks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Configure a VLAN inside a guest.
+email:
+- dev@arcticwolf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-vlan.rb
+- lib/vagrant-vlan/action.rb
+- lib/vagrant-vlan/config.rb
+- lib/vagrant-vlan/debian/configure_vlans.rb
+- lib/vagrant-vlan/debian/guest.rb
+- lib/vagrant-vlan/debian/vlan.erb
+- lib/vagrant-vlan/plugin.rb
+- lib/vagrant-vlan/version.rb
+- vagrant-vlan.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Configure a VLAN inside a guest.
+test_files: []