1- # < a name = " title " ></ a > Kitchen::Docker
1+ # Kitchen::Docker
22
33A Test Kitchen Driver for Docker.
44
5- ## < a name = " requirements " ></ a > Requirements
5+ ## Requirements
66
77* [ Docker] [ docker_getting_started ]
88
9- ## < a name = " issues " ></ a > Known Issues
9+ ## Known Issues
1010
1111* Upstart is neutered due to [ this issue] [ docker_upstart_issue ] .
1212
13- ## < a name = " installation " ></ a > Installation and Setup
13+ ## Installation and Setup
1414
1515Please read the [ Driver usage] [ driver_usage ] page for more details.
1616
@@ -32,16 +32,16 @@ platforms:
3232 - recipe[yum]
3333```
3434
35- ## < a name = " config " ></ a > Configuration
35+ ## Configuration
3636
37- ### < a name = " config-image " ></ a > image
37+ ### image
3838
3939The Docker image to use as the base for the suite containers. You can find
4040images using the [ Docker Index] [ docker_index ] .
4141
4242The default value is ` base ` , an official Ubuntu [ image] [ docker_default_image ] .
4343
44- ### < a name = " config-platform " ></ a > platform
44+ ### platform
4545
4646The platform of the chosen image. This is used to properly bootstrap the
4747suite container for Test Kitchen. Kitchen Docker currently supports:
@@ -51,7 +51,7 @@ suite container for Test Kitchen. Kitchen Docker currently supports:
5151
5252The default value is ` ubuntu ` .
5353
54- ### < a name = " config-require-chef-omnibus " ></ a > require\_ chef\_ omnibus
54+ ### require\_ chef\_ omnibus
5555
5656Determines whether or not a Chef [ Omnibus package] [ chef_omnibus_dl ] will be
5757installed. There are several different behaviors available:
@@ -67,7 +67,14 @@ installed. There are several different behaviors available:
6767
6868The default value is ` true ` .
6969
70- ### <a name =" config-forward " ></a > forward
70+ ### memory
71+
72+ Sets the memory limit for the container. The value must be set in bytes.
73+ If not set it defaults to dockers default settings.
74+
75+ default value is ` nil ` .
76+
77+ ### forward
7178
7279Suite container port(s) to forward to the host machine. You may specify
7380the host (public) port in the mappings, if not, Docker chooses for you.
@@ -84,7 +91,7 @@ forward:
8491- 80:8080
8592```
8693
87- ## < a name = " development " ></ a > Development
94+ ## Development
8895
8996* Source hosted at [ GitHub] [ repo ]
9097* Report issues/questions/feature requests on [ GitHub Issues] [ issues ]
@@ -99,11 +106,11 @@ example:
991064 . Push to the branch (` git push origin my-new-feature ` )
1001075 . Create new Pull Request
101108
102- ## < a name = " authors " ></ a > Authors
109+ ## Authors
103110
104111Created and maintained by [ Sean Porter] [ author ] (< portertech@gmail.com > )
105112
106- ## < a name = " license " ></ a > License
113+ ## License
107114
108115Apache 2.0 (see [ LICENSE] [ license ] )
109116
0 commit comments