Installs/Configures Docker. Please see COMPATIBILITY.md for more information about Docker versions that are tested and supported by cookbook versions along with LWRP features.

This cookbook was inspired by @thoward's docker-cookbook: https://github.com/thoward/docker-cookbook

• Chef 11+

• CentOS 6
• Debian 7 (experimental)
• Fedora 19
• Fedora 20
• Oracle 6 (experimental)
• RHEL 6
• Ubuntu 12.04
• Ubuntu 12.10
• Ubuntu 13.04
• Ubuntu 13.10 (experimental)

Opscode Cookbooks

• apt
• git
• yum-epel

Third-Party Cookbooks

• golang
• lxc
• modules
• sysctl

These attributes are under the node['docker'] namespace.

These attributes are under the node['docker']['binary'] namespace.

These attributes are under the node['docker']['package'] namespace.

These attributes are under the node['docker']['source'] namespace.

• recipe[docker] Installs/Configures Docker
• recipe[docker::aufs] Installs/Loads AUFS Linux module
• recipe[docker::binary] Installs Docker binary
• recipe[docker::cgroups] Installs/configures default platform Control Groups support
• recipe[docker::devmapper] Installs/Configures Device Mapper
• recipe[docker::lxc] Installs/configures default platform LXC support
• recipe[docker::package] Installs Docker via package
• recipe[docker::source] Installs Docker via source
• recipe[docker::systemd] Installs/Starts Docker via systemd
• recipe[docker::sysv] Installs/Starts Docker via SysV
• recipe[docker::upstart] Installs/Starts Docker via Upstart

• 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 LWRP and action below for more information.

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

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

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.

Restart a container:

docker_container 'shipyard' do
  action :restart
end

By default, this will handle creating a service for the container when action is 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 'xx.xx.xx.xx'
  port 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
end

Build image from remote repository:

docker_image 'myImage' do
  source 'example.com/foo/myImage'
  tag 'myTag'
  action :build
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.

Insert file from remote URL:

docker_image 'test' do
  source 'http://example.com/some/file.txt'
  destination '/container/path/for/some/file.txt'
  action :insert
end

These attributes are associated with this LWRP action.

Load repository from path:

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

Remove image:

docker_image 'busybox' do
  action :remove
end

These attributes are associated with this LWRP action.

Save repository 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

These attributes are associated with all LWRP actions.

These attributes are associated with this LWRP action.

Log into public registry:

docker_registry 'https://index.docker.io/v1/' do
  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

Register with registry:

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

• Add recipe[docker] to your node's run list

• 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

• Brian Flad ([email protected])

Please see licensing information in: LICENSE