README.md in kitchen-docker-0.13.0 vs README.md in kitchen-docker-1.0.0.beta

- old
+ new

@@ -4,17 +4,13 @@ ## Requirements * [Docker][docker_getting_started] -## Known Issues - -* Upstart is neutered due to [this issue][docker_upstart_issue]. - ## Installation and Setup -Please read the [Driver usage][driver_usage] page for more details. +Please read the Test Kitchen [docs][test_kitchen_docs] for more details. Example `.kitchen.local.yml`: ``` --- @@ -24,12 +20,12 @@ - name: ubuntu run_list: - recipe[apt] - name: centos driver_config: - image: "centos" - platform: "rhel" + image: centos + platform: rhel run_list: - recipe[yum] ``` ## Default Configuration @@ -115,39 +111,58 @@ the installed version and the desired version match. * `false` or `nil` - no chef is installed. The default value is `true`. +### disable\_upstart + +Disables upstart on Debian/Ubuntu containers, as many images do not support a +working upstart. + +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 | bash" + provision_command: curl -L https://www.opscode.com/chef/install.sh | bash ``` ``` provision_command: - - "apt-get install dnsutils" - - "apt-get install telnet" + - apt-get install dnsutils + - apt-get install telnet ``` ``` driver_config: - provision_command: "curl -L https://www.opscode.com/chef/install.sh | bash" + provision_command: curl -L https://www.opscode.com/chef/install.sh | 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`. +### run_command + +Sets the command used to run the suite container. + +The default value is `/usr/sbin/sshd -D -o UseDNS=no -o UsePAM=no`. + +Examples: + +``` + run_command: /sbin/init +``` + ### memory Sets the memory limit for the suite container in bytes. Otherwise use Dockers default. You can read more about `memory.limit_in_bytes` [here][memory_limit]. @@ -259,9 +274,9 @@ [repo]: https://github.com/portertech/kitchen-docker [docker_getting_started]: http://www.docker.io/gettingstarted/ [docker_upstart_issue]: https://github.com/dotcloud/docker/issues/223 [docker_index]: https://index.docker.io/ [docker_default_image]: https://index.docker.io/_/base/ -[driver_usage]: http://docs.kitchen-ci.org/drivers/usage +[test_kitchen_docs]: http://kitchen.ci/docs/getting-started/ [chef_omnibus_dl]: http://www.opscode.com/chef/install/ [cpu_shares]: https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-cpu.html [memory_limit]: https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-memory.html