docker-provider 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75f8540cb7ab18e1d6592fc46a2dd3ef6675f766
-  data.tar.gz: d098ade4f9e92f805ac2f479b354e4dc436c2be6
+  metadata.gz: fd2b96a22d7601dc0d40ebf0c15e7a609b9a7936
+  data.tar.gz: 5f2d19fb42756d513dfab0c10c62487230d42c66
 SHA512:
-  metadata.gz: 4582b7287bad91333f450a779ad56ee9db01df6511ca8386146485c8e1a34747a32fd1a2439679b16663b862047e45475b766ad55c0d41e03fd05d15374347ad
-  data.tar.gz: 83c0bc91abbf40202ba6944d76910bbf845fe6b39ad8754ec53e112d372c1bee2fc71cb7f93c2b7a989a18a8d29a297e22d34fe14870a7f375d8c73ffd3c2f31
+  metadata.gz: af80b4c0dc7eb16a30f9188604eb05376bebc308be091d6b26872f9be1ef2290036baf173acfaadd0df6389c4d22182f22ca5bca3eb416f99210d33b8bb13105
+  data.tar.gz: e3dfb68c443d0604b52c0810a15fa456e69a0678d9dab3da4da2a000c544573a1ab005c8b649d8dd0e8224a11fb734a4017636a63afed70e7e3901e2b245e2e4

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [0.1.0](https://github.com/fgrehm/docker-provider/compare/v0.0.2...0.1.0) (Feb 27, 2014)
+
+BACKWARDS INCOMPATIBILITY:
+
+  - Support for Vagrant < 1.4 and Docker < 0.7.0 are gone, please use a previous
+    plugin version if you can't upgrade.
+
+FEATURES:
+
+  - Trusted build for official base boxes Docker images [GH-5]
+  - New base boxes / images for running Ubuntu 12.04 in "machine mode"
+  - New [dind](https://github.com/jpetazzo/dind) Ubuntu 12.04 base box
+  - Support for NFS Synced Folders
+  - Support for running privileged containers
+
+IMPROVEMENTS:
+
+  - Decrease timeout taken before killing a container on `vagrant halt`s
+  - Remove volumes along with containers with `docker rm -v` on `vagrant destroy`s
+  - Sanity checks using [vagrant-spec](https://github.com/mitchellh/vagrant-spec)
+
+BUG FIXES:
+
+  - Fix `vagrant up` failure with newer Vagrant and Docker versions.
+
 ## [0.0.2](https://github.com/fgrehm/docker-provider/compare/v0.0.1...v0.0.2) (November 5, 2013)
 
   - Fix provisioning with Vagrant's built in provisioners

data/Gemfile

@@ -4,7 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'vagrant', github: 'mitchellh/vagrant'
+  gem 'vagrant',      github: 'mitchellh/vagrant', tag: 'v1.4.3'
+  gem 'vagrant-spec', github: 'mitchellh/vagrant-spec', ref: 'fbd067bbe5e2a789bb2b29c38d1224cdd9386836'
 end
 
 group :development do
@@ -12,10 +13,9 @@ group :development do
   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'
+  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 'ventriloquist',    github: 'fgrehm/ventriloquist'
 end

data/Gemfile.lock

@@ -1,81 +1,91 @@
 GIT
   remote: git://github.com/fgrehm/vagrant-cachier.git
-  revision: 536ca7ad54b3096644993f91f363df8a884d4600
+  revision: 2faa6615466f8d518893f5ba51b493b877d2efde
   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)
+    vagrant-cachier (0.6.1.dev)
 
 GIT
   remote: git://github.com/fgrehm/vagrant-lxc.git
-  revision: 4ca375ec5049fd2e50773b486df84ecd14f0dc4f
+  revision: 4a84d95ff26bf2d887b127765a9ae404899734f9
   specs:
-    vagrant-lxc (0.6.5.dev)
+    vagrant-lxc (0.8.1.dev)
 
 GIT
   remote: git://github.com/fgrehm/vagrant-notify.git
-  revision: 4fd0040dc63ac88094aaa52c21496badebe1f938
+  revision: 56cc81882a6ca0c74ad662c81fca8105a307782c
   specs:
-    vagrant-notify (0.3.0)
+    vagrant-notify (0.4.1.dev)
 
 GIT
   remote: git://github.com/fgrehm/vagrant-pristine.git
-  revision: 4638491786943bfbf6f115b1fc379f069963fe46
+  revision: 503dbc47848c81d0fbfa6840491856f518d244a1
   specs:
     vagrant-pristine (0.3.0)
 
 GIT
   remote: git://github.com/fgrehm/ventriloquist.git
-  revision: 0eadf36c67417b13890715bc365b858b8adcd959
+  revision: 8f87f95e69f5dba6faf1b9b8c74ad51a0068d8b7
+  specs:
+    ventriloquist (0.4.2.dev)
+      vocker (~> 0.4.1)
+
+GIT
+  remote: git://github.com/mitchellh/vagrant-spec.git
+  revision: fbd067bbe5e2a789bb2b29c38d1224cdd9386836
+  ref: fbd067bbe5e2a789bb2b29c38d1224cdd9386836
   specs:
-    ventriloquist (0.3.3.dev)
-      vocker (~> 0.3.3)
+    vagrant-spec (0.0.1)
+      childprocess (~> 0.3.7)
+      log4r (~> 1.1.9)
+      rspec (~> 2.14)
+      thor (~> 0.18.1)
 
 GIT
   remote: git://github.com/mitchellh/vagrant.git
-  revision: a92e03cf4ce936243d3959b7b5603262a234a58d
+  revision: 4f0eb9504cc786d5a57a43814427e8eb35407a4c
+  tag: v1.4.3
   specs:
-    vagrant (1.3.6.dev)
+    vagrant (1.4.3)
       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)
+      net-ssh (>= 2.6.6, < 2.8.0)
 
 PATH
   remote: .
   specs:
-    docker-provider (0.0.2)
+    docker-provider (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     celluloid (0.15.2)
       timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
     childprocess (0.3.9)
       ffi (~> 1.0, >= 1.0.11)
-    coderay (1.0.9)
-    diff-lcs (1.2.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
     ffi (1.9.3)
     formatador (0.2.4)
-    guard (2.2.2)
+    guard (2.5.1)
       formatador (>= 0.2.4)
-      listen (~> 2.1)
+      listen (~> 2.6)
       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)
+    guard-rspec (4.2.7)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.9)
+    listen (2.6.1)
       celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     log4r (1.1.10)
@@ -83,27 +93,28 @@ GEM
     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)
+    net-ssh (2.7.0)
+    nio4r (1.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rake (10.1.0)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
       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)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    slop (3.4.6)
+    rspec-mocks (2.14.6)
+    slop (3.4.7)
     thor (0.18.1)
     timers (1.1.0)
-    vocker (0.3.3)
+    vocker (0.4.1)
 
 PLATFORMS
   ruby
@@ -118,8 +129,8 @@ DEPENDENCIES
   rspec
   vagrant!
   vagrant-cachier!
-  vagrant-global-status!
   vagrant-lxc!
   vagrant-notify!
   vagrant-pristine!
+  vagrant-spec!
   ventriloquist!

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Fabio Rehm
+Copyright (c) 2013-2014 Fabio Rehm
 
 MIT License
 

data/README.md

@@ -1,19 +1,20 @@
 # docker-provider
 
-A spike on a [Docker](http://www.docker.io/) provider for [Vagrant](http://www.vagrantup.com/)
-1.3+.
+[![Build Status](https://travis-ci.org/fgrehm/docker-provider.png?branch=master)](https://travis-ci.org/fgrehm/docker-provider) [![Gem Version](https://badge.fury.io/rb/docker-provider.png)](http://badge.fury.io/rb/docker-provider) [![Gittip](http://img.shields.io/gittip/fgrehm.svg)](https://www.gittip.com/fgrehm/)
+
+A [Docker](http://www.docker.io/) provider for [Vagrant](http://www.vagrantup.com/)
+1.4+.
 
 
 ## Warning
 
-This is highly experimental and is just 8 [tomatoes](http://pomodorotechnique.com/)
-worth of development / testing.
+This is experimental, expect things to break.
 
 
 ## Requirements
 
-* Vagrant 1.3+
-* Docker 0.6.5+
+* Vagrant 1.4+
+* Docker 0.7.0+
 
 
 ## Features
@@ -22,75 +23,142 @@ worth of development / testing.
 * Port forwarding
 * Synced / shared folders support
 * Set container hostnames from Vagrantfiles
-* Provision Docker containers with any built-in Vagrant provider
+* Provision Docker containers with any built-in Vagrant provisioner (as long as the container has a SSH server running)
+
+You can see the plugin in action by watching the following asciicasts I published
+prior to releasing 0.0.1:
+
+* http://asciinema.org/a/6162
+* http://asciinema.org/a/6177
 
 
 ## 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.
+If you are on a Mac / Windows machine, please fire up a x64 Linux VM with Docker +
+Vagrant 1.4+ installed or use [this Vagrantfile](https://gist.github.com/fgrehm/fc48fb51ec7df64439e4)
+and follow the instructions from within the VM.
 
-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.
+_It is likely that the plugin works with [boot2docker](http://boot2docker.github.io/)
+but I personally haven't tried that yet. If you are able to give it a go please
+[let me know](https://github.com/fgrehm/docker-provider/issues/new)._
 
-Assuming you have Vagrant 1.3+ and Docker 0.6.5+ installed just sing that same
+### Initial setup
+
+_If you are trying things out from a Vagrant VM using the `Vagrantfile` gisted
+above, you can skip to the next section_
+
+The plugin 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/installation/ubuntulinux/#giving-non-root-access).
+
+### `vagrant up`
+
+On its current state, the plugin is not "user friendly" and won't provide any kind
+of feedback about the process of downloading Docker images, so before you add a
+`docker-provider` [base box](http://docs.vagrantup.com/v2/boxes.html) it is recommended
+that you `docker pull` the associated base box images prior to spinning up `docker-provider`
+containers (otherwise you'll be staring at a blinking cursor without any progress
+information for a while).
+
+Assuming you have Vagrant 1.4+ and Docker 0.7.0+ installed just sing that same
 old song:
 
-```
+```sh
 vagrant plugin install docker-provider
-vagrant box add precise http://bit.ly/vagrant-docker-precise
-vagrant init precise
+docker pull fgrehm/vagrant-ubuntu:precise
+vagrant box add precise64 http://bit.ly/vagrant-docker-precise
+vagrant init precise64
 vagrant up --provider=docker
 ```
 
+Under the hood, that base box will [configure](#configuration) `docker-provider`
+to use the [`fgrehm/vagrant-ubuntu:precise`](https://index.docker.io/u/fgrehm/vagrant-ubuntu/)
+image that approximates a standard Vagrant box (`vagrant` user, default SSH key,
+etc.) and you should be good to go.
+
 
 ## 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)
+you can use a "dummy" box 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.box_url = "http://bit.ly/vagrant-docker-dummy"
   config.vm.provider :docker do |docker|
     docker.image = "your/image:tag"
-    docker.cmd   = ["/path/to/your", "command"]
   end
 end
 ```
 
 
-## Limitations
+## Configuration
 
-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_**. For instance,
-if you change your Puppet manifests / Chef cookbooks paths (which are shared /
-synced folders under the hood), **_you'll need to start from scratch_**. Oh,
-and forwarded ports automatic collision handling is **_not supported as well_**.
+This provider exposes a few provider-specific configuration options
+that are passed on to `docker run` under the hood when the container
+is being created:
 
-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).
+* `image` - Docker image to run (required)
+* `privileged` - Give extended privileges to the container (defaults to false)
+* `cmd` - An array of strings that makes up for the command to run the container (defaults to what has been set on your `Dockerfile` as `CMD` or `ENTRYPOINT`)
+* `ports` - An array of strings that makes up for the mapped network ports
+* `volumes` - An array of strings that makes up for the data volumes used by the container
 
-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".
+These can be set like typical provider-specific configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :docker do |docker|
+    docker.image      = 'fgrehm/vagrant-ubuntu-dind:precise'
+    docker.privileged = true
+    docker.cmd        = ['/dind', '/sbin/init']
+
+    docker.ports   << '1234:22'
+    docker.volumes << '/var/lib/docker'
+  end
+end
+```
+
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not supported with
+`docker-provider` apart from [forwarded ports]().
+If any of [`:private_network`](http://docs.vagrantup.com/v2/networking/private_network.html)
+or [`:public_network`](http://docs.vagrantup.com/v2/networking/public_network.html)
+are specified, Vagrant **won't** emit a warning.
+
+The same applies to changes on forwarded ports after the container has been
+created, Vagrant **won't** emit a warning to let you know that the ports specified
+on your `Vagrantfile` differs from what has been passed on to `docker run` when
+creating the container.
+
+_At some point the plugin will emit warnings on the scenarios described above, but
+not on its current state. Pull Requests are encouraged ;)_
+
+
+## Synced Folders
+
+There is support for synced folders on the form of [Docker volumes](http://docs.docker.io/en/latest/use/working_with_volumes/#mount-a-host-directory-as-a-container-volume)
+but as with forwarded ports, you won't be able to change them after the container
+has been created. [NFS](http://docs.vagrantup.com/v2/synced-folders/nfs.html)
+synced folders are also supported (as long as you set the `privileged`
+[config](#configuration) to true so that `docker-provider` can mount it on the
+guest container) and are capable of being reconfigured between `vagrant reload`s
+(different from Docker volumes).
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+_At some point the plugin will emit warnings when the configured `Vagrantfile`
+synced folders / volumes differs from the ones used upon the container creation,
+but not on its current state. Pull Requests are encouraged ;)_
 
 
 ## Box format
@@ -104,25 +172,29 @@ The box format is basically just the required `metadata.json` file along with a
 for this provider.
 
 
-## Running multiple processes on the container
+## Available base boxes
 
-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.
+| LINK | DESCRIPTION |
+| ---  | ---         |
+| http://bit.ly/vagrant-docker-precise | Ubuntu 12.04 Precise x86_64 with Puppet and Chef preinstalled and configured to run `/sbin/init` |
+| http://bit.ly/vagrant-docker-precise-dind | Ubuntu 12.04 Precise x86_64 based on the box above and ready to run [DinD](https://github.com/jpetazzo/dind) |
 
-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.
 
+## Limitations
 
-## Got feedback?
+As explained on the [networks](#networks) and [synced folder](#synced-folders)
+sections above, there are some "gotchas" when using the plugin that you need to have
+in mind before you start to pull your hair out.
 
-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.
+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_**. As an example, if you change your Puppet
+manifests / Chef cookbooks paths (which are shared / synced folders under the hood),
+**_you'll need to start from scratch_** (unless you make them NFS shared folders).
+This is due to a limitation in Docker itself as we can't change those parameters
+after the container has been created.
+
+Forwarded ports automatic collision handling is **_not supported as well_**.
 
 
 ## Contributing
@@ -132,5 +204,3 @@ address available on my GitHub profile.
 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")