Documentation style changes
This commit is contained in:
parent
0d3aed3e1f
commit
a02641b4f3
1 changed files with 69 additions and 68 deletions
|
@ -27,7 +27,7 @@ module: docker
|
||||||
version_added: "1.4"
|
version_added: "1.4"
|
||||||
short_description: manage docker containers
|
short_description: manage docker containers
|
||||||
description:
|
description:
|
||||||
- Manage the life cycle of docker containers.
|
- Manage the life cycle of docker containers.
|
||||||
options:
|
options:
|
||||||
count:
|
count:
|
||||||
description:
|
description:
|
||||||
|
@ -40,9 +40,9 @@ options:
|
||||||
pull:
|
pull:
|
||||||
description:
|
description:
|
||||||
- Control when container images are updated from the C(docker_url) registry.
|
- Control when container images are updated from the C(docker_url) registry.
|
||||||
- If "missing," images will be pulled only when missing from the host; if
|
If "missing," images will be pulled only when missing from the host;
|
||||||
- '"always," the registry will be checked for a newer version of the image'
|
if '"always," the registry will be checked for a newer version of the
|
||||||
- each time the task executes.
|
image' each time the task executes.
|
||||||
default: missing
|
default: missing
|
||||||
choices: [ "missing", "always" ]
|
choices: [ "missing", "always" ]
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
|
@ -53,23 +53,23 @@ options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name used to match and uniquely name launched containers. Explicit names
|
- Name used to match and uniquely name launched containers. Explicit names
|
||||||
- are used to uniquely identify a single container or to link among
|
are used to uniquely identify a single container or to link among
|
||||||
- containers. Mutually exclusive with a "count" other than "1".
|
containers. Mutually exclusive with a "count" other than "1".
|
||||||
default: null
|
default: null
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
ports:
|
ports:
|
||||||
description:
|
description:
|
||||||
- List containing private to public port mapping specification. Use docker
|
- List containing private to public port mapping specification. Use docker
|
||||||
- 'CLI-style syntax: C(8000), C(9000:8000), or C(0.0.0.0:9000:8000) where'
|
- 'CLI-style syntax: C(8000), C(9000:8000), or C(0.0.0.0:9000:8000)'
|
||||||
- 8000 is a container port, 9000 is a host port, and 0.0.0.0 is a host
|
- where 8000 is a container port, 9000 is a host port, and 0.0.0.0 is
|
||||||
- interface.
|
- a host interface.
|
||||||
default: null
|
default: null
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
expose:
|
expose:
|
||||||
description:
|
description:
|
||||||
- List of additional container ports to expose for port mappings or links.
|
- List of additional container ports to expose for port mappings or links.
|
||||||
- If the port is already exposed using EXPOSE in a Dockerfile, you don't
|
If the port is already exposed using EXPOSE in a Dockerfile, you don't
|
||||||
- need to expose it again.
|
need to expose it again.
|
||||||
default: null
|
default: null
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
publish_all_ports:
|
publish_all_ports:
|
||||||
|
@ -96,7 +96,7 @@ options:
|
||||||
memory_limit:
|
memory_limit:
|
||||||
description:
|
description:
|
||||||
- RAM allocated to the container as a number of bytes or as a human-readable
|
- RAM allocated to the container as a number of bytes or as a human-readable
|
||||||
- string like "512MB". Leave as "0" to specify no limit.
|
string like "512MB". Leave as "0" to specify no limit.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
aliases: []
|
||||||
|
@ -104,7 +104,7 @@ options:
|
||||||
docker_url:
|
docker_url:
|
||||||
description:
|
description:
|
||||||
- URL of the host running the docker daemon. This will default to the env
|
- URL of the host running the docker daemon. This will default to the env
|
||||||
- var DOCKER_HOST if unspecified.
|
var DOCKER_HOST if unspecified.
|
||||||
default: ${DOCKER_HOST} or unix://var/run/docker.sock
|
default: ${DOCKER_HOST} or unix://var/run/docker.sock
|
||||||
docker_tls_cert:
|
docker_tls_cert:
|
||||||
description:
|
description:
|
||||||
|
@ -121,7 +121,7 @@ options:
|
||||||
docker_api_version:
|
docker_api_version:
|
||||||
description:
|
description:
|
||||||
- Remote API version to use. This defaults to the current default as
|
- Remote API version to use. This defaults to the current default as
|
||||||
- specified by docker-py.
|
specified by docker-py.
|
||||||
default: docker-py default remote API version
|
default: docker-py default remote API version
|
||||||
version_added: "1.8"
|
version_added: "1.8"
|
||||||
username:
|
username:
|
||||||
|
@ -160,13 +160,14 @@ options:
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Assert the container's desired state. "present" only asserts that the
|
- Assert the container's desired state. "present" only asserts that the
|
||||||
- matching containers exist. "started" asserts that the matching containers
|
matching containers exist. "started" asserts that the matching
|
||||||
- both exist and are running, but takes no action if any configuration has
|
containers both exist and are running, but takes no action if any
|
||||||
- changed. "reloaded" asserts that all matching containers are running and
|
configuration has changed. "reloaded" asserts that all matching
|
||||||
- restarts any that have any images or configuration out of date. "restarted"
|
containers are running and restarts any that have any images or
|
||||||
- unconditionally restarts (or starts) the matching containers. "stopped" and
|
configuration out of date. "restarted" unconditionally restarts (or
|
||||||
- '"killed" stop and kill all matching containers. "absent" stops and then'
|
starts) the matching containers. "stopped" and '"killed" stop and kill
|
||||||
- removes any matching containers.
|
all matching containers. "absent" stops and then' removes any matching
|
||||||
|
containers.
|
||||||
required: false
|
required: false
|
||||||
default: started
|
default: started
|
||||||
choices:
|
choices:
|
||||||
|
@ -223,13 +224,13 @@ options:
|
||||||
restart_policy_retry:
|
restart_policy_retry:
|
||||||
description:
|
description:
|
||||||
- Maximum number of times to restart a container. Leave as "0" for unlimited
|
- Maximum number of times to restart a container. Leave as "0" for unlimited
|
||||||
- retries.
|
retries.
|
||||||
default: 0
|
default: 0
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
insecure_registry:
|
insecure_registry:
|
||||||
description:
|
description:
|
||||||
- Use insecure private registry by HTTP instead of HTTPS. Needed for
|
- Use insecure private registry by HTTP instead of HTTPS. Needed for
|
||||||
- docker-py >= 0.5.0.
|
docker-py >= 0.5.0.
|
||||||
default: false
|
default: false
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue