mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 11:58:43 +00:00
Improve formulations.
This commit is contained in:
parent
769d15de63
commit
bd992583c2
@ -37,7 +37,7 @@ options:
|
|||||||
docker_host:
|
docker_host:
|
||||||
description:
|
description:
|
||||||
- Socket of a Docker swarm manager node (C(tcp), C(unix)).
|
- Socket of a Docker swarm manager node (C(tcp), C(unix)).
|
||||||
- Use V(unix:///var/run/docker.sock) to connect via local socket.
|
- Use V(unix:///var/run/docker.sock) to connect through a local socket.
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
aliases: [docker_url]
|
aliases: [docker_url]
|
||||||
@ -96,7 +96,7 @@ options:
|
|||||||
include_host_uri:
|
include_host_uri:
|
||||||
description: Toggle to return the additional attribute C(ansible_host_uri) which contains the URI of the swarm leader
|
description: Toggle to return the additional attribute C(ansible_host_uri) which contains the URI of the swarm leader
|
||||||
in format of V(tcp://172.16.0.1:2376). This value may be used without additional modification as value of option O(docker_host)
|
in format of V(tcp://172.16.0.1:2376). This value may be used without additional modification as value of option O(docker_host)
|
||||||
in Docker Swarm modules when connecting via API. The port always defaults to V(2376).
|
in Docker Swarm modules when connecting through the API. The port always defaults to V(2376).
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
include_host_uri_port:
|
include_host_uri_port:
|
||||||
|
|||||||
@ -429,7 +429,7 @@ options:
|
|||||||
image_comparison:
|
image_comparison:
|
||||||
description:
|
description:
|
||||||
- Determines which image to use for idempotency checks that depend on image parameters.
|
- Determines which image to use for idempotency checks that depend on image parameters.
|
||||||
- The default, V(desired-image), will use the image that is provided to the module via the O(image) parameter.
|
- The default, V(desired-image), will use the image that is provided to the module with the O(image) parameter.
|
||||||
- V(current-image) will use the image that the container is currently using, if the container exists. It falls back
|
- V(current-image) will use the image that the container is currently using, if the container exists. It falls back
|
||||||
to the image that is provided in case the container does not yet exist.
|
to the image that is provided in case the container does not yet exist.
|
||||||
- This affects the O(env), O(env_file), O(exposed_ports), O(labels), and O(volumes) options.
|
- This affects the O(env), O(env_file), O(exposed_ports), O(labels), and O(volumes) options.
|
||||||
@ -703,7 +703,7 @@ options:
|
|||||||
description:
|
description:
|
||||||
- If O(networks_cli_compatible=true) (default), this module will behave as C(docker run --network) and will B(not) add
|
- If O(networks_cli_compatible=true) (default), this module will behave as C(docker run --network) and will B(not) add
|
||||||
the default network if O(networks) is specified. If O(networks) is not specified, the default network will be attached.
|
the default network if O(networks) is specified. If O(networks) is not specified, the default network will be attached.
|
||||||
- 'When O(networks_cli_compatible=false) and networks are provided to the module via the O(networks) option, the module
|
- 'When O(networks_cli_compatible=false) and networks are provided to the module with the O(networks) option, the module
|
||||||
behaves differently than C(docker run --network): C(docker run --network other) will create a container with network
|
behaves differently than C(docker run --network): C(docker run --network other) will create a container with network
|
||||||
C(other) attached, but the default network not attached. This module with O(networks) set to C({name: other}) will
|
C(other) attached, but the default network not attached. This module with O(networks) set to C({name: other}) will
|
||||||
create a container with both C(default) and C(other) attached. If C(networks: strict) or C(*: strict) is set in O(comparisons),
|
create a container with both C(default) and C(other) attached. If C(networks: strict) or C(*: strict) is set in O(comparisons),
|
||||||
|
|||||||
@ -50,7 +50,7 @@ options:
|
|||||||
description:
|
description:
|
||||||
- List of container names or container IDs to connect to a network.
|
- List of container names or container IDs to connect to a network.
|
||||||
- Please note that the module only makes sure that these containers are connected to the network, but does not care
|
- Please note that the module only makes sure that these containers are connected to the network, but does not care
|
||||||
about connection options. If you rely on specific IP addresses etc., use the M(community.docker.docker_container)
|
about connection options. If you rely on specific IP addresses and so on, use the M(community.docker.docker_container)
|
||||||
module to ensure your containers are correctly connected to this network.
|
module to ensure your containers are correctly connected to this network.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
@ -137,7 +137,7 @@ options:
|
|||||||
description:
|
description:
|
||||||
- V(absent) deletes the network. If a network has connected containers, these will be detached from the network.
|
- V(absent) deletes the network. If a network has connected containers, these will be detached from the network.
|
||||||
- V(present) creates the network, if it does not already exist with the specified parameters, and connects the list
|
- V(present) creates the network, if it does not already exist with the specified parameters, and connects the list
|
||||||
of containers provided via the connected parameter. Containers not on the list will be disconnected. An empty list
|
of containers provided by the O(connected) parameter. Containers not on the list will be disconnected. An empty list
|
||||||
will leave no containers connected to the network. Use the O(appends) option to leave existing containers connected.
|
will leave no containers connected to the network. Use the O(appends) option to leave existing containers connected.
|
||||||
Use the O(force) options to force re-creation of the network.
|
Use the O(force) options to force re-creation of the network.
|
||||||
type: str
|
type: str
|
||||||
|
|||||||
@ -12,7 +12,7 @@ DOCUMENTATION = r"""
|
|||||||
module: docker_node
|
module: docker_node
|
||||||
short_description: Manage Docker Swarm node
|
short_description: Manage Docker Swarm node
|
||||||
description:
|
description:
|
||||||
- Manages the Docker nodes via Swarm Manager.
|
- Manages the Docker nodes through a Swarm Manager.
|
||||||
- This module allows to change the node's role, its availability, and to modify, add or remove node labels.
|
- This module allows to change the node's role, its availability, and to modify, add or remove node labels.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.docker.docker
|
- community.docker.docker
|
||||||
|
|||||||
@ -14,7 +14,7 @@ module: docker_prune
|
|||||||
short_description: Allows to prune various docker objects
|
short_description: Allows to prune various docker objects
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) via
|
- Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) through
|
||||||
the Docker API.
|
the Docker API.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.docker.docker.api_documentation
|
- community.docker.docker.api_documentation
|
||||||
|
|||||||
@ -16,7 +16,7 @@ author:
|
|||||||
- "Piotr Wojciechowski (@wojciechowskipiotr)"
|
- "Piotr Wojciechowski (@wojciechowskipiotr)"
|
||||||
short_description: docker swarm service
|
short_description: docker swarm service
|
||||||
description:
|
description:
|
||||||
- Manages docker services via a swarm manager node.
|
- Manages docker services through a swarm manager node.
|
||||||
- This modules does not support updating services in a stack.
|
- This modules does not support updating services in a stack.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.docker.docker
|
- community.docker.docker
|
||||||
@ -444,7 +444,7 @@ options:
|
|||||||
delay:
|
delay:
|
||||||
description:
|
description:
|
||||||
- Delay between restarts.
|
- Delay between restarts.
|
||||||
- 'Accepts a a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--restart-delay) option of C(docker service create).
|
- Corresponds to the C(--restart-delay) option of C(docker service create).
|
||||||
type: str
|
type: str
|
||||||
@ -456,7 +456,7 @@ options:
|
|||||||
window:
|
window:
|
||||||
description:
|
description:
|
||||||
- Restart policy evaluation window.
|
- Restart policy evaluation window.
|
||||||
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--restart-window) option of C(docker service create).
|
- Corresponds to the C(--restart-window) option of C(docker service create).
|
||||||
type: str
|
type: str
|
||||||
@ -474,7 +474,7 @@ options:
|
|||||||
delay:
|
delay:
|
||||||
description:
|
description:
|
||||||
- Delay between task rollbacks.
|
- Delay between task rollbacks.
|
||||||
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--rollback-delay) option of C(docker service create).
|
- Corresponds to the C(--rollback-delay) option of C(docker service create).
|
||||||
- Requires API version >= 1.28.
|
- Requires API version >= 1.28.
|
||||||
@ -491,7 +491,7 @@ options:
|
|||||||
monitor:
|
monitor:
|
||||||
description:
|
description:
|
||||||
- Duration after each task rollback to monitor for failure.
|
- Duration after each task rollback to monitor for failure.
|
||||||
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--rollback-monitor) option of C(docker service create).
|
- Corresponds to the C(--rollback-monitor) option of C(docker service create).
|
||||||
- Requires API version >= 1.28.
|
- Requires API version >= 1.28.
|
||||||
@ -555,7 +555,7 @@ options:
|
|||||||
stop_grace_period:
|
stop_grace_period:
|
||||||
description:
|
description:
|
||||||
- Time to wait before force killing a container.
|
- Time to wait before force killing a container.
|
||||||
- 'Accepts a duration as a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us),
|
- 'Accepts a duration as a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us),
|
||||||
V(ms), V(s), V(m) and V(h).'
|
V(ms), V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--stop-grace-period) option of C(docker service create).
|
- Corresponds to the C(--stop-grace-period) option of C(docker service create).
|
||||||
type: str
|
type: str
|
||||||
@ -581,7 +581,7 @@ options:
|
|||||||
delay:
|
delay:
|
||||||
description:
|
description:
|
||||||
- Rolling update delay.
|
- Rolling update delay.
|
||||||
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--update-delay) option of C(docker service create).
|
- Corresponds to the C(--update-delay) option of C(docker service create).
|
||||||
type: str
|
type: str
|
||||||
@ -598,7 +598,7 @@ options:
|
|||||||
monitor:
|
monitor:
|
||||||
description:
|
description:
|
||||||
- Time to monitor updated tasks for failures.
|
- Time to monitor updated tasks for failures.
|
||||||
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s) etc. The supported units are V(us), V(ms),
|
- 'Accepts a string in a format that look like: V(5h34m56s), V(1m30s), and so on. The supported units are V(us), V(ms),
|
||||||
V(s), V(m) and V(h).'
|
V(s), V(m) and V(h).'
|
||||||
- Corresponds to the C(--update-monitor) option of C(docker service create).
|
- Corresponds to the C(--update-monitor) option of C(docker service create).
|
||||||
type: str
|
type: str
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user