README.md in vocker-0.3.3 vs README.md in vocker-0.4.0
- old
+ new
@@ -63,27 +63,43 @@
containers to run:
```ruby
Vagrant.configure("2") do |config|
config.vm.provision :docker do |docker|
+ # Things are changing pretty fast, you might want to lock the Docker
+ # version on the guest VM.
+ docker.version = '0.6.3' # default -> :latest
+
# If you just want to pull in some base images
docker.pull_images 'ubuntu', 'busybox'
# Command + image
docker.run 'echo ls -la --color', 'ubuntu'
# Unique container name + other configs
- docker.run 'date', image: 'ubuntu', cmd: '/bin/sh -c "while true; date; do echo hello world; sleep 1; done"'
+ docker.run 'app-1',
+ image: 'user/app',
+ ports: ['8080:80', '80', ':80'],
+ links: ['mysql:db'],
+ # Vocker will automagically create /var/lib/docker/mysql on the
+ # guest VM if it doesn't exist
+ volumes: ['/var/lib/docker/app:/var/lib/app'],
+ cmd: '/usr/bin/run-app'
# Base image (requires ENTRYPOINT / CMD) to be configured:
# * http://docs.docker.io/en/latest/use/builder/#entrypoint
# * http://docs.docker.io/en/latest/use/builder/#cmd
docker.run 'user/mysql'
- # If you need to go deeper, you can pass in additional `docker run` arguments
- # Same as: docker run -v /host:/container -p 1234:3306 user/patched-mysql /usr/bin/mysql
- docker.run mysql: { additional_run_args: '-v /host:/container -p 1234:3306', image: 'user/patched-mysql', cmd: '/usr/bin/mysql'}
+ # If you need to use some random / new parameter you can pass in additional
+ # arguments as wanted. The example below is the same as:
+ # docker run -v /host:/container -p 1234:3306 -d user/patched-mysql /usr/bin/mysql
+ docker.run mysql: {
+ additional_run_args: '-v /host:/container -p 1234:3306',
+ image: 'user/patched-mysql',
+ cmd: '/usr/bin/mysql'
+ }
end
end
```
The provisioner will also ensure that a single instance of the container is
@@ -110,12 +126,13 @@
### _your-awesome-vagrant-plugin™_
In case you want to build a Vagrant plugin that needs to interact with Docker you
can add this plugin as a dependency and use [DockerClient](lib/vocker/docker_client.rb)
-/ [DockerInstaller](lib/vocker/docker_installer.rb) classes. An example of usage
-will be provided _"soon"_.
+/ [DockerInstaller](lib/vocker/docker_installer.rb) classes. As an example you can
+check out [Ventriloquist](https://github.com/fgrehm/ventriloquist) that builds on top
+of this plugin.
### Usage with [vagrant-lxc](https://github.com/fgrehm/vagrant-lxc)
If you are on a Linux machine, you can use vagrant-lxc to avoid messing up with
@@ -162,5 +179,7 @@
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/vocker/trend.png)](https://bitdeli.com/free "Bitdeli Badge")