Skip to content

Commit 8c32677

Browse files
committed
container limits documentation
1 parent 7958110 commit 8c32677

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@ correct value (e.g `gzip`).
6565
* pull (bool): Downloads any updates to the FROM image in Dockerfiles
6666
* forcerm (bool): Always remove intermediate containers, even after unsuccessful builds
6767
* dockerfile (str): path within the build context to the Dockerfile
68+
* container_limits (dict): A dictionary of limits applied to each container
69+
created by the build process. Valid keys:
70+
- memory (int): set memory limit for build
71+
- memswap (int): Total memory (memory + swap), -1 to disable swap
72+
- cpushares (int): CPU shares (relative weight)
73+
- cpusetcpus (str): CPUs in which to allow exection, e.g., `"0-3"`, `"0,1"`
6874

6975
**Returns** (generator): A generator of the build output
7076

0 commit comments

Comments
 (0)