mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +00:00
Fix documentation fragments for docker (#38378)
This commit is contained in:
committed by
Matt Clay
parent
68e3ff80a7
commit
4117b2dd29
@@ -69,10 +69,15 @@ options:
|
||||
description:
|
||||
- Enable detached mode to leave the container running in background.
|
||||
If disabled, the task will reflect the status of the container run (failed if the command failed).
|
||||
type: bool
|
||||
default: true
|
||||
devices:
|
||||
description:
|
||||
- "List of host device bindings to add to the container. Each binding is a mapping expressed
|
||||
in the format: <path_on_host>:<path_in_container>:<cgroup_permissions>"
|
||||
dns_opts:
|
||||
description:
|
||||
- list of DNS options
|
||||
dns_servers:
|
||||
description:
|
||||
- List of custom DNS servers.
|
||||
@@ -107,11 +112,14 @@ options:
|
||||
need to be exposed again.
|
||||
aliases:
|
||||
- exposed
|
||||
- expose
|
||||
force_kill:
|
||||
description:
|
||||
- Use the kill command when stopping a running container.
|
||||
type: bool
|
||||
default: 'no'
|
||||
aliases:
|
||||
- forcekill
|
||||
groups:
|
||||
description:
|
||||
- List of additional group names and/or IDs that the container process will run as.
|
||||
@@ -175,6 +183,8 @@ options:
|
||||
description:
|
||||
- Dictionary of options specific to the chosen log_driver. See https://docs.docker.com/engine/admin/logging/overview/
|
||||
for details.
|
||||
aliases:
|
||||
- log_opt
|
||||
mac_address:
|
||||
description:
|
||||
- Container MAC address (e.g. 92:d0:c6:0a:29:33)
|
||||
@@ -182,7 +192,7 @@ options:
|
||||
description:
|
||||
- "Memory limit (format: <number>[<unit>]). Number is a positive integer.
|
||||
Unit can be one of b, k, m, or g"
|
||||
default: 0
|
||||
default: '0'
|
||||
memory_reservation:
|
||||
description:
|
||||
- "Memory soft limit (format: <number>[<unit>]). Number is a positive integer.
|
||||
@@ -204,12 +214,7 @@ options:
|
||||
required: true
|
||||
network_mode:
|
||||
description:
|
||||
- Connect the container to a network.
|
||||
choices:
|
||||
- bridge
|
||||
- container:<name|id>
|
||||
- host
|
||||
- none
|
||||
- Connect the container to a network. Choices are "bridge", "host", "none" or "container:<name|id>"
|
||||
userns_mode:
|
||||
description:
|
||||
- User namespace to use
|
||||
@@ -293,11 +298,10 @@ options:
|
||||
description:
|
||||
- Container restart policy. Place quotes around I(no) option.
|
||||
choices:
|
||||
- always
|
||||
- no
|
||||
- on-failure
|
||||
- unless-stopped
|
||||
default: on-failure
|
||||
- 'no'
|
||||
- 'on-failure'
|
||||
- 'always'
|
||||
- 'unless-stopped'
|
||||
restart_retries:
|
||||
description:
|
||||
- Use with restart policy to control maximum number of restart attempts.
|
||||
|
||||
@@ -38,7 +38,6 @@ options:
|
||||
dockerfile:
|
||||
description:
|
||||
- Use with state C(present) to provide an alternate name for the Dockerfile to use when building an image.
|
||||
default: Dockerfile
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
force:
|
||||
@@ -156,10 +155,10 @@ options:
|
||||
C(encrypt) to use TLS. And set to C(verify) to use TLS and verify that the server's certificate is valid for the
|
||||
server. NOTE: If you specify this option, it will set the value of the tls or tls_verify parameters."
|
||||
choices:
|
||||
- no
|
||||
- encrypt
|
||||
- verify
|
||||
default: no
|
||||
- 'no'
|
||||
- 'encrypt'
|
||||
- 'verify'
|
||||
default: 'no'
|
||||
required: false
|
||||
version_added: "2.0"
|
||||
|
||||
|
||||
@@ -38,9 +38,10 @@ options:
|
||||
required: false
|
||||
force:
|
||||
description:
|
||||
- Boolean. Use with state C(present) to always remove and recreate an existing secret.
|
||||
- Use with state C(present) to always remove and recreate an existing secret.
|
||||
- If I(true), an existing secret will be replaced, even if it has not changed.
|
||||
default: false
|
||||
type: bool
|
||||
name:
|
||||
description:
|
||||
- The name of the secret.
|
||||
|
||||
@@ -110,6 +110,9 @@ options:
|
||||
remove_images:
|
||||
description:
|
||||
- Use with state I(absent) to remove the all images or only local images.
|
||||
choices:
|
||||
- 'all'
|
||||
- 'local'
|
||||
remove_volumes:
|
||||
description:
|
||||
- Use with state I(absent) to remove data volumes.
|
||||
@@ -125,11 +128,15 @@ options:
|
||||
- Use with state I(present) to restart all containers.
|
||||
type: bool
|
||||
default: 'no'
|
||||
debug:
|
||||
remove_orphans:
|
||||
description:
|
||||
- Include I(actions) in the return values.
|
||||
- Remove containers for services not defined in the compose file.
|
||||
type: bool
|
||||
default: 'no'
|
||||
default: false
|
||||
timeout:
|
||||
description:
|
||||
- timeout in seconds for container shutdown when attached or when containers are already running.
|
||||
default: 10
|
||||
|
||||
extends_documentation_fragment:
|
||||
- docker
|
||||
|
||||
Reference in New Issue
Block a user