mirror of https://github.com/docker/docker-py.git
Improve ulimits documentation
Signed-off-by: Joffrey F <joffrey@docker.com>
This commit is contained in:
parent
f1d629fb5c
commit
9467fa4809
|
@ -543,7 +543,7 @@ class ContainerApiMixin(object):
|
||||||
}
|
}
|
||||||
|
|
||||||
ulimits (:py:class:`list`): Ulimits to set inside the container,
|
ulimits (:py:class:`list`): Ulimits to set inside the container,
|
||||||
as a list of dicts.
|
as a list of :py:class:`docker.types.Ulimit` instances.
|
||||||
userns_mode (str): Sets the user namespace mode for the container
|
userns_mode (str): Sets the user namespace mode for the container
|
||||||
when user namespace remapping option is enabled. Supported
|
when user namespace remapping option is enabled. Supported
|
||||||
values are: ``host``
|
values are: ``host``
|
||||||
|
|
|
@ -691,8 +691,8 @@ class ContainerCollection(Collection):
|
||||||
}
|
}
|
||||||
|
|
||||||
tty (bool): Allocate a pseudo-TTY.
|
tty (bool): Allocate a pseudo-TTY.
|
||||||
ulimits (:py:class:`list`): Ulimits to set inside the container, as
|
ulimits (:py:class:`list`): Ulimits to set inside the container,
|
||||||
a list of dicts.
|
as a list of :py:class:`docker.types.Ulimit` instances.
|
||||||
user (str or int): Username or UID to run commands as inside the
|
user (str or int): Username or UID to run commands as inside the
|
||||||
container.
|
container.
|
||||||
userns_mode (str): Sets the user namespace mode for the container
|
userns_mode (str): Sets the user namespace mode for the container
|
||||||
|
|
|
@ -58,6 +58,23 @@ class LogConfig(DictType):
|
||||||
|
|
||||||
|
|
||||||
class Ulimit(DictType):
|
class Ulimit(DictType):
|
||||||
|
"""
|
||||||
|
Create a ulimit declaration to be used with
|
||||||
|
:py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
|
||||||
|
name (str): Which ulimit will this apply to. A list of valid names can
|
||||||
|
be found `here <http://tinyurl.me/ZWRkM2Ztwlykf>`_.
|
||||||
|
soft (int): The soft limit for this ulimit. Optional.
|
||||||
|
hard (int): The hard limit for this ulimit. Optional.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
nproc_limit = docker.types.Ulimit(name='nproc', soft=1024)
|
||||||
|
hc = client.create_host_config(ulimits=[nproc_limit])
|
||||||
|
container = client.create_container('busybox', 'true', host_config=hc)
|
||||||
|
"""
|
||||||
def __init__(self, **kwargs):
|
def __init__(self, **kwargs):
|
||||||
name = kwargs.get('name', kwargs.get('Name'))
|
name = kwargs.get('name', kwargs.get('Name'))
|
||||||
soft = kwargs.get('soft', kwargs.get('Soft'))
|
soft = kwargs.get('soft', kwargs.get('Soft'))
|
||||||
|
|
|
@ -151,4 +151,5 @@ Configuration types
|
||||||
.. autoclass:: SwarmExternalCA
|
.. autoclass:: SwarmExternalCA
|
||||||
.. autoclass:: SwarmSpec(*args, **kwargs)
|
.. autoclass:: SwarmSpec(*args, **kwargs)
|
||||||
.. autoclass:: TaskTemplate
|
.. autoclass:: TaskTemplate
|
||||||
|
.. autoclass:: Ulimit
|
||||||
.. autoclass:: UpdateConfig
|
.. autoclass:: UpdateConfig
|
||||||
|
|
Loading…
Reference in New Issue