README.md in kitchen-docker-0.7.1 vs README.md in kitchen-docker-0.8.0.beta
- old
+ new
@@ -30,27 +30,59 @@
platform: "rhel"
run_list:
- recipe[yum]
```
+## Default Configuration
+
+This driver can determine an image and platform type for a select number of
+platforms. Currently, the following platform names are supported:
+
+```
+---
+platforms:
+- name: ubuntu-12.04
+- name: centos-6.4
+```
+
+This will effectively generate a configuration similar to:
+
+```
+---
+platforms:
+- name: ubuntu-12.04
+ driver_config:
+ image: ubuntu:12.04
+ platform: ubuntu
+- name: centos-6.4
+ driver_config:
+ image: centos:6.4
+ platform: centos
+```
+
## Configuration
### 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].
+The default will be determined by the Platform name, if a default exists
+(see the Default Configuration section for more details). If a default
+cannot be computed, then the default value is `base`, an official Ubuntu
+[image][docker_default_image].
### 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`.
+The default will be determined by the Platform name, if a default exists
+(see the Default Configuration section for more details). If a default
+cannot be computed, then the default value is `ubuntu`.
### require\_chef\_omnibus
Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
installed. There are several different behaviors available: