A Test Kitchen Driver for Docker.
Please read the Test Kitchen docs for more details.
Example .kitchen.local.yml
:
---
driver:
name: docker
platforms:
- name: ubuntu
run_list:
- recipe[apt]
- name: centos
driver_config:
image: centos
platform: rhel
run_list:
- recipe[yum]
This driver can determine an image and platform type for a select number of platforms.
Examples:
---
platforms:
- name: ubuntu-12.04
- name: centos-6.4
This will effectively generate a configuration similar to:
---
platforms:
- name: ubuntu-12.04
driver_config:
image: ubuntu:12.04
platform: ubuntu
- name: centos-6.4
driver_config:
image: centos:6.4
platform: centos
The Docker binary to use.
The default value is docker
.
Examples:
binary: docker.io
binary: /opt/docker
The Docker daemon socket to use. By default, Docker will listen on
unix:///var/run/docker.sock
, and no configuration here is required. If
Docker is binding to another host/port or Unix socket, you will need to set
this option. If a TCP socket is set, its host will be used for SSH access
to suite containers.
Examples:
socket: unix:///tmp/docker.sock
socket: tcp://docker.example.com:4242
If you use 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
The Docker image to use as the base for the suite containers. You can find images using the Docker Index.
The default will be computed, using the platform name (see the Default Configuration section for more details).
The platform of the chosen image. This is used to properly bootstrap the suite container for Test Kitchen. Kitchen Docker currently supports:
debian
orubuntu
rhel
orcentos
gentoo
orgentoo-paludis
The default will be computed, using the platform name (see the Default Configuration section for more details).
Determines whether or not a Chef Omnibus package will be installed. There are several different behaviors available:
true
- the latest release will be installed. Subsequent converges will skip re-installing if chef is present.latest
- the latest release will be installed. Subsequent converges will always re-install even if chef is present.<VERSION_STRING>
(ex:10.24.0
) - the desired version string will be passed the the install.sh script. Subsequent converges will skip if the installed version and the desired version match.false
ornil
- no chef is installed.
The default value is true
.
Disables upstart on Debian/Ubuntu containers, as many images do not support a working upstart.
The default value is true
.
Custom command(s) to be run when provisioning the base for the suite containers.
Examples:
provision_command: curl -L https://www.opscode.com/chef/install.sh | bash
provision_command:
- apt-get install dnsutils
- apt-get install telnet
driver_config:
provision_command: curl -L https://www.opscode.com/chef/install.sh | bash
require_chef_omnibus: false
This determines if the Docker cache is used when provisioning the base for suite containers.
The default value is true
.
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.
This determines if images are automatically removed when the suite container is destroyed.
The default value is false
.
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
.
Examples:
run_command: /sbin/init
Sets the memory limit for the suite container in bytes. Otherwise use Dockers
default. You can read more about memory.limit_in_bytes
here.
Sets the CPU shares (relative weight) for the suite container. Otherwise use Dockers defaults. You can read more about cpu.shares here.
Adds a data volume(s) to the suite container.
Examples:
volume: /ftp
volume:
- /ftp
- /srv
Mount volumes managed by other containers.
Examples:
volumes_from: repos
volumes_from:
- repos
- logging
- rvm
Adjusts resolv.conf
to use the dns servers specified. Otherwise use
Dockers defaults.
Examples:
dns: 8.8.8.8
dns:
- 8.8.8.8
- 8.8.4.4
Sets an http proxy for the suite container using the http_proxy
environment variable.
Examples:
http_proxy: http://proxy.host.com:8080
Sets an https proxy for the suite container using the https_proxy
environment variable.
Examples:
https_proxy: http://proxy.host.com:8080
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:
forward: 80
forward:
- 22:2222
- 80:8080
Set the suite container hostname. Otherwise use Dockers default.
Examples:
hostname: foobar.local
Run the suite container in privileged mode. This allows certain functionality inside the Docker container which is not otherwise permitted.
The default value is false
.
Examples:
privileged: true
Use a custom Dockerfile, instead of having Kitchen-Docker build one for you.
Examples:
dockerfile: test/Dockerfile
Set the name of container to link to other container(s).
Examples:
instance_name: web
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 exposed ports to the host interfaces. This option used to communicate between some containers.
The default value is false
.
Examples:
publish_all: true
- Source hosted at GitHub
- Report issues/questions/feature requests on GitHub Issues
Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:
- Fork the repo
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Created and maintained by Sean Porter ([email protected])
Apache 2.0 (see LICENSE)