docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Correct comments on ports_binding and host mode as network_mode 

Signed-off-by: Daeseok Youn <daeseok.youn@navercorp.com>
This commit is contained in:
Daeseok Youn 2020-11-17 21:25:00 +09:00 committed by aiordache
parent 3a8565029b
commit f464d9a430
2 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docker/api/container.py
View File

@ -524,8 +524,6 @@ class ContainerApiMixin(object):
stack. stack.
- ``host`` Use the host network stack. - ``host`` Use the host network stack.
This mode is incompatible with ``port_bindings``. This mode is incompatible with ``port_bindings``.
If ``host`` is used as network_mode, all of listed up to
``port_bindings``` are ignored in running container.
oom_kill_disable (bool): Whether to disable OOM killer. oom_kill_disable (bool): Whether to disable OOM killer.
oom_score_adj (int): An integer value containing the score given oom_score_adj (int): An integer value containing the score given
@ -535,8 +533,8 @@ class ContainerApiMixin(object):
pids_limit (int): Tune a container's pids limit. Set ``-1`` for pids_limit (int): Tune a container's pids limit. Set ``-1`` for
unlimited. unlimited.
port_bindings (dict): See :py:meth:`create_container` port_bindings (dict): See :py:meth:`create_container`
for more information. The binding ports are ignored in for more information.
``host`` as network mode. Imcompatible with ``host`` in ``network_mode``.
privileged (bool): Give extended privileges to this container. privileged (bool): Give extended privileges to this container.
publish_all_ports (bool): Publish all ports to the host. publish_all_ports (bool): Publish all ports to the host.
read_only (bool): Mount the container's root filesystem as read read_only (bool): Mount the container's root filesystem as read

7
docker/models/containers.py
View File

@ -649,9 +649,7 @@ class ContainerCollection(Collection):
- ``container:<name|id>`` Reuse another container's network - ``container:<name|id>`` Reuse another container's network
stack. stack.
- ``host`` Use the host network stack. - ``host`` Use the host network stack.
This mode is incompatible with ``ports``. If ``host`` is This mode is incompatible with ``ports``.
used as network_mode, all of listed up to ``ports``` are
ignored in running container.
Incompatible with ``network``. Incompatible with ``network``.
oom_kill_disable (bool): Whether to disable OOM killer. oom_kill_disable (bool): Whether to disable OOM killer.
@ -670,8 +668,6 @@ class ContainerCollection(Collection):
``port/protocol``, where the protocol is either ``tcp``, ``port/protocol``, where the protocol is either ``tcp``,
``udp``, or ``sctp``. ``udp``, or ``sctp``.
Ports are ignored to bind with ``host`` as network mode.
The values of the dictionary are the corresponding ports to The values of the dictionary are the corresponding ports to
open on the host, which can be either: open on the host, which can be either:
@ -687,6 +683,7 @@ class ContainerCollection(Collection):
to a single container port. For example, to a single container port. For example,
``{'1111/tcp': [1234, 4567]}``. ``{'1111/tcp': [1234, 4567]}``.
Imcompatible with ``host`` in ``network_mode``.
privileged (bool): Give extended privileges to this container. privileged (bool): Give extended privileges to this container.
publish_all_ports (bool): Publish all ports to the host. publish_all_ports (bool): Publish all ports to the host.
read_only (bool): Mount the container's root filesystem as read read_only (bool): Mount the container's root filesystem as read