README.md in kitchen-docker-1.5.0 vs README.md in kitchen-docker-1.6.0
- old
+ new
@@ -92,10 +92,17 @@
```
socket: tcp://docker.example.com:4242
```
+If you use [Boot2Docker](https://github.com/boot2docker/boot2docker), set your `DOCKER_HOST` environment variable properly (e.g. `export DOCKER_HOST=tcp://192.168.59.103:2375`) or you have to use the following:
+
+```
+socket: tcp://192.168.59.103:2375
+```
+
+
### image
The Docker image to use as the base for the suite containers. You can find
images using the [Docker Index][docker_index].
@@ -107,10 +114,11 @@
The platform of the chosen image. This is used to properly bootstrap the
suite container for Test Kitchen. Kitchen Docker currently supports:
* `debian` or `ubuntu`
* `rhel` or `centos`
+* `gentoo` or `gentoo-paludis`
The default will be computed, using the platform name (see the Default
Configuration section for more details).
### require\_chef\_omnibus
@@ -163,10 +171,18 @@
This determines if the Docker cache is used when provisioning the base for suite
containers.
The default value is `true`.
+### use\_sudo
+
+This determines if Docker commands are run with `sudo`.
+
+The default value depends on the type of socket being used. For local sockets, the default value is `true`. For remote sockets, the default value is `false`.
+
+This should be set to `false` if you're using boot2docker, as every command passed into the VM runs as root by default.
+
### remove\_images
This determines if images are automatically removed when the suite container is
destroyed.
@@ -174,11 +190,11 @@
### run_command
Sets the command used to run the suite container.
-The default value is `/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no`.
+The default value is `/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no -o PasswordAuthentication=yes`.
Examples:
```
run_command: /sbin/init
@@ -208,12 +224,29 @@
volume:
- /ftp
- /srv
```
-## dns
+### volumes_from
+Mount volumes managed by other containers.
+
+Examples:
+
+```
+ volumes_from: repos
+```
+
+```
+ volumes_from:
+ - repos
+ - logging
+ - rvm
+```
+
+### dns
+
Adjusts `resolv.conf` to use the dns servers specified. Otherwise use
Dockers defaults.
Examples:
@@ -226,11 +259,11 @@
- 8.8.8.8
- 8.8.4.4
```
### http\_proxy
-Sets an http proxy for the suite container using the `http_proxy` environment variable.
+Sets an http proxy for the suite container using the `http_proxy` environment variable.
Examples:
```
http_proxy: http://proxy.host.com:8080
@@ -290,9 +323,50 @@
Examples:
```
dockerfile: test/Dockerfile
+```
+
+### instance_name
+
+Set the name of container to link to other container(s).
+
+Examples:
+
+```
+ instance_name: web
+```
+
+### links
+
+Set ```instance_name```(and alias) of other container(s) that connect from the suite container.
+
+Examples:
+
+```
+ links: db:db
+```
+
+Examples:
+
+```
+ links:
+ - db:db
+ - kvs:kvs
+```
+
+### publish_all
+
+Publish all exposed ports to the host interfaces.
+This option used to communicate between some containers.
+
+The default value is `false`.
+
+Examples:
+
+```
+ publish_all: true
```
## Development
* Source hosted at [GitHub][repo]