Normalize booleans in all other plugins and modules. (#440)

This commit is contained in:
Felix Fontein
2022-08-10 21:25:10 +02:00
committed by GitHub
parent 1bf8da2390
commit be58ccc13f
23 changed files with 150 additions and 150 deletions
+5 -5
View File
@@ -23,7 +23,7 @@ DOCUMENTATION = '''
options:
plugin:
description: token that ensures this is a source file for the C(docker_machine) plugin.
required: yes
required: true
choices: ['docker_machine', 'community.docker.docker_machine']
daemon_env:
description:
@@ -46,13 +46,13 @@ DOCUMENTATION = '''
description:
- When C(true), hosts which Docker Machine indicates are in a state other than C(running) will be skipped.
type: bool
default: yes
default: true
verbose_output:
description:
- When C(true), include all available nodes metadata (for exmaple C(Image), C(Region), C(Size)) as a JSON object
named C(docker_machine_node_attributes).
type: bool
default: yes
default: true
'''
EXAMPLES = '''
@@ -71,13 +71,13 @@ plugin: community.docker.docker_machine
# ]
# ...
# }
strict: no
strict: false
keyed_groups:
- separator: ''
key: docker_machine_node_attributes.DriverName
# Example grouping hosts by Digital Machine tag
strict: no
strict: false
keyed_groups:
- prefix: tag
key: 'dm_tags'
+7 -7
View File
@@ -42,16 +42,16 @@ DOCUMENTATION = '''
description: Toggle to (not) include all available nodes metadata (for example C(Platform), C(Architecture), C(OS),
C(EngineVersion))
type: bool
default: yes
default: true
tls:
description: Connect using TLS without verifying the authenticity of the Docker host server.
type: bool
default: no
default: false
validate_certs:
description: Toggle if connecting using TLS with or without verifying the authenticity of the Docker
host server.
type: bool
default: no
default: false
aliases: [ tls_verify ]
client_key:
description: Path to the client's TLS key file.
@@ -92,7 +92,7 @@ DOCUMENTATION = '''
- For SSH transports, use the C(ssh) CLI tool instead of paramiko.
- Requires Docker SDK for Python 4.4.0 or newer.
type: bool
default: no
default: false
version_added: 1.5.0
include_host_uri:
description: Toggle to return the additional attribute C(ansible_host_uri) which contains the URI of the
@@ -100,7 +100,7 @@ DOCUMENTATION = '''
modification as value of option I(docker_host) in Docker Swarm modules when connecting via API.
The port always defaults to C(2376).
type: bool
default: no
default: false
include_host_uri_port:
description: Override the detected port number included in I(ansible_host_uri)
type: int
@@ -118,12 +118,12 @@ docker_host: tcp://my-docker-host:2375
# Example using remote docker with unverified TLS
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2376
tls: yes
tls: true
# Example using remote docker with verified TLS and client certificate verification
plugin: community.docker.docker_swarm
docker_host: tcp://my-docker-host:2376
validate_certs: yes
validate_certs: true
ca_cert: /somewhere/ca.pem
client_key: /somewhere/key.pem
client_cert: /somewhere/cert.pem