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

Merge pull request #2135 from docker/2133-services-docs 

Fix docs for Service objects
This commit is contained in:
Joffrey F 2018-09-14 17:23:44 -07:00 committed by GitHub
parent 87352cd057 2b10c3773c
commit 416ea74e3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docker/models/services.py
View File

@ -42,7 +42,7 @@ class Service(Model):
``label``, and ``desired-state``.
Returns:
(:py:class:`list`): List of task dictionaries.
:py:class:`list`: List of task dictionaries.
Raises:
:py:class:`docker.errors.APIError`
@ -84,26 +84,27 @@ class Service(Model):
def logs(self, **kwargs):
"""
Get log stream for the service.
Note: This method works only for services with the ``json-file``
or ``journald`` logging drivers.
Get log stream for the service.
Note: This method works only for services with the ``json-file``
or ``journald`` logging drivers.
Args:
details (bool): Show extra details provided to logs.
Default: ``False``
follow (bool): Keep connection open to read logs as they are
sent by the Engine. Default: ``False``
stdout (bool): Return logs from ``stdout``. Default: ``False``
stderr (bool): Return logs from ``stderr``. Default: ``False``
since (int): UNIX timestamp for the logs staring point.
Default: 0
timestamps (bool): Add timestamps to every log line.
tail (string or int): Number of log lines to be returned,
counting from the current end of the logs. Specify an
integer or ``'all'`` to output all log lines.
Default: ``all``
Args:
details (bool): Show extra details provided to logs.
Default: ``False``
follow (bool): Keep connection open to read logs as they are
sent by the Engine. Default: ``False``
stdout (bool): Return logs from ``stdout``. Default: ``False``
stderr (bool): Return logs from ``stderr``. Default: ``False``
since (int): UNIX timestamp for the logs staring point.
Default: 0
timestamps (bool): Add timestamps to every log line.
tail (string or int): Number of log lines to be returned,
counting from the current end of the logs. Specify an
integer or ``'all'`` to output all log lines.
Default: ``all``
Returns (generator): Logs for the service.
Returns:
generator: Logs for the service.
"""
is_tty = self.attrs['Spec']['TaskTemplate']['ContainerSpec'].get(
'TTY', False
@ -118,7 +119,7 @@ class Service(Model):
replicas (int): The number of containers that should be running.
Returns:
``True``if successful.
bool: ``True`` if successful.
"""
if 'Global' in self.attrs['Spec']['Mode'].keys():
@ -134,7 +135,7 @@ class Service(Model):
Force update the service even if no changes require it.
Returns:
``True``if successful.
bool: ``True`` if successful.
"""
return self.update(force_update=True, fetch_current_spec=True)
@ -206,7 +207,7 @@ class ServiceCollection(Collection):
containers.
Returns:
(:py:class:`Service`) The created service.
:py:class:`Service`: The created service.
Raises:
:py:class:`docker.errors.APIError`
@ -228,7 +229,7 @@ class ServiceCollection(Collection):
into the output.
Returns:
(:py:class:`Service`): The service.
:py:class:`Service`: The service.
Raises:
:py:class:`docker.errors.NotFound`
@ -253,7 +254,7 @@ class ServiceCollection(Collection):
Default: ``None``.
Returns:
(list of :py:class:`Service`): The services.
list of :py:class:`Service`: The services.
Raises:
:py:class:`docker.errors.APIError`

3
docs/services.rst
View File

@ -30,7 +30,10 @@ Service objects
The raw representation of this object from the server.
.. automethod:: force_update
.. automethod:: logs
.. automethod:: reload
.. automethod:: remove
.. automethod:: scale
.. automethod:: tasks
.. automethod:: update