ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 03:11:24 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Use semantic markup (modules a-c) (#6671)

Browse source 
* Use semantic markup.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:46:33 +02:00 • committed by GitHub
parent 7ae8cc9902
commit 6fc1df9b83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
32 changed files with 193 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

46
plugins/modules/consul.py
View file

@ -21,8 +21,8 @@ description:
notify the health of the entire node to the cluster.
Service level checks do not require a check name or id as these are derived
by Consul from the Service name and id respectively by appending 'service:'
Node level checks require a I(check_name) and optionally a I(check_id)."
- Currently, there is no complete way to retrieve the script, interval or ttl
Node level checks require a O(check_name) and optionally a O(check_id)."
- Currently, there is no complete way to retrieve the script, interval or TTL
metadata for a registered check. Without this metadata it is not possible to
tell if the data supplied with ansible represents a change to a check. As a
result this does not attempt to determine changes and will always report a
@ -56,7 +56,7 @@ options:
service_id:
type: str
description:
- The ID for the service, must be unique per node. If I(state=absent),
- The ID for the service, must be unique per node. If O(state=absent),
defaults to the service name if supplied.
host:
type: str
@ -86,12 +86,12 @@ options:
type: int
description:
- The port on which the service is listening. Can optionally be supplied for
registration of a service, i.e. if I(service_name) or I(service_id) is set.
registration of a service, that is if O(service_name) or O(service_id) is set.
service_address:
type: str
description:
- The address to advertise that the service will be listening on.
This value will be passed as the I(address) parameter to Consul's
This value will be passed as the C(address) parameter to Consul's
C(/v1/agent/service/register) API method, so refer to the Consul API
documentation for further details.
tags:
@ -103,19 +103,19 @@ options:
type: str
description:
- The script/command that will be run periodically to check the health of the service.
- Requires I(interval) to be provided.
- Requires O(interval) to be provided.
interval:
type: str
description:
- The interval at which the service check will be run.
This is a number with a C(s) or C(m) suffix to signify the units of seconds or minutes e.g C(15s) or C(1m).
If no suffix is supplied C(s) will be used by default, e.g. C(10) will be C(10s).
- Required if one of the parameters I(script), I(http), or I(tcp) is specified.
This is a number with a V(s) or V(m) suffix to signify the units of seconds or minutes, for example V(15s) or V(1m).
If no suffix is supplied V(s) will be used by default, for example V(10) will be V(10s).
- Required if one of the parameters O(script), O(http), or O(tcp) is specified.
check_id:
type: str
description:
- An ID for the service check. If I(state=absent), defaults to
I(check_name). Ignored if part of a service definition.
- An ID for the service check. If O(state=absent), defaults to
O(check_name). Ignored if part of a service definition.
check_name:
type: str
description:
@ -124,34 +124,34 @@ options:
ttl:
type: str
description:
- Checks can be registered with a ttl instead of a I(script) and I(interval)
- Checks can be registered with a TTL instead of a O(script) and O(interval)
this means that the service will check in with the agent before the
ttl expires. If it doesn't the check will be considered failed.
TTL expires. If it doesn't the check will be considered failed.
Required if registering a check and the script an interval are missing
Similar to the interval this is a number with a C(s) or C(m) suffix to
signify the units of seconds or minutes e.g C(15s) or C(1m).
If no suffix is supplied C(s) will be used by default, e.g. C(10) will be C(10s).
Similar to the interval this is a number with a V(s) or V(m) suffix to
signify the units of seconds or minutes, for example V(15s) or V(1m).
If no suffix is supplied V(s) will be used by default, for example V(10) will be V(10s).
tcp:
type: str
description:
- Checks can be registered with a TCP port. This means that consul
will check if the connection attempt to that port is successful (that is, the port is currently accepting connections).
The format is C(host:port), for example C(localhost:80).
- Requires I(interval) to be provided.
The format is V(host:port), for example V(localhost:80).
- Requires O(interval) to be provided.
version_added: '1.3.0'
http:
type: str
description:
- Checks can be registered with an HTTP endpoint. This means that consul
will check that the http endpoint returns a successful HTTP status.
- Requires I(interval) to be provided.
- Requires O(interval) to be provided.
timeout:
type: str
description:
- A custom HTTP check timeout. The consul default is 10 seconds.
Similar to the interval this is a number with a C(s) or C(m) suffix to
signify the units of seconds or minutes, e.g. C(15s) or C(1m).
If no suffix is supplied C(s) will be used by default, e.g. C(10) will be C(10s).
Similar to the interval this is a number with a V(s) or V(m) suffix to
signify the units of seconds or minutes, for example V(15s) or V(1m).
If no suffix is supplied V(s) will be used by default, for example V(10) will be V(10s).
token:
type: str
description:
@ -159,7 +159,7 @@ options:
ack_params_state_absent:
type: bool
description:
- Disable deprecation warning when using parameters incompatible with I(state=absent).
- Disable deprecation warning when using parameters incompatible with O(state=absent).
'''
EXAMPLES = '''