docker-provider 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ecc63749fe1c7951f04eecbcedc6579fcec0db7
+  data.tar.gz: fbdb3556de90b576e1b3613e4de96791599963fc
+SHA512:
+  metadata.gz: 575626e4f52623abc118e4feee9df5faa2f4a82c1adacd449b2c657b38e1a07ecd233f24bfd381d8a9c64259675425f66adbf82dbe4e33b35bd1026043e1eee1
+  data.tar.gz: 8f457fe8e793b59ad56c8e575cb7d2497a65d96a5545f23390e5c5e8ac053bbbc9e35cbd09b04e30a894965dd4b050c6757d0692d67aa9aae16311b92fe39c50

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/development/.vagrant
+/example/.vagrant
+/spec/acceptance/.vagrant

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+script: "bundle exec rake spec:unit"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (November 5, 2013)
+
+  - Initial public release.

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker-provider.gemspec
+gemspec
+
+group :development, :test do
+  gem 'vagrant', github: 'mitchellh/vagrant'
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-inotify'
+
+  gem 'vagrant-notify',        github: 'fgrehm/vagrant-notify'
+  gem 'vagrant-cachier',       github: 'fgrehm/vagrant-cachier'
+  gem 'vagrant-pristine',      github: 'fgrehm/vagrant-pristine'
+  gem 'vagrant-lxc',           github: 'fgrehm/vagrant-lxc'
+  gem 'vagrant-global-status', github: 'fgrehm/vagrant-global-status'
+  gem 'ventriloquist',         github: 'fgrehm/ventriloquist'
+end

data/Gemfile.lock

@@ -0,0 +1,125 @@
+GIT
+  remote: git://github.com/fgrehm/vagrant-cachier.git
+  revision: 536ca7ad54b3096644993f91f363df8a884d4600
+  specs:
+    vagrant-cachier (0.4.2.dev)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-global-status.git
+  revision: a0295400a0e47756cbcb8f97ed9f4449b1fb6b56
+  specs:
+    vagrant-global-status (0.1.1)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-lxc.git
+  revision: 4ca375ec5049fd2e50773b486df84ecd14f0dc4f
+  specs:
+    vagrant-lxc (0.6.5.dev)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-notify.git
+  revision: 4fd0040dc63ac88094aaa52c21496badebe1f938
+  specs:
+    vagrant-notify (0.3.0)
+
+GIT
+  remote: git://github.com/fgrehm/vagrant-pristine.git
+  revision: 4638491786943bfbf6f115b1fc379f069963fe46
+  specs:
+    vagrant-pristine (0.3.0)
+
+GIT
+  remote: git://github.com/fgrehm/ventriloquist.git
+  revision: 0eadf36c67417b13890715bc365b858b8adcd959
+  specs:
+    ventriloquist (0.3.3.dev)
+      vocker (~> 0.3.3)
+
+GIT
+  remote: git://github.com/mitchellh/vagrant.git
+  revision: a92e03cf4ce936243d3959b7b5603262a234a58d
+  specs:
+    vagrant (1.3.6.dev)
+      childprocess (~> 0.3.7)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6.0)
+      log4r (~> 1.1.9)
+      net-scp (~> 1.1.0)
+      net-ssh (~> 2.6.6)
+
+PATH
+  remote: .
+  specs:
+    docker-provider (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.2)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.3)
+      guard (>= 2.1.1)
+      rspec (~> 2.14)
+    i18n (0.6.5)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    log4r (1.1.10)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.8)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.6)
+    thor (0.18.1)
+    timers (1.1.0)
+    vocker (0.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  docker-provider!
+  guard
+  guard-rspec
+  rake
+  rb-inotify
+  rspec
+  vagrant!
+  vagrant-cachier!
+  vagrant-global-status!
+  vagrant-lxc!
+  vagrant-notify!
+  vagrant-pristine!
+  ventriloquist!

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :spec_paths => ["spec/unit"] do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^lib/docker-provider/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  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 Fabio 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,134 @@
+# docker-provider
+
+A spike on a [Docker](http://www.docker.io/) provider for [Vagrant](http://www.vagrantup.com/)
+1.3+.
+
+
+## Warning
+
+This is highly experimental and is just 8 [tomatoes](http://pomodorotechnique.com/)
+worth of development / testing.
+
+
+## Requirements
+
+* Vagrant 1.3+
+* Docker 0.6.5+
+
+
+## Features
+
+* Support for Vagrant's `up`, `destroy`, `halt`, `reload` and `ssh` commands
+* Port forwarding
+* Synced / shared folders support
+* Set container hostnames from Vagrantfiles
+* Provision Docker containers with any built-in Vagrant provider
+
+
+## Getting started
+
+If you are on a Mac / Windows machine, please fire up a x64 VM with Docker +
+Vagrant installed or use [this Vagrantfile](https://gist.github.com/fgrehm/fc48fb51ec7df64439e4)
+and follow the instructions from there.
+
+The plugin is not very user friendly at the moment, so please download the base
+Docker image manually with `docker pull fgrehm/vagrant-ubuntu:precise` in order
+to have some feedback about the download process.
+
+Assuming you have Vagrant 1.3+ and Docker 0.6.5+ installed just sing that same
+old song:
+
+```
+vagrant plugin install docker-provider
+vagrant box add precise http://bit.ly/vagrant-docker-precise
+vagrant init precise
+vagrant up --provider=docker
+```
+
+
+## Using custom images
+
+If you want to use a custom Docker image without creating a Vagrant base box,
+you can use a "dummy" box:
+
+```
+vagrant box add dummy http://bit.ly/vagrant-docker-dummy
+```
+
+And configure things from your `Vagrantfile` like in [vagrant-digitalocean](https://github.com/smdahlen/vagrant-digitalocean#configure)
+or [vagrant-aws](https://github.com/mitchellh/vagrant-aws#quick-start):
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.vm.provider :docker do |docker|
+    docker.image = "your/image:tag"
+    docker.cmd   = ["/path/to/your", "command"]
+  end
+end
+```
+
+
+## Limitations
+
+There's probably a whole lot of limitations right now but during these early days
+of the plugin I can tell you for sure that some things are probably not going to
+work as you might expect. For instance forwarded ports, synced folders and containers'
+hostnames will not be reconfigured on `vagrant reload`s if they have changed and
+the plugin **_will not give you any kind of warning or message_**. Forwarded ports
+automatic collision handling is **_not supported as well_**.
+
+The plugin also requires Docker's executable to be available on current user's `PATH`
+and that the current user has been added to the `docker` group since we are not
+using `sudo` when interacting with Docker's CLI. For more information on setting
+this up please check [this page](http://docs.docker.io/en/latest/use/basics/#why-sudo).
+
+Another thing to keep in mind is that Docker is all about _application containers_
+and not _machine containers_. I failed to boot a Docker container in what people
+have been calling "[machine mode](https://github.com/dotcloud/docker/issues/2170#issuecomment-26118964)"
+and some hacking will be required in order to run multiple processes on the
+container as described below. For more information about the issues related to
+it, please search Docker's issue tracker for `/sbin/init` and / or "machine mode".
+
+
+## Box format
+
+Every provider in Vagrant must introduce a custom box format. This provider introduces
+`docker` boxes and you can view some examples in the [`boxes`](boxes) directory.
+That directory also contains instructions on how to build them.
+
+The box format is basically just the required `metadata.json` file along with a
+`Vagrantfile` that does default settings for the provider-specific configuration
+for this provider.
+
+
+## Running multiple processes on the container
+
+Unless you are able to run the container in "machine mode", you'll need to create
+a custom command / script that starts the processes you need prior to firing up
+the SSH server. An example can be found at the [`boxes/nginx`](boxes/nginx)
+folder of this repo.
+
+On a side note, if you really need your Docker containers to behave like machines
+with Vagrant and you can't get it to work that way like me, you might want to use
+[vagrant-lxc](https://github.com/fgrehm/vagrant-lxc) as an alternative.
+
+
+## Got feedback?
+
+Please keep in mind that this is a spike and I'm not sure if / how the project
+will evolve. I'm planning to write about why I built this at some point but
+in case you have any feedback feel free to open up an [issue here on GitHub](https://github.com/fgrehm/docker-provider/issues),
+shoot a tweet to [@fgrehm](https://twitter.com/fgrehm) or send a mail to the
+address available on my GitHub profile.
+
+
+## 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
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/fgrehm/docker-provider/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  desc 'Run acceptance specs using Bats'
+  task :acceptance do
+    sh 'bats spec/acceptance'
+  end
+
+  require 'rspec/core/rake_task'
+  desc "Run unit specs using RSpec"
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = "./unit/**/*_spec.rb"
+  end
+end
+
+desc 'Run all specs'
+task :spec => ['spec:unit', 'spec:acceptance']
+
+task :default => 'spec'

data/boxes/dummy/README.md

@@ -0,0 +1,17 @@
+# Dummy box
+
+Vagrant providers each require a custom provider-specific box format. This folder
+contains a "dummy" box that allows you to use the plugin without the need to create
+a custom base box.
+
+To turn this into a "box", run:
+
+```
+tar cvzf dummy.box ./metadata.json
+```
+
+By using this box you'll need to specify a Docker image on your `Vagrantfile`
+[as described](README.md#using-custom-images) on the README.
+
+For "real world" examples please check out [`boxes/precise`](boxes/precise) and
+[`boxes/nginx`](boxes/nginx).

data/boxes/dummy/metadata.json

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

data/boxes/nginx/.gitignore

@@ -0,0 +1 @@
+Vagrantfile

data/boxes/nginx/Dockerfile

@@ -0,0 +1,4 @@
+# Start with a docker-provider ready image
+FROM fgrehm/vagrant-ubuntu:precise
+RUN apt-get update && apt-get install nginx -y
+ADD ./start /bin/start-container

data/boxes/nginx/README.md

@@ -0,0 +1,25 @@
+# Nginx base box example
+
+This folder contains an example of a box that is able to run multiple processes.
+With the provided `Dockerfile` you'll be able to build a base box that runs both
+nginx and a SSH server that is required by Vagrant to do its "magic".
+
+
+```
+docker build -t myuser/vagrant-nginx .
+docker push myuser/vagrant-nginx
+sed 's/IMAGE/myuser\/vagrant-nginx/' Vagrantfile.sample > Vagrantfile
+tar cvzf nginx.box ./metadata.json ./Vagrantfile
+```
+
+In order to reach the nginx server running on the container you'll need to
+forward the ports with a `Vagrantfile` like the one below:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # Replace with the name of the box you used when adding
+  config.vm.box = "nginx"
+  # This makes nginx accessible from the host from http://localhost:8080
+  config.vm.network "forwarded_port", guest: 80, host: 8080
+end
+```

data/boxes/nginx/Vagrantfile.sample

@@ -0,0 +1,6 @@
+Vagrant.configure("2") do |config|
+  config.vm.provider :docker do |docker|
+    docker.image = "IMAGE"
+    docker.cmd   = ["/bin/start-container"]
+  end
+end