argv, you need to pass the command through a shell, like command=/bin/sh -c "echo $ENV_VARIABLE".
The Docker compose CLI plugin has no stable output format (see for example https://github.com/docker/compose/issues/10872), and for the main operations also no machine friendly output format. The module tries to accomodate this with various -version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions +version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. +Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions will change over time. New releases of the Docker compose CLI plugin can break this module at any time.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
The Docker compose CLI plugin has no stable output format (see for example https://github.com/docker/compose/issues/10872), and for the main operations also no machine friendly output format. The module tries to accomodate this with various -version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions +version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. +Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions will change over time. New releases of the Docker compose CLI plugin can break this module at any time.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
The Docker compose CLI plugin has no stable output format (see for example https://github.com/docker/compose/issues/10872), and for the main operations also no machine friendly output format. The module tries to accomodate this with various -version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions +version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. +Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions will change over time. New releases of the Docker compose CLI plugin can break this module at any time.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
argv, you need to pass the command through a shell, like command=/bin/sh -c "echo $ENV_VARIABLE".
The Docker compose CLI plugin has no stable output format (see for example https://github.com/docker/compose/issues/10872), and for the main operations also no machine friendly output format. The module tries to accomodate this with various -version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions +version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. +Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions will change over time. New releases of the Docker compose CLI plugin can break this module at any time.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
- name: Create config foo (from a file on the control machine)
community.docker.docker_config:
name: foo
- # If the file is JSON or binary, Ansible might modify it (because
- # it is first decoded and later re-encoded). Base64-encoding the
- # file directly after reading it prevents this to happen.
+ # If the file is JSON or binary, Ansible might modify it (because
+ # it is first decoded and later re-encoded). Base64-encoding the
+ # file directly after reading it prevents this to happen.
data: "{{ lookup('file', '/path/to/config/file') | b64encode }}"
data_is_b64: true
state: present
@@ -544,7 +544,7 @@ see labels:
bar: baz
one: '1'
- # Adding a new label will cause a remove/create of the config
+ # Adding a new label will cause a remove/create of the config
two: '2'
state: present
@@ -555,7 +555,7 @@ see labels:
bar: baz
one: '1'
- # Even though 'two' is missing, there is no change to the existing config
+ # Even though 'two' is missing, there is no change to the existing config
state: present
- name: Update an existing label
diff --git a/pr/1020/docker_container_module.html b/pr/1020/docker_container_module.html
index a2432f39..e602614c 100644
--- a/pr/1020/docker_container_module.html
+++ b/pr/1020/docker_container_module.html
@@ -1743,16 +1743,16 @@ see devices:
- "/dev/sda:/dev/xvda:rwm"
ports:
- # Publish container port 9000 as host port 8080
+ # Publish container port 9000 as host port 8080
- "8080:9000"
- # Publish container UDP port 9001 as host port 8081 on interface 127.0.0.1
+ # Publish container UDP port 9001 as host port 8081 on interface 127.0.0.1
- "127.0.0.1:8081:9001/udp"
- # Publish container port 9002 as a random host port
+ # Publish container port 9002 as a random host port
- "9002"
- # Publish container port 9003 as a free host port in range 8000-8100
- # (the host port will be selected by the Docker daemon)
+ # Publish container port 9003 as a free host port in range 8000-8100
+ # (the host port will be selected by the Docker daemon)
- "8000-8100:9003"
- # Publish container ports 9010-9020 to host ports 7000-7010
+ # Publish container ports 9010-9020 to host ports 7000-7010
- "7000-7010:9010-9020"
env:
SECRET_KEY: "ssssh"
@@ -1792,8 +1792,8 @@ see log_options:
syslog-address: tcp://my-syslog-server:514
syslog-facility: daemon
- # NOTE: in Docker 1.13+ the "syslog-tag" option was renamed to "tag" for
- # older docker installs, use "syslog-tag" instead
+ # NOTE: in Docker 1.13+ the "syslog-tag" option was renamed to "tag" for
+ # older docker installs, use "syslog-tag" instead
tag: myservice
- name: Create db container and connect to network
@@ -1903,8 +1903,8 @@ see image: nginx:1.13
state: started
healthcheck:
- # Check if nginx server is healthy by curl'ing the server.
- # If this fails or timeouts, the healthcheck fails.
+ # Check if nginx server is healthy by curl'ing the server.
+ # If this fails or timeouts, the healthcheck fails.
test: ["CMD", "curl", "--fail", "http://nginx.host.com"]
interval: 1m30s
timeout: 10s
@@ -1918,7 +1918,7 @@ see image: nginx:1.13
state: started
healthcheck:
- # The "NONE" check needs to be specified
+ # The "NONE" check needs to be specified
test: ["NONE"]
- name: Create a tmpfs with a size and mode
@@ -1938,11 +1938,11 @@ see image: ubuntu:18.04
state: started
device_read_bps:
- # Limit read rate for /dev/sda to 20 mebibytes per second
+ # Limit read rate for /dev/sda to 20 mebibytes per second
- path: /dev/sda
rate: 20M
device_read_iops:
- # Limit read rate for /dev/sdb to 300 IO per second
+ # Limit read rate for /dev/sdb to 300 IO per second
- path: /dev/sdb
rate: 300
@@ -1961,9 +1961,8 @@ see count: -1 # this means we want all
capabilities:
# We have one OR condition: 'gpu' AND 'utility'
- -
- - gpu
- - utility
+ - - gpu
+ - utility
# See https://github.com/NVIDIA/nvidia-container-runtime#supported-driver-capabilities
# for a list of capabilities supported by the nvidia driver
@@ -1973,8 +1972,8 @@ see image: ubuntu:18.04
state: started
storage_opts:
- # Limit root filesystem to 12 MB - note that this requires special storage backends
- # (https://fabianlee.org/2020/01/15/docker-use-overlay2-with-an-xfs-backing-filesystem-to-limit-rootfs-size/)
+ # Limit root filesystem to 12 MB - note that this requires special storage backends
+ # (https://fabianlee.org/2020/01/15/docker-use-overlay2-with-an-xfs-backing-filesystem-to-limit-rootfs-size/)
size: 12m
name
string / required
-Image name. Name format must be one of name, repository/name, or registry_server:port/name. - The name can optionally include the tag by appending :tag_name, or it can contain a digest by appending @hash:digest.
Image name. Name format must be one of name, repository/name, or registry_server:port/name.
The name can optionally include the tag by appending :tag_name, or it can contain a digest by appending @hash:digest.
name
string / required
Image name. Name format must be one of name, repository/name, or registry_server:port/name. - The name can optionally include the tag by appending :tag_name, or it can contain a digest by appending @hash:digest.
Image name. Name format must be one of name, repository/name, or registry_server:port/name.
The name can optionally include the tag by appending :tag_name, or it can contain a digest by appending @hash:digest.
- name: Create secret foo (from a file on the control machine)
community.docker.docker_secret:
name: foo
- # If the file is JSON or binary, Ansible might modify it (because
- # it is first decoded and later re-encoded). Base64-encoding the
- # file directly after reading it prevents this to happen.
+ # If the file is JSON or binary, Ansible might modify it (because
+ # it is first decoded and later re-encoded). Base64-encoding the
+ # file directly after reading it prevents this to happen.
data: "{{ lookup('file', '/path/to/secret/file') | b64encode }}"
data_is_b64: true
state: present
@@ -532,7 +532,7 @@ see labels:
bar: baz
one: '1'
- # Adding a new label will cause a remove/create of the secret
+ # Adding a new label will cause a remove/create of the secret
two: '2'
state: present
@@ -543,7 +543,7 @@ see labels:
bar: baz
one: '1'
- # Even though 'two' is missing, there is no change to the existing secret
+ # Even though 'two' is missing, there is no change to the existing secret
state: present
- name: Update an existing label
diff --git a/pr/1020/docker_swarm_service_module.html b/pr/1020/docker_swarm_service_module.html
index 1c221b33..69c31047 100644
--- a/pr/1020/docker_swarm_service_module.html
+++ b/pr/1020/docker_swarm_service_module.html
@@ -1442,8 +1442,8 @@ see name: myservice
image: nginx:1.13
healthcheck:
- # Check if nginx server is healthy by curl'ing the server.
- # If this fails or timeouts, the healthcheck fails.
+ # Check if nginx server is healthy by curl'ing the server.
+ # If this fails or timeouts, the healthcheck fails.
test: ["CMD", "curl", "--fail", "http://nginx.host.com"]
interval: 1m30s
timeout: 10s
diff --git a/pr/1020/docker_volume_module.html b/pr/1020/docker_volume_module.html
index c28f1b39..20ac6382 100644
--- a/pr/1020/docker_volume_module.html
+++ b/pr/1020/docker_volume_module.html
@@ -303,7 +303,7 @@ see driver_options
dictionary
Dictionary of volume settings. Consult docker docs for valid options and values: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options.
+Dictionary of volume settings. Consult the Docker documentation for valid options and values: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options.
Default: {}