Skip to content

Commit 26f9e4b

Browse files
author
Ulysses Souza
authored
Merge pull request #2233 from wvaske/2232-Adding_supported_options_to_container_run_documentation
Added missing options from RUN_HOST_CONFIG_KWARGS list in docker.models.containers to the docstring for client.containers.run()
2 parents 28c9100 + 24f7c6d commit 26f9e4b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docker/models/containers.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,12 +540,15 @@ def run(self, image, command=None, stdout=True, stderr=False,
540540
cap_add (list of str): Add kernel capabilities. For example,
541541
``["SYS_ADMIN", "MKNOD"]``.
542542
cap_drop (list of str): Drop kernel capabilities.
543+
cgroup_parent (str): Override the default parent cgroup.
543544
cpu_count (int): Number of usable CPUs (Windows only).
544545
cpu_percent (int): Usable percentage of the available CPUs
545546
(Windows only).
546547
cpu_period (int): The length of a CPU period in microseconds.
547548
cpu_quota (int): Microseconds of CPU time that the container can
548549
get in a CPU period.
550+
cpu_rt_period (int): Limit CPU real-time period in microseconds.
551+
cpu_rt_runtime (int): Limit CPU real-time runtime in microseconds.
549552
cpu_shares (int): CPU shares (relative weight).
550553
cpuset_cpus (str): CPUs in which to allow execution (``0-3``,
551554
``0,1``).
@@ -589,6 +592,7 @@ def run(self, image, command=None, stdout=True, stderr=False,
589592
init_path (str): Path to the docker-init binary
590593
ipc_mode (str): Set the IPC mode for the container.
591594
isolation (str): Isolation technology to use. Default: `None`.
595+
kernel_memory (int or str): Kernel memory limit
592596
labels (dict or list): A dictionary of name-value labels (e.g.
593597
``{"label1": "value1", "label2": "value2"}``) or a list of
594598
names of labels to set with empty values (e.g.
@@ -598,13 +602,15 @@ def run(self, image, command=None, stdout=True, stderr=False,
598602
Containers declared in this dict will be linked to the new
599603
container using the provided alias. Default: ``None``.
600604
log_config (LogConfig): Logging configuration.
605+
lxc_conf (dict): LXC config.
601606
mac_address (str): MAC address to assign to the container.
602607
mem_limit (int or str): Memory limit. Accepts float values
603608
(which represent the memory limit of the created container in
604609
bytes) or a string with a units identification char
605610
(``100000b``, ``1000k``, ``128m``, ``1g``). If a string is
606611
specified without a units character, bytes are assumed as an
607612
intended unit.
613+
mem_reservation (int or str): Memory soft limit
608614
mem_swappiness (int): Tune a container's memory swappiness
609615
behavior. Accepts number between 0 and 100.
610616
memswap_limit (str or int): Maximum amount of memory + swap a
@@ -718,6 +724,10 @@ def run(self, image, command=None, stdout=True, stderr=False,
718724
userns_mode (str): Sets the user namespace mode for the container
719725
when user namespace remapping option is enabled. Supported
720726
values are: ``host``
727+
uts_mode (str): Sets the UTS namespace mode for the container.
728+
Supported values are: ``host``
729+
version (str): The version of the API to use. Set to ``auto`` to
730+
automatically detect the server's version. Default: ``1.30``
721731
volume_driver (str): The name of a volume driver/plugin.
722732
volumes (dict or list): A dictionary to configure volumes mounted
723733
inside the container. The key is either the host path or a

0 commit comments

Comments
 (0)