vagrant-docker-exec 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a47b067ae76cfe4241eab65923a7bf7dec1ff97
-  data.tar.gz: a7f00da4483def3cff1a59ce5c262403e945cdcc
+  metadata.gz: 155ffbcbbfec33a327d2b9b6ca2f4b699008bd26
+  data.tar.gz: 68ae686a177b542528685d50572fa52f959491e3
 SHA512:
-  metadata.gz: 66782044d634db1376cc4ff5e3a7deef79672ddc5f733341ddd78615e1063de0556af8157c60406529dab4cfb90159a7308bc379e0667452b05f02af8f7e68c5
-  data.tar.gz: c94b760053791a52746b5247f760870729edb5d8057a8520c0a1e744d65e0a078dc950ba8bd01919c8766464bfadbf2eded4ed418da5f7764549e1220c3c7c2d
+  metadata.gz: aa3666d20522139c77a10f67828f35aeb2fbb1456f0ea04124de1bc0bc3aba1107f98aca67c06c0b9f96fabe23b799b5a3998732821e33c92949d8488da6289c
+  data.tar.gz: 9ff983923ceab8c2faca130b20f3412911267fe91e950bdda4280fec68c3d215282f879e1e1059515d0226a34aecebb2aa869ede989281c64680d5ac66468fa1

data/CHANGELOG.md

@@ -1,7 +1,11 @@
-# 0.1.1 (March 1, 2015)
+## 0.1.2 (March 5, 2015)
+
+* Exec commands terminal output is now diplayed
+
+## 0.1.1 (March 1, 2015)
 
 * Fixed a bug that caused exec commands to fail
 
-# 0.1.0 (March 1, 2015)
+## 0.1.0 (March 1, 2015)
 
 * Initial release.

data/README.md

@@ -1,43 +1,109 @@
 # vagrant-docker-exec
-
-This plugin allows you to run `docker exec` on a running container.
+This plugin allows you to run `docker exec` commands from your host. When running docker in a proxy, this will save you the effort of sshing into the proxy to run `docker exec`. If you have multiple running containers, you can exec a command that runs on each container sequentially. Visit [Docker's command reference](https://docs.docker.com/reference/commandline/cli/#exec) for details on the exec command.
 
 ## Known Issues
+Docker exec requires Docker 1.3.0 or higher. On non-Linux system, the docker in boot2docker provided by Vagrant is version 1.2 and does not support the exec command, so a custom docker host is required.
 
-Docker exec requires Docker 1.3.0 or higher. boot2docker provided by Vagrant is version 1.2 and does not support exec, so a proxy VM is required to use
-this plugin until boot2docker is updated.
+You can find more information on setting up a custom docker host on the [Vagrant blog](http://www.vagrantup.com/blog/feature-preview-vagrant-1-6-docker-dev-environments.html) but basically, create Vagrantfile.proxy:
 
-This plugin has been tested on Mac OS X.
+```ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+Vagrant.configure(2) do |config|
+  config.vm.box = "phusion/ubuntu-14.04-amd64"
+  config.vm.provision "docker"
+  config.vm.network :forwarded_port, host: 80, guest: 80
+  config.vm.provider :virtualbox do |vb|
+    vb.name = "docker-exec-proxy"
+  end
+end
+```
 
-## Getting Started
+And then use the vagrant_vagrantfile setting to reference your custom host in your Vagrantfile:
+
+```ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+Vagrant.configure(2) do |config|
+  config.vm.define "nginx" do |v|
+    v.vm.provider "docker" do |d|
+      d.image   = "dockerfile/nginx"
+      d.ports   = ["80:80"]
+      d.name    = "nginx"
+      d.vagrant_vagrantfile = "./Vagrantfile.proxy"
+    end
+  end
+end
+```
 
+This plugin has been tested on Mac OS X and VirtualBox.
+
+## Getting Started
 To install the plugin, run the following command:
 ```bash
 vagrant plugin install vagrant-docker-exec
 ```
 
 ## Usage
+A common use case for the exec command is to open a new shell in a running conatiner. To make it easy, run the `docker-shell` shortcut:
+```bash
+vagrant docker-shell [container]
+```
 
+If you're running a docker host, then you are running in a multi-host environment and the container name is required, even if only one docker container is running.
+
+`docker-shell` is a shortcut for running Bash in an interactive shell:
+```bash
+vagrant docker-exec -t nginx -- bash
+```
+
+The syntax for `docker-exec` is:
 ```bash
 vagrant docker-exec [options] [container] -- [command] [args]
 ```
---[no-]detach Run in the background
 
+Options are:  
+--[no-]detach Run in the background  
 -t, --[no-]tty Open an interactive shell
 
-To create a new file in a container named `nginx`
+Everything after the double hyphen is sent to docker's exec command.
+
+As an example, to create a new file in a container named `nginx`:
 
 ```bash
 vagrant docker-exec nginx -- touch /var/www/html/test.html
 ```
 
-To open an interactive shell in a conatiner named `nginx`
+If the command produces output, the output will be prefixed with the name of the container.
+```bash
+vagrant docker-exec nginx -- ifconfig
+==> nginx: eth0      Link encap:Ethernet  HWaddr 02:42:ac:11:00:02  
+==> nginx:           inet addr:172.17.0.2  Bcast:0.0.0.0  Mask:255.255.0.0
+==> nginx:           inet6 addr: fe80::42:acff:fe11:2/64 Scope:Link
+==> nginx:           UP BROADCAST RUNNING  MTU:1500  Metric:1
+==> nginx:           RX packets:24 errors:0 dropped:0 overruns:0 frame:0
+==> nginx:           TX packets:8 errors:0 dropped:0 overruns:0 carrier:0
+==> nginx:           collisions:0 txqueuelen:0 
+==> nginx:           RX bytes:1944 (1.9 KB)  TX bytes:648 (648.0 B)
+==> nginx: 
+==> nginx: lo        Link encap:Local Loopback  
+==> nginx:           inet addr:127.0.0.1  Mask:255.0.0.0
+==> nginx:           inet6 addr: ::1/128 Scope:Host
+==> nginx:           UP LOOPBACK RUNNING  MTU:65536  Metric:1
+==> nginx:           RX packets:0 errors:0 dropped:0 overruns:0 frame:0
+==> nginx:           TX packets:0 errors:0 dropped:0 overruns:0 carrier:0
+==> nginx:           collisions:0 txqueuelen:0 
+==> nginx:           RX bytes:0 (0.0 B)  TX bytes:0 (0.0 B)
+```
 
+The name of the container is only required for interactive shells. To run a command on multiple running containers, omit the container name:
 ```bash
-vagrant docker-exec -t nginx -- bash
+vagrant docker-exec -- hostname
+==> nginx: 231e57e57825
+==> nginx2: 6ebced94866b
 ```
 
-To simplify opening a shell, you can use the shortcut `vagrant docker-shell [container]`
+Note that all exec commands run by docker are run as the root user.
 
 ## Author
 William Kolean william.kolean@gmail.com

data/lib/vagrant-docker-exec/command/exec.rb

@@ -76,7 +76,12 @@ module VagrantPlugins
         #@env.ui.info(exec_cmd.flatten)
 
         output = ""
-        machine.provider.driver.execute(*exec_cmd, exec_options)
+        machine.provider.driver.execute(*exec_cmd, exec_options) do |type, data|
+          output += data
+        end
+
+        output_options = {}
+        machine.ui.output(output.chomp!, **output_options) if !output.empty?
 
       end
 

data/lib/vagrant-docker-exec/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module DockerExec
-  	VERSION = "0.1.1"
+  	VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-docker-exec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - William Kolean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: docker-exec runs a new command in a running container.