vagrant-lxc-2.1-patch 1.4.0

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+### Please read before contributing
+
+* If you have an issue with base boxes, please create it on https://github.com/fgrehm/vagrant-lxc-base-boxes,
+  this repository is for the Vagrant plugin only.
+
+* Try not to post questions in the issues tracker. I will probably answer you
+  but I'll most likely close the issue right away and will continue the discussion
+  with the issue closed. If you have any questions about the plugin, make sure
+  you go through the [Wiki](https://github.com/fgrehm/vagrant-lxc/wiki) pages
+  first (specially the [Troubleshooting Section](https://github.com/fgrehm/vagrant-lxc/wiki/Troubleshooting))
+  and if you still need answers please ask a question on [Stack Overflow](http://stackoverflow.com/questions/tagged/vagrant-lxc)
+  using the `vagrant` / `lxc` tag on it so that I get notified :)
+
+* Please do a search on the issues tracker before submitting your issue to
+  check if it was already reported / fixed.
+
+* When reporting a bug, please include **all** information that you can get
+  about your environment. Things like vagrant / vagrant-lxc / kernel / lxc /
+  distro versions, the list of plugins you have installed, a [gist](https://gist.github.com/)
+  with the output of running `VAGRANT_LOG=debug vagrant COMMAND`, the `Vagrantfile`
+  you are using and / or base box URL are really useful when tracking down what's
+  going on on your side of the globe and will get bonus points :)
+
+Thanks!

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git', tag: 'v1.8.7'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-inotify'
+end
+
+group :development, :test do
+  gem 'rake', '~> 10.4.2'
+  gem 'rspec', '~> 2.99.0'
+  gem 'coveralls', '~> 0.7.2', require: (ENV['COVERAGE'] == 'true')
+  # The is the ref *just* before we switch to childprocess 0.6, which conflicts with vagrant 1.8 deps.
+  gem 'vagrant-spec', git: 'https://github.com/mitchellh/vagrant-spec.git', ref: '5006bc73cd8796465ca09307d4774f8ec8375aa0'
+end
+
+group :plugins do
+  acceptance = (ENV['ACCEPTANCE'] == 'true')
+  gem 'vagrant-cachier',  git: 'https://github.com/fgrehm/vagrant-cachier.git',  require: !acceptance
+  gem 'vagrant-pristine', git: 'https://github.com/fgrehm/vagrant-pristine.git', require: !acceptance
+  gem 'vagrant-omnibus',  require: !acceptance
+  gemspec
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', :spec_paths => ["spec/unit"] do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/vagrant-lxc/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/unit_helper.rb')          { "spec/unit" }
+  watch('spec/spec_helper.rb')          { "spec/unit" }
+  watch(%r{^spec/support/(.+)\.rb$})    { "spec/unit" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2014 Fábio Rehm
+
+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,187 @@
+# vagrant-lxc
+
+[![Build Status](https://travis-ci.org/fgrehm/vagrant-lxc.png?branch=master)](https://travis-ci.org/fgrehm/vagrant-lxc) [![Gem Version](https://badge.fury.io/rb/vagrant-lxc.png)](http://badge.fury.io/rb/vagrant-lxc) [![Code Climate](https://codeclimate.com/github/fgrehm/vagrant-lxc.png)](https://codeclimate.com/github/fgrehm/vagrant-lxc) [![Coverage Status](https://coveralls.io/repos/fgrehm/vagrant-lxc/badge.png?branch=master)](https://coveralls.io/r/fgrehm/vagrant-lxc) [![Gitter chat](https://badges.gitter.im/fgrehm/vagrant-lxc.png)](https://gitter.im/fgrehm/vagrant-lxc)
+
+[LXC](http://lxc.sourceforge.net/) provider for [Vagrant](http://www.vagrantup.com/) 1.8+
+
+This is a Vagrant plugin that allows it to control and provision Linux Containers
+as an alternative to the built in VirtualBox provider for Linux hosts. Check out
+[this blog post](http://fabiorehm.com/blog/2013/04/28/lxc-provider-for-vagrant/)
+to see it in action.
+
+## Features
+
+* Provides the same workflow as the Vagrant VirtualBox provider
+* Port forwarding via [`redir`](https://github.com/troglobit/redir)
+* Private networking via [`pipework`](https://github.com/jpetazzo/pipework)
+
+## Requirements
+
+* [Vagrant 1.8+](http://www.vagrantup.com/downloads.html)
+* lxc >=1.0
+* `redir` (if you are planning to use port forwarding)
+* `brctl` (if you are planning to use private networks, on Ubuntu this means `apt-get install bridge-utils`)
+
+The plugin is known to work better and pretty much out of the box on Ubuntu 14.04+
+hosts and installing the dependencies on it basically means a
+`apt-get install lxc lxc-templates cgroup-lite redir`. For setting up other
+types of hosts please have a look at the [Wiki](https://github.com/fgrehm/vagrant-lxc/wiki).
+
+If you are on a Mac or Windows machine, you might want to have a look at [this](http://the.taoofmac.com/space/HOWTO/Vagrant)
+blog post for some ideas on how to set things up or check out [this other repo](https://github.com/fgrehm/vagrant-lxc-vbox-hosts)
+for a set of Vagrant VirtualBox machines ready for vagrant-lxc usage.
+
+
+## Installation
+
+```
+vagrant plugin install vagrant-lxc
+```
+
+
+## Quick start
+
+```
+vagrant init fgrehm/precise64-lxc
+vagrant up --provider=lxc
+```
+
+_More information about skipping the `--provider` argument can be found at the
+"DEFAULT PROVIDER" section of [Vagrant docs](https://docs.vagrantup.com/v2/providers/basic_usage.html)_
+
+## Base boxes
+
+Base boxes can be found on [Atlas](https://atlas.hashicorp.com/boxes/search?provider=lxc)
+and some scripts to build your own are available at [fgrehm/vagrant-lxc-base-boxes](https://github.com/fgrehm/vagrant-lxc-base-boxes).
+
+If you want to build your own boxes, please have a look at [`BOXES.md`](https://github.com/fgrehm/vagrant-lxc/tree/master/BOXES.md)
+for more information.
+
+## Advanced configuration
+
+You can modify container configurations from within your Vagrantfile using the
+[provider block](http://docs.vagrantup.com/v2/providers/configuration.html):
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "fgrehm/trusty64-lxc"
+  config.vm.provider :lxc do |lxc|
+    # Same effect as 'customize ["modifyvm", :id, "--memory", "1024"]' for VirtualBox
+    lxc.customize 'cgroup.memory.limit_in_bytes', '1024M'
+  end
+end
+```
+
+vagrant-lxc will then write out `lxc.cgroup.memory.limit_in_bytes='1024M'` to the
+container config file (usually kept under `/var/lib/lxc/<container>/config`)
+prior to starting it.
+
+For other configuration options, please check the [lxc.conf manpages](http://manpages.ubuntu.com/manpages/precise/man5/lxc.conf.5.html).
+
+### Private Networks
+
+Starting with vagrant-lxc 1.1.0, there is some rudimentary support for configuring
+[Private Networks](https://docs.vagrantup.com/v2/networking/private_network.html)
+by leveraging the [pipework](https://github.com/jpetazzo/pipework) project.
+
+On its current state, there is a requirement for setting the bridge name that
+will be created and will allow your machine to comunicate with the container
+
+For example:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.network "private_network", ip: "192.168.2.100", lxc__bridge_name: 'vlxcbr1'
+end
+```
+
+Will create a new `veth` device for the container and will set up (or reuse)
+a `vlxcbr1` bridge between your machine and the `veth` device. Once the last
+vagrant-lxc container attached to the bridge gets `vagrant halt`ed, the plugin
+will delete the bridge.
+
+### Container naming
+
+By default vagrant-lxc will attempt to generate a unique container name
+for you. However, if the container name is important to you, you may use the
+`container_name` attribute to set it explicitly from the `provider` block:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.define "db" do |node|
+    node.vm.provider :lxc do |lxc|
+      lxc.container_name = :machine # Sets the container name to 'db'
+      lxc.container_name = 'mysql'  # Sets the container name to 'mysql'
+    end
+  end
+end
+```
+
+_Please note that there is a 64 chars limit and the container name will be
+trimmed down to that to ensure we can always bring the container up.
+
+### Backingstore options
+
+Support for setting `lxc-create`'s backingstore option (`-B` and related) can be
+specified from the provider block and it defaults to `best`, to change it:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.provider :lxc do |lxc|
+    lxc.backingstore = 'lvm' # or 'btrfs', 'overlayfs', ...
+    # lvm specific options
+    lxc.backingstore_option '--vgname', 'schroots'
+    lxc.backingstore_option '--fssize', '5G'
+    lxc.backingstore_option '--fstype', 'xfs'
+  end
+end
+```
+
+## Unprivileged containers support
+
+Since v1.4.0, `vagrant-lxc` gained support for unprivileged containers. For now, since it's a new
+feature, privileged containers are still the default, but you can have your `Vagrantfile` use
+unprivileged containers with the `privileged` flag (which defaults to `true`). Example:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.provider :lxc do |lxc|
+    lxc.privileged = false
+  end
+end
+```
+
+For unprivileged containers to work with `vagrant-lxc`, you need a properly configured system. On
+some distros, it can be somewhat of a challenge. Your journey to configuring your system can start
+with [Stéphane Graber's blog post about it](https://stgraber.org/2014/01/17/lxc-1-0-unprivileged-containers/).
+
+## Avoiding `sudo` passwords
+
+If you're not using unprivileged containers, this plugin requires **a lot** of `sudo`ing To work
+around that, you can use the `vagrant lxc sudoers` command which will create a file under
+`/etc/sudoers.d/vagrant-lxc` whitelisting all commands required by `vagrant-lxc` to run.
+
+If you are interested on what will be generated by that command, please check
+[this code](lib/vagrant-lxc/command/sudoers.rb).
+
+
+## More information
+
+Please refer the [wiki](https://github.com/fgrehm/vagrant-lxc/wiki).
+
+
+## Problems / ideas?
+
+Please review the [Troubleshooting](https://github.com/fgrehm/vagrant-lxc/wiki/Troubleshooting)
+wiki page + [known bugs](https://github.com/fgrehm/vagrant-lxc/issues?labels=bug&page=1&state=open)
+list if you have a problem and feel free to use the [issue tracker](https://github.com/fgrehm/vagrant-lxc/issues)
+propose new functionality and / or report bugs.
+
+
+## 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 new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+Dir['./tasks/**/*.rake'].each { |f| load f }
+
+require 'bundler/gem_tasks'

data/lib/vagrant-lxc.rb

@@ -0,0 +1,10 @@
+require "vagrant-lxc/version"
+require "vagrant-lxc/plugin"
+
+module Vagrant
+  module LXC
+    def self.source_root
+      @source_root ||= Pathname.new(File.dirname(__FILE__)).join('..').expand_path
+    end
+  end
+end

data/lib/vagrant-lxc/action.rb

@@ -0,0 +1,234 @@
+require 'vagrant-lxc/action/boot'
+require 'vagrant-lxc/action/clear_forwarded_ports'
+require 'vagrant-lxc/action/create'
+require 'vagrant-lxc/action/destroy'
+require 'vagrant-lxc/action/destroy_confirm'
+require 'vagrant-lxc/action/compress_rootfs'
+require 'vagrant-lxc/action/fetch_ip_with_lxc_info'
+require 'vagrant-lxc/action/forced_halt'
+require 'vagrant-lxc/action/forward_ports'
+require 'vagrant-lxc/action/gc_private_network_bridges'
+require 'vagrant-lxc/action/handle_box_metadata'
+require 'vagrant-lxc/action/prepare_nfs_settings'
+require 'vagrant-lxc/action/prepare_nfs_valid_ids'
+require 'vagrant-lxc/action/private_networks'
+require 'vagrant-lxc/action/setup_package_files'
+require 'vagrant-lxc/action/warn_networks'
+
+module Vagrant
+  module LXC
+    module Action
+      # Shortcuts
+      Builtin = Vagrant::Action::Builtin
+      Builder = Vagrant::Action::Builder
+
+      # This action is responsible for reloading the machine, which
+      # brings it down, sucks in new configuration, and brings the
+      # machine back up with the new configuration.
+      def self.action_reload
+        Builder.new.tap do |b|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::ConfigValidate
+            b2.use action_halt
+            b2.use action_start
+          end
+        end
+      end
+
+      # This action boots the VM, assuming the VM is in a state that requires
+      # a bootup (i.e. not saved).
+      def self.action_boot
+        Builder.new.tap do |b|
+          b.use Builtin::Provision
+          b.use Builtin::EnvSet, :port_collision_repair => true
+          b.use Builtin::HandleForwardedPortCollisions
+          b.use PrepareNFSValidIds
+          b.use Builtin::SyncedFolderCleanup
+          b.use Builtin::SyncedFolders
+          b.use PrepareNFSSettings
+          b.use Builtin::SetHostname
+          b.use WarnNetworks
+          b.use ForwardPorts
+          b.use PrivateNetworks
+          b.use Boot
+          b.use Builtin::WaitForCommunicator
+        end
+      end
+
+      # This action just runs the provisioners on the machine.
+      def self.action_provision
+        Builder.new.tap do |b|
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, Builtin::IsState, :running do |env2, b3|
+              if !env2[:result]
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_running")
+                next
+              end
+
+              b3.use Builtin::Provision
+            end
+          end
+        end
+      end
+
+      # This action starts a container, assuming it is already created and exists.
+      # A precondition of this action is that the container exists.
+      def self.action_start
+        Builder.new.tap do |b|
+          b.use Builtin::ConfigValidate
+          b.use Builtin::BoxCheckOutdated
+          b.use Builtin::Call, Builtin::IsState, :running do |env, b2|
+            # If the VM is running, then our work here is done, exit
+            next if env[:result]
+            b2.use action_boot
+          end
+        end
+      end
+
+      # This action brings the machine up from nothing, including creating the
+      # container, configuring metadata, and booting.
+      def self.action_up
+        Builder.new.tap do |b|
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            # If the VM is NOT created yet, then do the setup steps
+            if env[:result]
+              b2.use Builtin::HandleBox
+              b2.use HandleBoxMetadata
+              b2.use Create
+            end
+          end
+          b.use action_start
+        end
+      end
+
+      # This is the action that is primarily responsible for halting
+      # the virtual machine, gracefully or by force.
+      def self.action_halt
+        Builder.new.tap do |b|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use ClearForwardedPorts
+            b2.use GcPrivateNetworkBridges
+            b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
+              if !env2[:result]
+                b3.use ForcedHalt
+              end
+            end
+          end
+        end
+      end
+
+      # This is the action that is primarily responsible for completely
+      # freeing the resources of the underlying virtual machine.
+      def self.action_destroy
+        Builder.new.tap do |b|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, DestroyConfirm do |env2, b3|
+              if env2[:result]
+                b3.use Builtin::ConfigValidate
+                b3.use Builtin::EnvSet, :force_halt => true
+                b3.use action_halt
+                b3.use Destroy
+                b3.use Builtin::ProvisionerCleanup
+              else
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.will_not_destroy")
+              end
+            end
+          end
+        end
+      end
+
+      # This action packages the virtual machine into a single box file.
+      def self.action_package
+        Builder.new.tap do |b|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use action_halt
+            b2.use CompressRootFS
+            b2.use SetupPackageFiles
+            b2.use Vagrant::Action::General::Package
+          end
+        end
+      end
+
+      # This action is called to read the IP of the container. The IP found
+      # is expected to be put into the `:machine_ip` key.
+      def self.action_ssh_ip
+        Builder.new.tap do |b|
+          b.use Builtin::Call, Builtin::ConfigValidate do |env, b2|
+            b2.use FetchIpWithLxcInfo
+          end
+        end
+      end
+
+      # This is the action that will exec into an SSH shell.
+      def self.action_ssh
+        Builder.new.tap do |b|
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, Builtin::IsState, :running do |env1, b3|
+              if !env1[:result]
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_running")
+                next
+              end
+
+              b3.use Builtin::SSHExec
+            end
+          end
+        end
+      end
+
+      # This is the action that will run a single SSH command.
+      def self.action_ssh_run
+        Builder.new.tap do |b|
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, Builtin::IsState, :running do |env1, b3|
+              if !env1[:result]
+                raise Vagrant::Errors::VMNotRunningError
+                next
+              end
+
+              b3.use Builtin::SSHRun
+            end
+          end
+        end
+      end
+    end
+  end
+end