Kitchen::Docker
A Test Kitchen Driver for Docker.
Requirements
Known Issues
- Upstart is neutered due to this issue.
Installation and Setup
Please read the Driver usage page for more details.
Example .kitchen.local.yml
:
---
driver_plugin: docker
platforms:
- name: ubuntu
run_list:
- recipe[apt]
- name: centos
driver_config:
image: "centos"
platform: "rhel"
run_list:
- recipe[yum]
Default Configuration
This driver can determine an image and platform type for a select number of platforms. Currently, the following platform names are supported:
---
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
Configuration
image
The Docker image to use as the base for the suite containers. You can find images using the Docker Index.
The default will be determined by the Platform name, if a default exists
(see the Default Configuration section for more details). If a default
cannot be computed, then the default value is base
, an official Ubuntu
image.
platform
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
The default will be determined by the Platform name, if a default exists
(see the Default Configuration section for more details). If a default
cannot be computed, then the default value is ubuntu
.
require_chef_omnibus
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
.
provision_command
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 | sudo bash"
provision_command:
- "apt-get install dnsutils"
- "apt-get install telnet"
driver_config:
provision_command: "curl -L https://www.opscode.com/chef/install.sh | sudo bash"
require_chef_omnibus: false
remove_images
This determines if images are automatically removed when the suite container is destroyed.
The default value is false
.
memory
Sets the memory limit for the container. The value must be set in bytes.
If not, set it defaults to dockers default settings. You can read more about
memory.limit_in_bytes
here.
cpu
Sets the cpu shares (relative weight). If not set, it defaults to dockers default settings. You can read more about cpu.shares here.
volume
Adds a data volume(s) to the suite container.
Examples:
volume: /ftp
volume:
- /ftp
- /srv
dns
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
forward
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
Development
- 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
Authors
Created and maintained by Sean Porter ([email protected])
License
Apache 2.0 (see LICENSE)