README.md in kitchen-docker-0.3.0 vs README.md in kitchen-docker-0.4.0

- old
+ new

@@ -1,18 +1,18 @@ -# <a name="title"></a> Kitchen::Docker +# Kitchen::Docker A Test Kitchen Driver for Docker. -## <a name="requirements"></a> Requirements +## Requirements * [Docker][docker_getting_started] -## <a name="issues"></a> Known Issues +## Known Issues * Upstart is neutered due to [this issue][docker_upstart_issue]. -## <a name="installation"></a> Installation and Setup +## Installation and Setup Please read the [Driver usage][driver_usage] page for more details. Example `.kitchen.local.yml`: @@ -30,30 +30,30 @@ platform: "rhel" run_list: - recipe[yum] ``` -## <a name="config"></a> Configuration +## Configuration -### <a name="config-image"></a> image +### image The Docker image to use as the base for the suite containers. You can find images using the [Docker Index][docker_index]. The default value is `base`, an official Ubuntu [image][docker_default_image]. -### <a name="config-platform"></a> platform +### platform The platform of the chosen image. This is used to properly bootstrap the suite container for Test Kitchen. Kitchen Docker currently supports: * `debian` or `ubuntu` * `rhel` or `centos` The default value is `ubuntu`. -### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus +### require\_chef\_omnibus Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be installed. There are several different behaviors available: * `true` - the latest release will be installed. Subsequent converges @@ -65,12 +65,63 @@ the installed version and the desired version match. * `false` or `nil` - no chef is installed. The default value is `true`. -### <a name="config-forward"></a> forward +### 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][memory_limit_in_bytes]. + +### cpu + +Sets the cpu shares (relative weight). If not set, it defaults to dockers +default settings. You can read more about cpu.shares [here][cpu_shares]. + +### volume + +Adds a data volume to your 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: @@ -82,11 +133,11 @@ forward: - 22:2222 - 80:8080 ``` -## <a name="development"></a> Development +## Development * Source hosted at [GitHub][repo] * Report issues/questions/feature requests on [GitHub Issues][issues] Pull requests are very welcome! Make sure your patches are well tested. @@ -97,15 +148,15 @@ 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Added some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request -## <a name="authors"></a> Authors +## Authors Created and maintained by [Sean Porter][author] (<portertech@gmail.com>) -## <a name="license"></a> License +## License Apache 2.0 (see [LICENSE][license]) [author]: https://github.com/portertech @@ -116,5 +167,7 @@ [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 [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_in_bytes]: https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-memory.html