docker-provider 0.0.2 → 0.1.0

data/Rakefile

@@ -4,7 +4,12 @@ require 'rspec/core/rake_task'
 namespace :spec do
   desc 'Run acceptance specs using Bats'
   task :acceptance do
-    sh 'bats spec/acceptance'
+    components = %w(
+      basic network/forwarded_port synced_folder synced_folder/nfs
+      provisioner/shell provisioner/puppet provisioner/chef-solo
+    ).map{|s| "provider/docker/#{s}" }
+
+    sh "bundle exec vagrant-spec test --components=#{components.join(' ')}"
   end
 
   require 'rspec/core/rake_task'

data/boxes/dind/.gitignore

@@ -0,0 +1,2 @@
+Vagrantfile
+precise-dind.box

data/boxes/dind/Dockerfile

@@ -0,0 +1,12 @@
+FROM fgrehm/vagrant-ubuntu:precise
+
+RUN apt-get update && apt-get install lxc -yq --force-yes -o Dpkg::Options::='--force-confdef' -o Dpkg::Options::='--force-confold'
+
+RUN curl -sLS https://get.docker.io | sh
+
+RUN usermod -aG docker vagrant
+
+RUN curl -sLS https://raw.github.com/dotcloud/docker/master/hack/dind -o /dind && \
+    chmod +x /dind
+
+CMD ["/dind", "/sbin/init"]

data/boxes/dind/README.md

@@ -0,0 +1,10 @@
+# Ubuntu Precise "Docker in Docker" enabled base box
+
+To turn this into a box:
+
+```
+docker build -t myuser/vagrant-ubuntu:precise-dind .
+docker push myuser/vagrant-ubuntu:precise-dind
+sed 's/IMAGE/myuser\/vagrant-ubuntu:precise-dind/' Vagrantfile.sample > Vagrantfile
+tar cvzf precise-dind.box ./metadata.json ./Vagrantfile
+```

data/boxes/{nginx → dind}/Vagrantfile.sample

@@ -1,6 +1,7 @@
 Vagrant.configure("2") do |config|
   config.vm.provider :docker do |docker|
     docker.image = "IMAGE"
-    docker.cmd   = ["/bin/start-container"]
+    docker.privileged = true
+    docker.volumes << '/var/lib/docker'
   end
 end

data/boxes/precise/Dockerfile

@@ -1,16 +1,8 @@
 # Base Vagrant box
-#
-# VERSION               0.0.1
 
-FROM ubuntu:precise
+FROM ubuntu-upstart:precise
 MAINTAINER Fabio Rehm "fgrehm@gmail.com"
 
-# Enable universe
-RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
-
-# Update things
-RUN apt-get update && apt-get install openssh-server sudo curl -y && apt-get upgrade -y && apt-get clean
-
 # Create and configure vagrant user
 RUN useradd --create-home -s /bin/bash vagrant
 WORKDIR /home/vagrant
@@ -27,9 +19,18 @@ RUN sed -i.bkp -e \
       's/%sudo\s\+ALL=(ALL\(:ALL\)\?)\s\+ALL/%sudo ALL=NOPASSWD:ALL/g' \
       /etc/sudoers
 
+# Enable universe
+RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list
+
 # Thanks to http://docs.docker.io/en/latest/examples/running_ssh_service/
 RUN mkdir /var/run/sshd
 
+# Update things and make sure the required packges are installed
+RUN apt-get update && \
+    apt-get install openssh-server sudo curl nfs-common -y && \
+    apt-get upgrade -y && \
+    apt-get clean
+
 # Puppet
 RUN wget http://apt.puppetlabs.com/puppetlabs-release-stable.deb -O /tmp/puppetlabs-release-stable.deb && \
     dpkg -i /tmp/puppetlabs-release-stable.deb && \

data/boxes/precise/Vagrantfile.sample

@@ -1,6 +1,5 @@
 Vagrant.configure("2") do |config|
   config.vm.provider :docker do |docker|
     docker.image = "IMAGE"
-    docker.cmd   = ["/usr/sbin/sshd", "-D", "-e"]
   end
 end

data/development/Vagrantfile

@@ -53,7 +53,7 @@ STR
 
   # Configure Ruby so that we can test the plugin from within the VM
   config.vm.provision :ventriloquist do |env|
-    env.platforms << 'ruby:1.9.3'
+    env.platforms << 'ruby:2.0.0'
   end
 
   config.vm.provision :shell, privileged: false, inline: %[
@@ -73,14 +73,6 @@ STR
       echo '{ "provider": "docker" }' > $HOME/.vagrant.d/boxes/dummy/docker/metadata.json
     fi
 
-    # TODO: Get rid of this once Ventriloquist gets support for it:
-    #         https://github.com/fgrehm/ventriloquist/issues/32
-    if ! [ -f /usr/local/bin/bats ]; then
-      git clone https://github.com/sstephenson/bats.git /tmp/bats
-      cd /tmp/bats && sudo ./install.sh /usr/local
-      rm -rf /tmp/bats
-    fi
-
     if ! $(which bsdtar > /dev/null 2>/dev/null); then
       sudo apt-get install bsdtar -y
     fi

data/docker-provider.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = VagrantPlugins::DockerProvider::VERSION
   spec.authors       = ["Fabio Rehm"]
   spec.email         = ["fgrehm@gmail.com"]
-  spec.description   = %q{Experimental Docker provider for Vagrant}
+  spec.description   = %q{Docker provider for Vagrant}
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/fgrehm/docker-provider"
   spec.license       = "MIT"
@@ -21,5 +21,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  # TODO: spec.add_dependency 'docker-api', '~> 1.6.0'
 end

data/example/Vagrantfile

@@ -5,25 +5,33 @@ ENV['VAGRANT_DEFAULT_PROVIDER'] = 'docker'
 
 # This is only needed if you are using the plugin from sources with bundler
 Vagrant.require_plugin 'docker-provider'
+Vagrant.require_plugin 'vagrant-cachier'
 
 # Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
 VAGRANTFILE_API_VERSION = "2"
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  # This just fires up a container with a SSH server
+  config.cache.scope = :machine
+
+  # This fires up a container with a SSH server
   config.vm.define 'dummy' do |node|
     node.vm.box = 'dummy'
     node.vm.box_url = 'http://bit.ly/vagrant-docker-dummy'
 
     node.vm.provider :docker do |docker|
       docker.image = 'fgrehm/vagrant-ubuntu:precise'
-      docker.cmd   = ["/usr/sbin/sshd", "-D", "-e"]
+      docker.privileged = true
+      docker.volumes << '/var/lib/docker'
     end
+
+    node.cache.synced_folder_opts = {
+      type: :nfs, mount_options: ['rw', 'vers=3', 'tcp', 'nolock']
+    }
   end
 
   # This is a container that gets provisioned with Puppet
   config.vm.define 'precise' do |node|
-    node.vm.box = 'precise'
+    node.vm.box = 'precise64'
     node.vm.box_url = 'http://bit.ly/vagrant-docker-precise'
 
     node.vm.provision :puppet do |puppet|
@@ -31,11 +39,4 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
       puppet.manifest_file  = "site.pp"
     end
   end
-
-  # Custom start script
-  config.vm.define 'nginx' do |node|
-    node.vm.box = 'nginx'
-    node.vm.box_url = 'http://bit.ly/vagrant-docker-nginx'
-    node.vm.network "forwarded_port", guest: 80, host: 8080
-  end
 end

data/lib/docker-provider.rb

@@ -1 +1,2 @@
-require 'docker-provider/plugin'
+require_relative "docker-provider/version"
+require_relative "docker-provider/plugin"

data/lib/docker-provider/action.rb

@@ -5,8 +5,9 @@ require_relative 'action/destroy'
 require_relative 'action/forward_ports'
 require_relative 'action/stop'
 require_relative 'action/message'
+require_relative 'action/prepare_nfs_valid_ids'
+require_relative 'action/prepare_nfs_settings'
 require_relative 'action/is_running'
-require_relative 'action/share_folders'
 require_relative 'action/start'
 
 module VagrantPlugins
@@ -28,14 +29,22 @@ module VagrantPlugins
               # b2.use Builtin::EnvSet, :port_collision_repair => true
               # b2.use Builtin::HandleForwardedPortCollisions
               b2.use Builtin::Provision
-              b2.use ShareFolders
+              b2.use PrepareNFSValidIds
+              b2.use Builtin::SyncedFolderCleanup
+              b2.use Builtin::SyncedFolders
+              b2.use PrepareNFSSettings
               b2.use ForwardPorts
               # This will actually create and start, but that's fine
               b2.use Create
               b2.use action_boot
+            else
+              b2.use PrepareNFSValidIds
+              b2.use Builtin::SyncedFolderCleanup
+              b2.use Builtin::SyncedFolders
+              b2.use PrepareNFSSettings
+              b2.use action_start
             end
           end
-          b.use action_start
         end
       end
 
@@ -67,9 +76,11 @@ module VagrantPlugins
         Builder.new.tap do |b|
           b.use Builtin::Call, Created do |env, b2|
             if env[:result]
-              # TODO: Make use of this once we figure out how to run dockers in machine mode
-              # b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
-              b2.use Stop
+              b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
+                if !env2[:result]
+                  b3.use Stop
+                end
+              end
             else
               b2.use Message, :not_created
             end

data/lib/docker-provider/action/check_running.rb

@@ -11,7 +11,7 @@ module VagrantPlugins
             raise Vagrant::Errors::VMNotCreatedError
           end
 
-          if env[:machine].state.id == :created
+          if env[:machine].state.id == :stopped
             raise Vagrant::Errors::VMNotRunningError
           end
 

data/lib/docker-provider/action/create.rb

@@ -3,7 +3,7 @@ module VagrantPlugins
     module Action
       class Create
         def initialize(app, env)
-          @app    = app
+          @app = app
           @@mutex ||= Mutex.new
         end
 
@@ -14,6 +14,8 @@ module VagrantPlugins
           @machine_config  = @machine.config
           @driver          = @machine.provider.driver
 
+          guard_cmd_configured!
+
           cid = ''
           @@mutex.synchronize do
             cid = @driver.create(create_params)
@@ -29,12 +31,13 @@ module VagrantPlugins
           container_name << "_#{Time.now.to_i}"
 
           {
-            image:    @provider_config.image,
-            cmd:      @provider_config.cmd,
-            ports:    forwarded_ports,
-            name:     container_name,
-            hostname: @machine_config.vm.hostname,
-            volumes:  synced_folders
+            image:      @provider_config.image,
+            cmd:        @provider_config.cmd,
+            ports:      forwarded_ports,
+            name:       container_name,
+            hostname:   @machine_config.vm.hostname,
+            volumes:    @provider_config.volumes,
+            privileged: @provider_config.privileged
           }
         end
 
@@ -45,10 +48,10 @@ module VagrantPlugins
           end.compact
         end
 
-        def synced_folders
-          @env[:synced_folders].map do |sf|
-            "#{sf[:hostpath]}:#{sf[:guestpath]}"
-          end.compact
+        def guard_cmd_configured!
+          if ! @provider_config.image
+            raise Errors::ImageNotConfiguredError, name: @machine.name
+          end
         end
       end
     end

data/lib/docker-provider/action/prepare_nfs_settings.rb

@@ -0,0 +1,59 @@
+require_relative '../errors'
+
+module VagrantPlugins
+  module DockerProvider
+    module Action
+      class PrepareNFSSettings
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          @machine = env[:machine]
+
+          @app.call(env)
+
+          if using_nfs? && !privileged_container?
+            raise Errors::NfsWithoutPrivilegedError
+          end
+
+          if using_nfs?
+            @logger.info("Using NFS, preparing NFS settings by reading host IP and machine IP")
+            add_ips_to_env!(env)
+          end
+        end
+
+        # We're using NFS if we have any synced folder with NFS configured. If
+        # we are not using NFS we don't need to do the extra work to
+        # populate these fields in the environment.
+        def using_nfs?
+          @machine.config.vm.synced_folders.any? { |_, opts| opts[:type] == :nfs }
+        end
+
+        def privileged_container?
+          @machine.provider.driver.privileged?(@machine.id)
+        end
+
+        # Extracts the proper host and guest IPs for NFS mounts and stores them
+        # in the environment for the SyncedFolder action to use them in
+        # mounting.
+        #
+        # The ! indicates that this method modifies its argument.
+        def add_ips_to_env!(env)
+          provider = env[:machine].provider
+
+          host_ip    = provider.driver.docker_bridge_ip
+          machine_ip = provider.ssh_info[:host]
+
+          raise Vagrant::Errors::NFSNoHostonlyNetwork if !host_ip || !machine_ip
+
+          env[:nfs_host_ip]    = host_ip
+          env[:nfs_machine_ip] = machine_ip
+        end
+      end
+    end
+  end
+end

data/lib/docker-provider/action/prepare_nfs_valid_ids.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module DockerProvider
+    module Action
+      class PrepareNFSValidIds
+        def initialize(app, env)
+          @app = app
+          @logger = Log4r::Logger.new("vagrant::action::vm::nfs")
+        end
+
+        def call(env)
+          machine = env[:machine]
+          env[:nfs_valid_ids] = machine.provider.driver.all_containers
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/docker-provider/config.rb

@@ -1,28 +1,35 @@
 module VagrantPlugins
   module DockerProvider
     class Config < Vagrant.plugin("2", :config)
-      attr_accessor :image, :cmd, :ports
+      attr_accessor :image, :cmd, :ports, :volumes, :privileged
 
       def initialize
-        @image = UNSET_VALUE
-        @cmd   = UNSET_VALUE
-        @ports = UNSET_VALUE
+        @image      = nil
+        @cmd        = UNSET_VALUE
+        @ports      = []
+        @privileged = UNSET_VALUE
+        @volumes    = []
       end
 
       def finalize!
-        @ports = [] if @ports == UNSET_VALUE
-        @cmd   = [] if @cmd == UNSET_VALUE
+        @cmd        = [] if @cmd == UNSET_VALUE
+        @privileged = false if @privileged == UNSET_VALUE
       end
 
       def validate(machine)
         errors = _detected_errors
 
-        errors << I18n.t("docker_provider.errors.config.image_not_set") if @image == UNSET_VALUE
         # TODO: Detect if base image has a CMD / ENTRYPOINT set before erroring out
         errors << I18n.t("docker_provider.errors.config.cmd_not_set")   if @cmd == UNSET_VALUE
 
         { "docker-provider" => errors }
       end
+
+      private
+
+      def using_nfs?(machine)
+        machine.config.vm.synced_folders.any? { |_, opts| opts[:type] == :nfs }
+      end
     end
   end
 end

data/lib/docker-provider/driver.rb

@@ -24,6 +24,7 @@ module VagrantPlugins
         run_cmd = %W(docker run -name #{name} -d)
         run_cmd += ports.map { |p| ['-p', p.to_s] }
         run_cmd += volumes.map { |v| ['-v', v.to_s] }
+        run_cmd += %W(-privileged) if params[:privileged]
         run_cmd += %W(-h #{params[:hostname]}) if params[:hostname]
         run_cmd += [image, cmd]
 
@@ -44,38 +45,61 @@ module VagrantPlugins
       end
 
       def created?(cid)
-        result = execute('docker', 'ps', '-a', '-q').to_s
+        result = execute('docker', 'ps', '-a', '-q', '-notrunc').to_s
         result =~ /^#{Regexp.escape cid}$/
       end
 
       def running?(cid)
-        result = execute('docker', 'ps', '-q')
+        result = execute('docker', 'ps', '-q', '-notrunc')
         result =~ /^#{Regexp.escape cid}$/m
       end
 
+      def privileged?(cid)
+        inspect_container(cid)['HostConfig']['Privileged']
+      end
+
       def start(cid)
         unless running?(cid)
           execute('docker', 'start', cid)
+          # This resets the cached information we have around, allowing `vagrant reload`s
+          # to work properly
+          # TODO: Add spec to verify this behavior
+          @data = nil
         end
       end
 
       def stop(cid)
         if running?(cid)
-          execute('docker', 'stop', cid)
+          execute('docker', 'stop', '-t', '1', cid)
         end
       end
 
       def rm(cid)
         if created?(cid)
-          execute('docker', 'rm', cid)
+          execute('docker', 'rm', '-v', cid)
         end
       end
 
-      def inspect(cid)
-        # DISCUSS: Is there a chance that this will change?
+      def inspect_container(cid)
+        # DISCUSS: Is there a chance that this json will change after the container
+        #          has been brought up?
         @data ||= JSON.parse(execute('docker', 'inspect', cid)).first
       end
 
+      def all_containers
+        execute('docker', 'ps', '-a', '-q', '-notrunc').to_s.split
+      end
+
+      def docker_bridge_ip
+        output = execute('/sbin/ip', '-4', 'addr', 'show', 'scope', 'global', 'docker0')
+        if output =~ /^\s+inet ([0-9.]+)\/[0-9]+\s+/
+          return $1.to_s
+        else
+          # TODO: Raise an user friendly message
+          raise 'Unable to fetch docker bridge IP!'
+        end
+      end
+
       private
 
       def execute(*cmd, &block)