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+

• Amazon 2014.03.1 (experimental)
• CentOS 6
• Debian 7
• Fedora 19, 20
• Mac OS X (only docker installation currently)
• Oracle 6
• RHEL 6
• Ubuntu 12.04, 12.10, 13.04, 13.10, 14.04 (experimental)

Opscode Cookbooks

• apt
• git
• homebrew
• yum-epel

Third-Party Cookbooks

• aufs
• device-mapper
• golang
• lxc
• modules
• sysctl

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

If your system is running a Docker version before 0.9, you'll need to explicitly set up LXC outside of this cookbook. This will likely be true for most distros after Docker 1.0 and chef-docker 1.0 is released.

• lxc on community site
• lxc on Github

Beginning in chef-docker 1.0, storage driver installation and configuration is expected to be handled before this cookbook's execution, except where required by Docker.

If you need AUFS support, consider adding the aufs cookbook to your node/recipe before docker.

• aufs on community site
• chef-aufs on Github

Then, set the storage_driver attribute of this cookbook to aufs.

If you need device-mapper support, consider adding the device-mapper cookbook to your node/recipe before docker.

• device-mapper on community site
• chef-device-mapper on Github

Then, set the storage_driver attribute of this cookbook to devicemapper (please note lack of dash).

By default, this cookbook will use the docker.io package from Ubuntu 14.04's repository. To use the Docker PPA package, just set the repo_url attribute to the Docker PPA URL. e.g. node.set['docker']['package']['repo_url'] = 'https://get.docker.io/ubuntu'

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.

For more information: http://docs.docker.io/en/latest/reference/commandline/cli/#daemon

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

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

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

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

These attributes are under the node['docker'] 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::devicemapper] Installs/Configures Device Mapper
• recipe[docker::group] Installs/Configures docker group
• recipe[docker::lxc] Installs/configures default platform LXC support
• recipe[docker::package] Installs Docker via package
• recipe[docker::runit] Installs/Starts Docker via runit
• 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 imagedocker_image'samalba/docker-registry'# Run container exposing portsdocker_container'samalba/docker-registry'dodetachtrueport'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 registrydocker_registry'https://docker-registry.example.com/'dousername'shipper'password'iloveshipping'end# Pull tagged imagedocker_image'apps/crowsnest'dotag'not-latest'end# Run containerdocker_container'crowsnest'# Save current timestamptimestamp=Time.new.strftime('%Y%m%d%H%M')# Commit container changesdocker_container'crowsnest'dorepository'apps'tagtimestampaction:commitend# Push imagedocker_image'crowsnest'dorepository'apps'tagtimestampaction:pushend

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'dorepository'myRepo'tagTime.new.strftime("%Y%m%d%H%M")run'{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}'action:commitend

These attributes are associated with this LWRP action.

Copying a file from container to host:

docker_container'myApp'dosource'/path/to/container/file'destination'/path/to/save/on/host'action:cpend

These attributes are associated with this LWRP action.

Exporting container to host:

docker_container'myApp'dodestination'/path/to/save/on/host.tgz'action:exportend

These attributes are associated with this LWRP action.

Kill a running container:

docker_container'shipyard'doaction:killend

Send SIGQUIT to a running container:

docker_container'shipyard'dosignal'QUIT'action:killend

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'doaction:pullnotifies:redeploy,'docker_container[shipyard]',:immediatelyenddocker_container'shipyard'do# Other attributesaction:runend

These attributes are associated with this LWRP action.

Remove a container:

docker_container'shipyard'doaction:removeend

These attributes are associated with this LWRP action.

Remove a container:

docker_container'shipyard'dolink'foo'action:remove_linkend

These attributes are associated with this LWRP action.

Remove a container:

docker_container'shipyard'dovolume%w(/extravol1/extravol2)action:remove_volumeend

These attributes are associated with this LWRP action.

Restart a container:

docker_container'shipyard'doaction:restartend

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'dodetachtrueend

Run a container via command:

docker_container'busybox'docommand'sleep 9999'detachtrueend

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

docker_container'docker-registry'doimage'samalba/docker-registry'detachtruehostname'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'doaction:startend

These attributes are associated with this LWRP action.

Stop a running container:

docker_container'shipyard'doaction:stopend

Wait for a container to finish:

docker_container'busybox'docommand'sleep 9999'action:waitend

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'dotag'myTag'source'myImageDockerfile'action:build_if_missingend

Build image from remote repository:

docker_image'myImage'dosource'example.com/foo/myImage'tag'myTag'action:build_if_missingend

Conditionally rebuild image if changes upstream:

git"#{Chef::Config[:file_cache_path]}/docker-testcontainerd"dorepository'[email protected]:bflad/docker-testcontainerd.git'notifies:build,'docker_image[bflad/testcontainerd]',:immediatelyenddocker_image'bflad/testcontainerd'doaction:pull_if_missingend

These attributes are associated with this LWRP action.

Import image from local directory:

docker_image'test'dosource'/path/to/test'action:importend

Import image from local file:

docker_image'test'dosource'/path/to/test.tgz'action:importend

Import image from remote URL:

docker_image'test'dosource'https://example.com/testimage.tgz'action:importend

ACTION DEPRECATED AS OF DOCKER 0.10.0

These attributes are associated with this LWRP action.

Insert file from remote URL:

docker_image'test'dosource'http://example.com/some/file.txt'destination'/container/path/for/some/file.txt'action:insertend

These attributes are associated with this LWRP action.

Load repository via input:

docker_image'test'doinput'/path/to/test.tar'action:loadend

Load repository via stdin:

docker_image'test'dosource'/path/to/test.tgz'action:loadend

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'doaction:pull_if_missingend

Pull tagged image:

docker_image'bflad/test'dotag'not-latest'end

Push image (after logging in with docker_registry):

docker_image'bflad/test'doaction:pushend

These attributes are associated with this LWRP action.

Remove image:

docker_image'busybox'doaction:removeend

These attributes are associated with this LWRP action.

Save repository via file to path:

docker_image'test'dodestination'/path/to/test.tar'action:saveend

Save repository via stdout to path:

docker_image'test'dodestination'/path/to/test.tgz'action:saveend

These attributes are associated with this LWRP action.

Tag image:

docker_image'test'dorepository'bflad'tag'1.0.0'action:tagend

These attributes are associated with all LWRP actions.

These attributes are associated with this LWRP action.

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

• Brian Flad ([email protected])

Please see licensing information in: LICENSE