README.md in kitchen-docker-2.1.0 vs README.md in kitchen-docker-2.2.0

- old
+ new

@@ -10,11 +10,11 @@ Please read the Test Kitchen [docs][test_kitchen_docs] for more details. Example `.kitchen.local.yml`: -``` +```yaml --- driver: name: docker platforms: @@ -34,20 +34,20 @@ This driver can determine an image and platform type for a select number of platforms. Examples: -``` +```yaml --- platforms: - name: ubuntu-12.04 - name: centos-6.4 ``` This will effectively generate a configuration similar to: -``` +```yaml --- platforms: - name: ubuntu-12.04 driver_config: image: ubuntu:12.04 @@ -66,15 +66,15 @@ The default value is `docker`. Examples: -``` +```yaml binary: docker.io ``` -``` +```yaml binary: /opt/docker ``` ### socket @@ -84,21 +84,21 @@ this option. If a TCP socket is set, its host will be used for SSH access to suite containers. Examples: -``` +```yaml socket: unix:///tmp/docker.sock ``` -``` +```yaml 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: -``` +```yaml socket: tcp://192.168.59.103:2375 ``` ### image @@ -148,21 +148,21 @@ Custom command(s) to be run when provisioning the base for the suite containers. Examples: -``` +```yaml provision_command: curl -L https://www.opscode.com/chef/install.sh | bash ``` -``` +```yaml provision_command: - apt-get install dnsutils - apt-get install telnet ``` -``` +```yaml driver_config: provision_command: curl -L https://www.opscode.com/chef/install.sh | bash require_chef_omnibus: false ``` @@ -190,15 +190,15 @@ ### 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 -o PasswordAuthentication=yes`. +The default value is `/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no -o PasswordAuthentication=yes -o UsePrivilegeSeparation=no -o PidFile=/tmp/sshd.pid`. Examples: -``` +```yaml run_command: /sbin/init ``` ### memory @@ -214,15 +214,15 @@ Adds a data volume(s) to the suite container. Examples: -``` +```yaml volume: /ftp ``` -``` +```yaml volume: - /ftp - /srv ``` @@ -230,15 +230,15 @@ Mount volumes managed by other containers. Examples: -``` +```yaml volumes_from: repos ``` -``` +```yaml volumes_from: - repos - logging - rvm ``` @@ -248,49 +248,49 @@ Adjusts `resolv.conf` to use the dns servers specified. Otherwise use Dockers defaults. Examples: -``` +```yaml dns: 8.8.8.8 ``` -``` +```yaml dns: - 8.8.8.8 - 8.8.4.4 ``` ### http\_proxy Sets an http proxy for the suite container using the `http_proxy` environment variable. Examples: -``` +```yaml http_proxy: http://proxy.host.com:8080 ``` ### https\_proxy Sets an https proxy for the suite container using the `https_proxy` environment variable. Examples: -``` +```yaml https_proxy: http://proxy.host.com:8080 ``` ### forward Set suite container port(s) to forward to the host machine. You may specify the host (public) port in the mappings, if not, Docker chooses for you. Examples: -``` +```yaml forward: 80 ``` -``` +```yaml forward: - 22:2222 - 80:8080 ``` @@ -298,11 +298,11 @@ Set the suite container hostname. Otherwise use Dockers default. Examples: -``` +```yaml hostname: foobar.local ``` ### privileged @@ -311,84 +311,81 @@ The default value is `false`. Examples: -``` +```yaml privileged: true ``` ### cap\_add Adds a capability to the running container. Examples: -```` +```yaml cap_add: - SYS_PTRACE -```` +``` ### cap\_drop Drops a capability from the running container. Examples: -```` +```yaml cap_drop: - CHOWN +``` -```` - ### security\_opt Apply a security profile to the Docker container. Allowing finer granularity of access control than privileged mode, through leveraging SELinux/AppArmor profiles to grant access to specific resources. Examples: -``` +```yaml security_opt: - apparmor:my_profile ``` ### dockerfile Use a custom Dockerfile, instead of having Kitchen-Docker build one for you. Examples: -``` +```yaml dockerfile: test/Dockerfile ``` ### instance\_name Set the name of container to link to other container(s). Examples: -``` +```yaml instance_name: web ``` ### links Set ```instance_name```(and alias) of other container(s) that connect from the suite container. Examples: -``` +```yaml links: db:db ``` -Examples: - -``` +```yaml links: - db:db - kvs:kvs ``` @@ -399,11 +396,27 @@ The default value is `false`. Examples: -``` +```yaml publish_all: true +``` + +### devices + +Share a host device with the container. Host device must be an absolute path. + +Examples: + +``` +devices: /dev/vboxdrv +``` + +``` +devices: + - /dev/vboxdrv + - /dev/vboxnetctl ``` ## Development * Source hosted at [GitHub][repo]