summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2016-02-01 14:19:09 -0800
committerJoffrey F <joffrey@docker.com>2016-02-23 16:18:36 -0800
commit6f6d0890a44c17f1052782b8ccf903edb8badd67 (patch)
treedbff068f3fd42ef6193e1e6249a1bf5035b69994
parentc3ba50c98d5de7da5a618877636c8a3d50324ca0 (diff)
downloaddocker-py-6f6d0890a44c17f1052782b8ccf903edb8badd67.tar.gz
Documentation for Client.update_container method
Signed-off-by: Joffrey F <joffrey@docker.com>
-rw-r--r--docs/api.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md
index 00ccabc..e798094 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -997,12 +997,32 @@ Display the running processes of a container.
## unpause
-Unpauses all processes within a container.
+Unpause all processes within a container.
**Params**:
* container (str): The container to unpause
+## update_container
+
+Update resource configs of one or more containers.
+
+**Params**:
+
+* container (str): The container to inspect
+* blkio_weight (int): Block IO (relative weight), between 10 and 1000
+* cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period
+* cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota
+* cpu_shares (int): CPU shares (relative weight)
+* cpuset_cpus (str): CPUs in which to allow execution
+* cpuset_mems (str): MEMs in which to allow execution
+* mem_limit (int or str): Memory limit
+* mem_reservation (int or str): Memory soft limit
+* memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap
+* kernel_memory (int or str): Kernel memory limit
+
+**Returns** (dict): Dictionary containing a `Warnings` key.
+
## version
Nearly identical to the `docker version` command.