Skip to content

Commit f8609c7

Browse files
authored
Merge pull request #1554 from peter-slovak/fix-docs-container-cpu-opts
Fix docs container cpu opts
2 parents 19ef2dd + c80762d commit f8609c7

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

docker/api/container.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,8 +473,8 @@ def create_host_config(self, *args, **kwargs):
473473
cap_add (list of str): Add kernel capabilities. For example,
474474
``["SYS_ADMIN", "MKNOD"]``.
475475
cap_drop (list of str): Drop kernel capabilities.
476-
cpu_group (int): The length of a CPU period in microseconds.
477-
cpu_period (int): Microseconds of CPU time that the container can
476+
cpu_period (int): The length of a CPU period in microseconds.
477+
cpu_quota (int): Microseconds of CPU time that the container can
478478
get in a CPU period.
479479
cpu_shares (int): CPU shares (relative weight).
480480
cpuset_cpus (str): CPUs in which to allow execution (``0-3``,

docker/models/containers.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -456,8 +456,8 @@ def run(self, image, command=None, stdout=True, stderr=False,
456456
cap_add (list of str): Add kernel capabilities. For example,
457457
``["SYS_ADMIN", "MKNOD"]``.
458458
cap_drop (list of str): Drop kernel capabilities.
459-
cpu_group (int): The length of a CPU period in microseconds.
460-
cpu_period (int): Microseconds of CPU time that the container can
459+
cpu_period (int): The length of a CPU period in microseconds.
460+
cpu_quota (int): Microseconds of CPU time that the container can
461461
get in a CPU period.
462462
cpu_shares (int): CPU shares (relative weight).
463463
cpuset_cpus (str): CPUs in which to allow execution (``0-3``,
@@ -510,14 +510,12 @@ def run(self, image, command=None, stdout=True, stderr=False,
510510
driver.
511511
512512
mac_address (str): MAC address to assign to the container.
513-
mem_limit (float or str): Memory limit. Accepts float values
513+
mem_limit (int or str): Memory limit. Accepts float values
514514
(which represent the memory limit of the created container in
515515
bytes) or a string with a units identification char
516516
(``100000b``, ``1000k``, ``128m``, ``1g``). If a string is
517517
specified without a units character, bytes are assumed as an
518518
intended unit.
519-
mem_limit (str or int): Maximum amount of memory container is
520-
allowed to consume. (e.g. ``1G``).
521519
mem_swappiness (int): Tune a container's memory swappiness
522520
behavior. Accepts number between 0 and 100.
523521
memswap_limit (str or int): Maximum amount of memory + swap a

0 commit comments

Comments
 (0)