mirror of https://github.com/docker/docker-py.git
parent
a0853622f9
commit
114512a9bf
|
@ -93,8 +93,8 @@ class BuildApiMixin(object):
|
||||||
shmsize (int): Size of `/dev/shm` in bytes. The size must be
|
shmsize (int): Size of `/dev/shm` in bytes. The size must be
|
||||||
greater than 0. If omitted the system uses 64MB
|
greater than 0. If omitted the system uses 64MB
|
||||||
labels (dict): A dictionary of labels to set on the image
|
labels (dict): A dictionary of labels to set on the image
|
||||||
cache_from (list): A list of images used for build cache
|
cache_from (:py:class:`list`): A list of images used for build
|
||||||
resolution
|
cache resolution
|
||||||
target (str): Name of the build-stage to build in a multi-stage
|
target (str): Name of the build-stage to build in a multi-stage
|
||||||
Dockerfile
|
Dockerfile
|
||||||
network_mode (str): networking mode for the run commands during
|
network_mode (str): networking mode for the run commands during
|
||||||
|
|
|
@ -110,8 +110,8 @@ class PluginApiMixin(object):
|
||||||
remote (string): Remote reference for the plugin to install.
|
remote (string): Remote reference for the plugin to install.
|
||||||
The ``:latest`` tag is optional, and is the default if
|
The ``:latest`` tag is optional, and is the default if
|
||||||
omitted.
|
omitted.
|
||||||
privileges (list): A list of privileges the user consents to
|
privileges (:py:class:`list`): A list of privileges the user
|
||||||
grant to the plugin. Can be retrieved using
|
consents to grant to the plugin. Can be retrieved using
|
||||||
:py:meth:`~plugin_privileges`.
|
:py:meth:`~plugin_privileges`.
|
||||||
name (string): Local name for the pulled plugin. The
|
name (string): Local name for the pulled plugin. The
|
||||||
``:latest`` tag is optional, and is the default if omitted.
|
``:latest`` tag is optional, and is the default if omitted.
|
||||||
|
@ -225,8 +225,8 @@ class PluginApiMixin(object):
|
||||||
tag is optional and is the default if omitted.
|
tag is optional and is the default if omitted.
|
||||||
remote (string): Remote reference to upgrade to. The
|
remote (string): Remote reference to upgrade to. The
|
||||||
``:latest`` tag is optional and is the default if omitted.
|
``:latest`` tag is optional and is the default if omitted.
|
||||||
privileges (list): A list of privileges the user consents to
|
privileges (:py:class:`list`): A list of privileges the user
|
||||||
grant to the plugin. Can be retrieved using
|
consents to grant to the plugin. Can be retrieved using
|
||||||
:py:meth:`~plugin_privileges`.
|
:py:meth:`~plugin_privileges`.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
|
|
|
@ -8,14 +8,15 @@ class Healthcheck(DictType):
|
||||||
Defines a healthcheck configuration for a container or service.
|
Defines a healthcheck configuration for a container or service.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
|
|
||||||
test (:py:class:`list` or str): Test to perform to determine
|
test (:py:class:`list` or str): Test to perform to determine
|
||||||
container health. Possible values:
|
container health. Possible values:
|
||||||
- Empty list: Inherit healthcheck from parent image
|
|
||||||
- ``["NONE"]``: Disable healthcheck
|
- Empty list: Inherit healthcheck from parent image
|
||||||
- ``["CMD", args...]``: exec arguments directly.
|
- ``["NONE"]``: Disable healthcheck
|
||||||
- ``["CMD-SHELL", command]``: RUn command in the system's
|
- ``["CMD", args...]``: exec arguments directly.
|
||||||
default shell.
|
- ``["CMD-SHELL", command]``: RUn command in the system's
|
||||||
|
default shell.
|
||||||
|
|
||||||
If a string is provided, it will be used as a ``CMD-SHELL``
|
If a string is provided, it will be used as a ``CMD-SHELL``
|
||||||
command.
|
command.
|
||||||
interval (int): The time to wait between checks in nanoseconds. It
|
interval (int): The time to wait between checks in nanoseconds. It
|
||||||
|
|
|
@ -405,8 +405,9 @@ class DriverConfig(dict):
|
||||||
"""
|
"""
|
||||||
Indicates which driver to use, as well as its configuration. Can be used
|
Indicates which driver to use, as well as its configuration. Can be used
|
||||||
as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`,
|
as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`,
|
||||||
and for the `driver_config` in a volume
|
for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or
|
||||||
:py:class:`~docker.types.Mount`.
|
as the driver object in
|
||||||
|
:py:meth:`create_secret`.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
|
|
||||||
|
@ -562,12 +563,12 @@ class Placement(dict):
|
||||||
Placement constraints to be used as part of a :py:class:`TaskTemplate`
|
Placement constraints to be used as part of a :py:class:`TaskTemplate`
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
constraints (list): A list of constraints
|
constraints (:py:class:`list`): A list of constraints
|
||||||
preferences (list): Preferences provide a way to make the
|
preferences (:py:class:`list`): Preferences provide a way to make
|
||||||
scheduler aware of factors such as topology. They are provided
|
the scheduler aware of factors such as topology. They are
|
||||||
in order from highest to lowest precedence.
|
provided in order from highest to lowest precedence.
|
||||||
platforms (list): A list of platforms expressed as ``(arch, os)``
|
platforms (:py:class:`list`): A list of platforms expressed as
|
||||||
tuples
|
``(arch, os)`` tuples
|
||||||
"""
|
"""
|
||||||
def __init__(self, constraints=None, preferences=None, platforms=None):
|
def __init__(self, constraints=None, preferences=None, platforms=None):
|
||||||
if constraints is not None:
|
if constraints is not None:
|
||||||
|
|
Loading…
Reference in New Issue