README.md in kitchen-docker-0.9.0 vs README.md in kitchen-docker-0.10.0
- old
+ new
@@ -61,15 +61,15 @@
## Configuration
### socket
-The Docker daemon socket to use. By default, Docker it will listen on
+The Docker daemon socket to use. By default, Docker will listen on
`unix:///var/run/docker.sock`, and no configuration here is required. If
Docker is binding to another host/port or Unix socket, you will need to set
this option. If a TCP socket is set, its host will be used for SSH access
-to containers.
+to suite containers.
Examples:
```
socket: unix:///tmp/docker.sock
@@ -122,22 +122,22 @@
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 | sudo bash"
+ provision_command: "curl -L https://www.opscode.com/chef/install.sh | bash"
```
```
provision_command:
- "apt-get install dnsutils"
- "apt-get install telnet"
```
```
driver_config:
- provision_command: "curl -L https://www.opscode.com/chef/install.sh | sudo bash"
+ provision_command: "curl -L https://www.opscode.com/chef/install.sh | bash"
require_chef_omnibus: false
```
### remove\_images
@@ -146,18 +146,17 @@
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].
+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].
### 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].
+Sets the CPU shares (relative weight) for the suite container. Otherwise use
+Dockers defaults. You can read more about cpu.shares [here][cpu_shares].
### volume
Adds a data volume(s) to the suite container.
@@ -174,11 +173,11 @@
```
## dns
Adjusts `resolv.conf` to use the dns servers specified. Otherwise use
-dockers defaults.
+Dockers defaults.
Examples:
```
dns: 8.8.8.8
@@ -190,11 +189,11 @@
- 8.8.4.4
```
### forward
-Suite container port(s) to forward to the host machine. You may specify
+Set 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:
```
@@ -205,10 +204,33 @@
forward:
- 22:2222
- 80:8080
```
+### hostname
+
+Set the suite container hostname. Otherwise use Dockers default.
+
+Examples:
+
+```
+ hostname: foobar.local
+```
+
+### privileged
+
+Run the suite container in privileged mode. This allows certain functionality
+inside the Docker container which is not otherwise permitted.
+
+The default value is `false`.
+
+Examples:
+
+```
+ privileged: true
+```
+
## Development
* Source hosted at [GitHub][repo]
* Report issues/questions/feature requests on [GitHub Issues][issues]
@@ -240,6 +262,6 @@
[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
+[memory_limit]: https://docs.fedoraproject.org/en-US/Fedora/17/html/Resource_Management_Guide/sec-memory.html