ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 11:58:43 +00:00
Code Packages Projects Releases Wiki Activity

Fix doc fragments indents.

Browse Source
This commit is contained in:
Felix Fontein 2024-12-29 15:47:57 +01:00
parent 6172a9291c
commit c10ae4a24d
2 changed files with 213 additions and 213 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
plugins/doc_fragments/attributes.py
View File

@ -24,25 +24,25 @@ attributes:
INFO_MODULE = r''' INFO_MODULE = r'''
options: {} options: {}
attributes: attributes:
check_mode: check_mode:
support: full support: full
details: details:
- This action does not modify state. - This action does not modify state.
diff_mode: diff_mode:
support: N/A support: N/A
details: details:
- This action does not modify state. - This action does not modify state.
''' '''
ACTIONGROUP_DOCKER = r''' ACTIONGROUP_DOCKER = r'''
options: {} options: {}
attributes: attributes:
action_group: action_group:
description: Use C(group/docker) or C(group/community.docker.docker) in C(module_defaults) to set defaults for this module. description: Use C(group/docker) or C(group/community.docker.docker) in C(module_defaults) to set defaults for this module.
support: full support: full
membership: membership:
- community.docker.docker - community.docker.docker
- docker - docker
''' '''
CONN = r""" CONN = r"""
@ -67,16 +67,16 @@ attributes:
FACTS_MODULE = r''' FACTS_MODULE = r'''
options: {} options: {}
attributes: attributes:
check_mode: check_mode:
support: full support: full
details: details:
- This action does not modify state. - This action does not modify state.
diff_mode: diff_mode:
support: N/A support: N/A
details: details:
- This action does not modify state. - This action does not modify state.
facts: facts:
support: full support: full
''' '''
FILES = r""" FILES = r"""

378
plugins/doc_fragments/docker.py
View File

@ -116,35 +116,35 @@ notes:
VAR_NAMES = r''' VAR_NAMES = r'''
options: options:
docker_host: docker_host:
vars: vars:
- name: ansible_docker_docker_host - name: ansible_docker_docker_host
tls_hostname: tls_hostname:
vars: vars:
- name: ansible_docker_tls_hostname - name: ansible_docker_tls_hostname
api_version: api_version:
vars: vars:
- name: ansible_docker_api_version - name: ansible_docker_api_version
timeout: timeout:
vars: vars:
- name: ansible_docker_timeout - name: ansible_docker_timeout
ca_path: ca_path:
vars: vars:
- name: ansible_docker_ca_cert - name: ansible_docker_ca_cert
- name: ansible_docker_ca_path - name: ansible_docker_ca_path
version_added: 3.6.0 version_added: 3.6.0
client_cert: client_cert:
vars: vars:
- name: ansible_docker_client_cert - name: ansible_docker_client_cert
client_key: client_key:
vars: vars:
- name: ansible_docker_client_key - name: ansible_docker_client_key
tls: tls:
vars: vars:
- name: ansible_docker_tls - name: ansible_docker_tls
validate_certs: validate_certs:
vars: vars:
- name: ansible_docker_validate_certs - name: ansible_docker_validate_certs
''' '''
# Additional, more specific stuff for minimal Docker SDK for Python version < 2.0 # Additional, more specific stuff for minimal Docker SDK for Python version < 2.0
@ -182,89 +182,89 @@ requirements:
# Docker doc fragment when using the vendored API access code # Docker doc fragment when using the vendored API access code
API_DOCUMENTATION = r''' API_DOCUMENTATION = r'''
options: options:
docker_host: docker_host:
description: description:
- 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, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, TCP connection string. For example, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection,
the module will automatically replace C(tcp) in the connection URL with C(https). the module will automatically replace C(tcp) in the connection URL with C(https).
- If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used - If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used
instead. If the environment variable is not set, the default value will be used. instead. If the environment variable is not set, the default value will be used.
type: str type: str
default: unix:///var/run/docker.sock default: unix:///var/run/docker.sock
aliases: [ docker_url ] aliases: [ 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 E(DOCKER_TLS_HOSTNAME) will - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_HOSTNAME) will
be used instead. If the environment variable is not set, the default value will be used. be used instead. If the environment variable is not set, the default value will be used.
- Note that this option had a default value V(localhost) in older versions. It was removed in community.docker 3.0.0. - Note that this option had a default value V(localhost) in older versions. It was removed in community.docker 3.0.0.
type: str type: str
api_version: api_version:
description: description:
- The version of the Docker API running on the Docker Host. - The version of the Docker API running on the Docker Host.
- Defaults to the latest version of the API supported by this collection and the docker daemon. - Defaults to the latest version of the API supported by this collection and the docker daemon.
- If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be - If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be
used instead. If the environment variable is not set, the default value will be used. used instead. If the environment variable is not set, the default value will be used.
type: str type: str
default: auto default: auto
aliases: [ docker_api_version ] aliases: [ 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 E(DOCKER_TIMEOUT) will be used - If the value is not specified in the task, the value of environment variable E(DOCKER_TIMEOUT) will be used
instead. If the environment variable is not set, the default value will be used. instead. If the environment variable is not set, the default value will be used.
type: int type: int
default: 60 default: 60
ca_path: ca_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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
- This option was called O(ca_cert) and got renamed to O(ca_path) in community.docker 3.6.0. The old name has - This option was called O(ca_cert) and got renamed to O(ca_path) in community.docker 3.6.0. The old name has
been added as an alias and can still be used. been added as an alias and can still be used.
type: path type: path
aliases: [ ca_cert, tls_ca_cert, cacert_path ] aliases: [ ca_cert, tls_ca_cert, cacert_path ]
client_cert: client_cert:
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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
type: path type: path
aliases: [ tls_client_cert, cert_path ] aliases: [ tls_client_cert, cert_path ]
client_key: client_key:
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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
type: path type: path
aliases: [ tls_client_key, key_path ] aliases: [ tls_client_key, key_path ]
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. Note that if O(validate_certs) is set to V(true) as well, it will take precedence. server. Note that if O(validate_certs) is set to V(true) as well, it will take precedence.
- If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used
instead. If the environment variable is not set, the default value will be used. instead. If the environment variable is not set, the default value will be used.
type: bool type: bool
default: false default: false
use_ssh_client: use_ssh_client:
description: description:
- For SSH transports, use the C(ssh) CLI tool instead of paramiko. - For SSH transports, use the C(ssh) CLI tool instead of paramiko.
type: bool type: bool
default: false default: false
version_added: 1.5.0 version_added: 1.5.0
validate_certs: validate_certs:
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 E(DOCKER_TLS_VERIFY) will be - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_VERIFY) will be
used instead. If the environment variable is not set, the default value will be used. used instead. If the environment variable is not set, the default value will be used.
type: bool type: bool
default: false default: false
aliases: [ tls_verify ] aliases: [ tls_verify ]
debug: debug:
description: description:
- Debug mode - Debug mode
type: bool type: bool
default: false default: false
notes: notes:
- Connect to the Docker daemon by providing parameters with each task or by defining environment variables. - Connect to the Docker daemon by providing parameters with each task or by defining environment variables.
@ -289,83 +289,83 @@ requirements:
# Docker doc fragment when using the Docker CLI # Docker doc fragment when using the Docker CLI
CLI_DOCUMENTATION = r''' CLI_DOCUMENTATION = r'''
options: options:
docker_cli: docker_cli:
description: description:
- Path to the Docker CLI. If not provided, will search for Docker CLI on the E(PATH). - Path to the Docker CLI. If not provided, will search for Docker CLI on the E(PATH).
type: path type: path
docker_host: docker_host:
description: description:
- 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, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection, TCP connection string. For example, V(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection,
the module will automatically replace C(tcp) in the connection URL with C(https). the module will automatically replace C(tcp) in the connection URL with C(https).
- If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used - If the value is not specified in the task, the value of environment variable E(DOCKER_HOST) will be used
instead. If the environment variable is not set, the default value will be used. instead. If the environment variable is not set, the default value will be used.
- Mutually exclusive with O(cli_context). If neither O(docker_host) nor O(cli_context) are provided, the - Mutually exclusive with O(cli_context). If neither O(docker_host) nor O(cli_context) are provided, the
value V(unix:///var/run/docker.sock) is used. value V(unix:///var/run/docker.sock) is used.
type: str type: str
aliases: [ docker_url ] aliases: [ 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 E(DOCKER_TLS_HOSTNAME) will - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_HOSTNAME) will
be used instead. If the environment variable is not set, the default value will be used. be used instead. If the environment variable is not set, the default value will be used.
type: str type: str
api_version: api_version:
description: description:
- The version of the Docker API running on the Docker Host. - The version of the Docker API running on the Docker Host.
- Defaults to the latest version of the API supported by this collection and the docker daemon. - Defaults to the latest version of the API supported by this collection and the docker daemon.
- If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be - If the value is not specified in the task, the value of environment variable E(DOCKER_API_VERSION) will be
used instead. If the environment variable is not set, the default value will be used. used instead. If the environment variable is not set, the default value will be used.
type: str type: str
default: auto default: auto
aliases: [ docker_api_version ] aliases: [ docker_api_version ]
ca_path: ca_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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(ca.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
type: path type: path
aliases: [ ca_cert, tls_ca_cert, cacert_path ] aliases: [ ca_cert, tls_ca_cert, cacert_path ]
client_cert: client_cert:
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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(cert.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
type: path type: path
aliases: [ tls_client_cert, cert_path ] aliases: [ tls_client_cert, cert_path ]
client_key: client_key:
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 E(DOCKER_CERT_PATH) is set, - If the value is not specified in the task and the environment variable E(DOCKER_CERT_PATH) is set,
the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used. the file C(key.pem) from the directory specified in the environment variable E(DOCKER_CERT_PATH) will be used.
type: path type: path
aliases: [ tls_client_key, key_path ] aliases: [ tls_client_key, key_path ]
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. Note that if O(validate_certs) is set to V(true) as well, it will take precedence. server. Note that if O(validate_certs) is set to V(true) as well, it will take precedence.
- If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS) will be used
instead. If the environment variable is not set, the default value will be used. instead. If the environment variable is not set, the default value will be used.
type: bool type: bool
default: false default: false
validate_certs: validate_certs:
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 E(DOCKER_TLS_VERIFY) will be - If the value is not specified in the task, the value of environment variable E(DOCKER_TLS_VERIFY) will be
used instead. If the environment variable is not set, the default value will be used. used instead. If the environment variable is not set, the default value will be used.
type: bool type: bool
default: false default: false
aliases: [ tls_verify ] aliases: [ tls_verify ]
# debug: # debug:
# description: # description:
# - Debug mode # - Debug mode
# type: bool # type: bool
# default: false # default: false
cli_context: cli_context:
description: description:
- The Docker CLI context to use. - The Docker CLI context to use.
- Mutually exclusive with O(docker_host). - Mutually exclusive with O(docker_host).
type: str type: str
notes: notes:
- Connect to the Docker daemon by providing parameters with each task or by defining environment variables. - Connect to the Docker daemon by providing parameters with each task or by defining environment variables.