The Docker Cookbook is a library cookbook that provides resources (LWRPs) for use in recipes.

In version 1.0 of this cookbook, we have made a significant breaking changes including the way that we handle resources (docker_image, docker_container and docker_registry). It is highly recommended that you constrain the version of the cookbook you are using in the appropriate places.

• metadata.rb
• Chef Environments
• Berksfile
• Chef Policyfile

More details about specific changes will be documented in the 1.0_CHANGES.md file.

This cookbook is concerned with the Docker container engine as distributed by Docker, Inc. It does not address with docker ecosystem tooling or prerequisite technology such as cgroups or aufs.

• Chef 11 or higher
• Ruby 1.9 or higher (preferably from the Chef full-stack installer)
• Network accessible web server hosting the docker binary.

The following platforms have been tested with Test Kitchen:

|--------------+-------|
|              | 1.6.0 |
|--------------+-------|
| amazon       | X     |
|--------------+-------|
| centos-6     | X     |
|--------------+-------|
| centos-7     | X     |
|--------------+-------|
| fedora-21    | X     |
|--------------+-------|
| debian-7     | X     |
|--------------+-------|
| ubuntu-12.04 | X     |
|--------------+-------|
| ubuntu-14.04 | X     |
|--------------+-------|
| ubuntu-15.04 | X     |
|--------------+-------|

• none!

• Add depends 'docker', '~> 1.0' to your cookbook's metadata.rb
• Place resources shipped in this cookbook in a recipe, the same way you'd use core Chef resources (file, template, directory, package, etc).

docker_service 'default' do
  action [:create, :start]
end

docker_image 'busybox' do
  action :pull
end

docker_container 'an echo server' do
  image 'busybox'
  port '1234:1234'
  command "nc -ll -p 1234 -e /bin/cat"
  detach true
  init_type false
end

The cookbooks ran under test-kitchen make excellent usage examples. The above recipe is actually used as a smoke test, and is converged by test-kitchen during development. It is located in this repo at test/cookbooks/docker_test/recipes/hello_world.rb

More example recipes can be found at:

test/cookbooks/docker_test/
test/cookbooks/docker_service_test/

Beginning in chef-docker 1.0, support for LXC execution driver has been removed in favor of native. Cgroups and storage drivers are now loosely coupled dependencies and should be configured using other cookbooks.

Storage drivers can be selected with the storage_driver property on the docker_service resource like this:

docker_service 'default' do
   storage_driver 'overlay'
end

Configuration of the backing storage driver, including kernel module loading, is out of scope for this cookbook.

• docker_service: docker daemon installation and configuration
• docker_container: container operations
• docker_image: image/repository operations
• docker_registry: registry operations

Here's a quick example of pulling the latest image and running a container with exposed ports (creates service automatically):

# Pull latest image
docker_image 'samalba/docker-registry'

# Run container exposing ports
docker_container 'samalba/docker-registry' do
  detach true
  port '5000:5000'
  env 'SETTINGS_FLAVOR=local'
  volume '/mnt/docker:/docker-storage'
end

Maybe you want to automatically update your private registry with changes from your container?

# Login to private registry
docker_registry 'https://docker-registry.example.com/' do
  username 'shipper'
  password 'iloveshipping'
end

# Pull tagged image
docker_image 'apps/crowsnest' do
  tag 'not-latest'
end

# Run container
docker_container 'crowsnest'

# Save current timestamp
timestamp = Time.new.strftime('%Y%m%d%H%M')

# Commit container changes
docker_container 'crowsnest' do
   repository 'apps'
   tag timestamp
   action :commit
end

# Push image
docker_image 'crowsnest' do
  repository 'apps'
  tag timestamp
  action :push
end

See full documentation for each resource and action below for more information.

The docker_service, docker_image, docker_container, and docker_registry resources are documented in full below.

The docker_service manages a Docker daemon.

The :create action manages software installation. The :start action manages the running docker service on the machine.

The service management strategy for the host platform is dynamically chosen based on platform, but can be overridden. See the "providers" section below for more information.

docker_service 'tls_test:2376' do
  host ["tcp://#{node['ipaddress']}:2376", 'unix:///var/run/docker.sock']
  tlscacert '/path/to/ca.pem'
  tlscert '/path/to/server.pem'
  tlskey '/path/to/serverkey.pem'
  tlsverify true
  provider Chef::Provider::DockerService::Systemd
  action [:create, :start]
end

WARNING - As of the 1.0 version of this cookbook, docker_service is a singleton resource. This means that if you create multiple docker_service resources on the same machine, you will only create one actual service and things may not work as expected.

The docker_service resource property list mostly corresponds to the options found in the Docker Command Line Reference

• source - URL to the pre-compiled Docker binary used for installation. Defaults to a calculated URL based on kernel version, Docker version, and platform arch. By default, this will try to get to "http://get.docker.io/builds/".
• version - Docker version to install
• checksum - sha256 checksum of Docker binary
• instance - Identity for docker_service resource. Defaults to name. Mostly unimportant for the 1.0 version because of its singleton status. | String | nil
• api_cors_header - Set CORS headers in the remote API
• bridge - Attach containers to a network bridge
• bip - Specify network bridge IP
• debug - Enable debug mode
• daemon - Enable daemon mode
• dns - DNS server to use
• dns_search - DNS search domains to use
• exec_driver - Exec driver to use
• fixed_cidr - IPv4 subnet for fixed IPs
• fixed_cidr_v6 - IPv6 subnet for fixed IPs
• group - Posix group for the unix socket
• graph - Root of the Docker runtime - Effectively, the "data directory"
• host - Daemon socket(s) to connect to - tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd
• icc - Enable inter-container communication
• ip - Enable inter-container communication
• ip_forward - Enable ip forwarding
• ipv4_forward - Enable net.ipv4.ip_forward
• ipv6_forward - Enable net.ipv6.ip_forward
• ip_masq - Enable IP masquerading
• iptables - Enable addition of iptables rules
• ipv6 - Enable IPv6 networking
• log_level - Set the logging level
• label - Set key=value labels to the daemon
• log_driver - Container's logging driver (json-file/none)
• mtu - Container's logging driver (json-file/none)
• pidfile - Path to use for daemon PID file
• registry_mirror - Preferred Docker registry mirror
• storage_driver - Storage driver to use
• selinux_enabled - Enable selinux support
• storage_opt - Set storage driver options
• tls - Use TLS; implied by --tlsverify
• tlscacert - Trust certs signed only by this CA
• tlscert - Path to TLS certificate file
• tlskey - Path to TLS key file
• tlsverify - Use TLS and verify the remote
• default_ulimit - Set default ulimit settings for containers
• http_proxy - ENV variable set before for Docker daemon starts
• https_proxy - ENV variable set before for Docker daemon starts
• no_proxy - ENV variable set before for Docker daemon starts
• tmpdir - ENV variable set before for Docker daemon starts
• logfile - Location of Docker daemon log file

Below are the available actions for the LWRP, default being run.

These attributes are associated with all LWRP actions.

These attributes are associated with this LWRP action.

Commit a container with optional repository, run specification, and tag:

docker_container 'myApp' do
repository 'myRepo'
tag Time.new.strftime("%Y%m%d%H%M")
run '{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}'
action :commit
end

These attributes are associated with this LWRP action.

Copying a file from container to host:

docker_container 'myApp' do
  source '/path/to/container/file'
  destination '/path/to/save/on/host'
  action :cp
end

By default, this will handle creating a service for the container when action is create, run or start. set['docker']['container_init_type'] = false or add init_type false for LWRP to disable this behavior.

Attributes for this action can be found in the run action (except for the detach attribute).

These attributes are associated with this LWRP action.

Exporting container to host:

docker_container 'myApp' do
  destination '/path/to/save/on/host.tgz'
  action :export
end

These attributes are associated with this LWRP action.

Kill a running container:

docker_container 'shipyard' do
  action :kill
end

Send SIGQUIT to a running container:

docker_container 'shipyard' do
  signal 'QUIT'
  action :kill
end

Stops, removes, and runs a container. Useful for notifications from image build/pull.

Attributes for this action can be found in the stop, remove, and run actions.

Redeploy container when new image is pulled:

docker_image 'shipyard/shipyard' do
  action :pull
  notifies :redeploy, 'docker_container[shipyard]', :immediately
end

docker_container 'shipyard' do
  # Other attributes
  action :run
end

These attributes are associated with this LWRP action.

Remove a container:

docker_container 'shipyard' do
  action :remove
end

These attributes are associated with this LWRP action.

Remove a container:

docker_container 'shipyard' do
  link 'foo'
  action :remove_link
end

These attributes are associated with this LWRP action.

Remove a container:

docker_container 'shipyard' do
  volume %w(/extravol1 /extravol2)
  action :remove_volume
end

These attributes are associated with this LWRP action.

Restart a container:

docker_container 'shipyard' do
  action :restart
end

By default, this will handle creating a service for the container when action is create, run or start. set['docker']['container_init_type'] = false or add init_type false for LWRP to disable this behavior.

These attributes are associated with this LWRP action.

Run a container:

docker_container 'myImage' do
  detach true
end

Run a container via command:

docker_container 'busybox' do
  command 'sleep 9999'
  detach true
end

Run a container from image (docker-registry for example):

docker_container 'docker-registry' do
  image 'samalba/docker-registry'
  detach true
  hostname 'docker-registry.example.com'
  port '5000:5000'
  env 'SETTINGS_FLAVOR=local'
  volume '/mnt/docker:/docker-storage'
end

These attributes are associated with this LWRP action.

Start a stopped container:

docker_container 'shipyard' do
  action :start
end

These attributes are associated with this LWRP action.

Stop a running container:

docker_container 'shipyard' do
  action :stop
end

Wait for a container to finish:

docker_container 'busybox' do
  command 'sleep 9999'
  action :wait
end

Below are the available actions for the LWRP, default being pull.

These attributes are associated with all LWRP actions.

These attributes are associated with this LWRP action.

Build image from Dockerfile:

docker_image 'myImage' do
  tag 'myTag'
  source 'myImageDockerfile'
  action :build_if_missing
end

Build image from remote repository:

docker_image 'myImage' do
  source 'example.com/foo/myImage'
  tag 'myTag'
  action :build_if_missing
end

Conditionally rebuild image if changes upstream:

git "#{Chef::Config[:file_cache_path]}/docker-testcontainerd" do
  repository '[email protected]:bflad/docker-testcontainerd.git'
  notifies :build, 'docker_image[tduffield/testcontainerd]', :immediately
end

docker_image 'tduffield/testcontainerd' do
  action :pull_if_missing
end

These attributes are associated with this LWRP action.

Import image from local directory:

docker_image 'test' do
  source '/path/to/test'
  action :import
end

Import image from local file:

docker_image 'test' do
  source '/path/to/test.tgz'
  action :import
end

Import image from remote URL:

docker_image 'test' do
  source 'https://example.com/testimage.tgz'
  action :import
end

These attributes are associated with this LWRP action.

Load repository via input:

docker_image 'test' do
  input '/path/to/test.tar'
  action :load
end

Load repository via stdin:

docker_image 'test' do
  source '/path/to/test.tgz'
  action :load
end

These attributes are associated with this LWRP action.

Pull latest image every Chef run:

docker_image 'busybox'

Pull latest image only if missing:

docker_image 'busybox' do
  action :pull_if_missing
end

Pull tagged image:

docker_image 'bflad/test' do
  tag 'not-latest'
end

Push image (after logging in with docker_registry):

docker_image 'bflad/test' do
  action :push
end

These attributes are associated with this LWRP action.

Remove image:

docker_image 'busybox' do
  action :remove
end

These attributes are associated with this LWRP action.

Save repository via file to path:

docker_image 'test' do
  destination '/path/to/test.tar'
  action :save
end

Save repository via stdout to path:

docker_image 'test' do
  destination '/path/to/test.tgz'
  action :save
end

These attributes are associated with this LWRP action.

Tag image:

docker_image 'test' do
  repository 'bflad'
  tag '1.0.0'
  action :tag
end

FIXME: blah blah blah

Log into or register with public registry:

docker_registry 'https://index.docker.io/v1/' do
  email '[email protected]'
  username 'publicme'
  password 'hope_this_is_in_encrypted_databag'
end

Log into private registry with optional port:

docker_registry 'https://docker-registry.example.com:8443/' do
   username 'privateme'
   password 'still_hope_this_is_in_encrypted_databag'
end

• Quickly testing with Vagrant: VAGRANT.md
• Full development and testing workflow with Test Kitchen and friends: TESTING.md

Please see contributing information in: CONTRIBUTING.md

• Tom Duffield (http://tomduffield.com)
• Brian Flad ([email protected])
• Fletcher Nichol ([email protected])
• Sean OMeara ([email protected])

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.