cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Properly documenting environment variables in documentation fragment. (#44812)

Browse source
This commit is contained in:
Felix Fontein 2018-08-29 12:30:20 +02:00 committed by John R Barker
parent bbb57f5a95
commit 1ef225601a
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
lib/ansible/utils/module_docs_fragments/docker.py
View file

@ -26,51 +26,71 @@ options:
- "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the - "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the
TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection, TCP connection string. For example, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection,
the module will automatically replace 'tcp' in the connection URL with 'https'." the module will automatically replace 'tcp' in the connection URL with 'https'."
- If the value is not specified in the task, the value of environment variable C(DOCKER_HOST) will be used
instead. If the environment variable is not set, the default value will be used.
default: "unix://var/run/docker.sock" default: "unix://var/run/docker.sock"
aliases: aliases:
- docker_url - docker_url
tls_hostname: tls_hostname:
description: description:
- When verifying the authenticity of the Docker Host server, provide the expected name of the server. - When verifying the authenticity of the Docker Host server, provide the expected name of the server.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_HOSTNAME) will
be used instead. If the environment variable is not set, the default value will be used.
default: localhost default: localhost
api_version: api_version:
description: description:
- The version of the Docker API running on the Docker Host. Defaults to the latest version of the API - The version of the Docker API running on the Docker Host. Defaults to the latest version of the API
supported by docker-py. supported by docker-py.
- If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION) will be
used instead. If the environment variable is not set, the default value will be used.
default: 'auto' default: 'auto'
aliases: aliases:
- docker_api_version - docker_api_version
timeout: timeout:
description: description:
- The maximum amount of time in seconds to wait on a response from the API. - The maximum amount of time in seconds to wait on a response from the API.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TIMEOUT) will be used
instead. If the environment variable is not set, the default value will be used.
default: 60 default: 60
cacert_path: cacert_path:
description: description:
- Use a CA certificate when performing server verification by providing the path to a CA certificate file. - Use a CA certificate when performing server verification by providing the path to a CA certificate file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
the file C(ca.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
aliases: aliases:
- tls_ca_cert - tls_ca_cert
cert_path: cert_path:
description: description:
- Path to the client's TLS certificate file. - Path to the client's TLS certificate file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
the file C(cert.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
aliases: aliases:
- tls_client_cert - tls_client_cert
key_path: key_path:
description: description:
- Path to the client's TLS key file. - Path to the client's TLS key file.
- If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
the file C(key.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
aliases: aliases:
- tls_client_key - tls_client_key
ssl_version: ssl_version:
description: description:
- Provide a valid SSL version number. Default value determined by ssl.py module. - Provide a valid SSL version number. Default value determined by ssl.py module.
- If the value is not specified in the task, the value of environment variable C(DOCKER_SSL_VERSION) will be
used instead.
tls: tls:
description: description:
- Secure the connection to the API by using TLS without verifying the authenticity of the Docker host - Secure the connection to the API by using TLS without verifying the authenticity of the Docker host
server. server.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS) will be used
instead. If the environment variable is not set, the default value will be used.
default: false default: false
type: bool type: bool
tls_verify: tls_verify:
description: description:
- Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
- If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_VERIFY) will be
used instead. If the environment variable is not set, the default value will be used.
default: false default: false
type: bool type: bool
debug: debug: