mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -26,7 +26,6 @@ options:
|
|||
- "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,
|
||||
the module will automatically replace 'tcp' in the connection URL with 'https'."
|
||||
required: false
|
||||
default: "unix://var/run/docker.sock"
|
||||
aliases:
|
||||
- docker_url
|
||||
|
@ -34,55 +33,43 @@ options:
|
|||
description:
|
||||
- When verifying the authenticity of the Docker Host server, provide the expected name of the server.
|
||||
default: localhost
|
||||
required: false
|
||||
api_version:
|
||||
description:
|
||||
- The version of the Docker API running on the Docker Host. Defaults to the latest version of the API
|
||||
supported by docker-py.
|
||||
required: false
|
||||
default: default provided by docker-py
|
||||
aliases:
|
||||
- docker_api_version
|
||||
timeout:
|
||||
description:
|
||||
- The maximum amount of time in seconds to wait on a response from the API.
|
||||
required: false
|
||||
default: 60
|
||||
cacert_path:
|
||||
description:
|
||||
- Use a CA certificate when performing server verification by providing the path to a CA certificate file.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- tls_ca_cert
|
||||
cert_path:
|
||||
description:
|
||||
- Path to the client's TLS certificate file.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- tls_client_cert
|
||||
key_path:
|
||||
description:
|
||||
- Path to the client's TLS key file.
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- tls_client_key
|
||||
ssl_version:
|
||||
description:
|
||||
- Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
|
||||
required: false
|
||||
default: "1.0"
|
||||
tls:
|
||||
description:
|
||||
- Secure the connection to the API by using TLS without verifying the authenticity of the Docker host
|
||||
server.
|
||||
default: false
|
||||
tls_verify:
|
||||
description:
|
||||
- Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
|
||||
default: false
|
||||
|
||||
notes:
|
||||
- Connect to the Docker daemon by providing parameters with each task or by defining environment variables.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue