ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

minor doc fixes

Browse source
This commit is contained in:
Brian Coca 2015-07-17 01:19:21 -04:00 committed by Matt Clay
parent 40f77fd07c
commit b789277517
3 changed files with 26 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/ansible/modules/extras/clustering/consul.py
View file

@ -19,24 +19,24 @@
DOCUMENTATION = """
module: consul
short_description: "Add, modify & delete services within a consul cluster.
See http://consul.io for more details."
short_description: "Add, modify & delete services within a consul cluster."
description:
- registers services and checks for an agent with a consul cluster. A service
is some process running on the agent node that should be advertised by
- Registers services and checks for an agent with a consul cluster.
A service is some process running on the agent node that should be advertised by
consul's discovery mechanism. It may optionally supply a check definition,
a periodic service test to notify the consul cluster of service's health.
Checks may also be registered per node e.g. disk usage, or cpu usage and
- "Checks may also be registered per node e.g. disk usage, or cpu usage and
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 check_name and optionally a check_id.
Currently, there is no complete way to retrieve the script, interval or ttl
by Consul from the Service name and id respectively by appending 'service:'
Node level checks require a check_name and optionally a 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
changed occurred. An api method is planned to supply this metadata so at that
stage change management will be added.
- "See http://consul.io for more details."
requirements:
- "python >= 2.6"
- python-consul
@ -50,7 +50,7 @@ options:
required: true
choices: ['present', 'absent']
service_name:
desciption:
description:
- Unique name for the service on a node, must be unique per node,
required if registering a service. May be ommitted if registering
a node level check
@ -125,8 +125,7 @@ options:
default: None
token:
description:
- the token key indentifying an ACL rule set. May be required to
register services.
- the token key indentifying an ACL rule set. May be required to register services.
required: false
default: None
"""

10
lib/ansible/modules/extras/clustering/consul_kv.py
View file

@ -19,14 +19,14 @@
DOCUMENTATION = """
module: consul_kv
short_description: "manipulate entries in the key/value store of a consul
cluster. See http://www.consul.io/docs/agent/http.html#kv for more details."
short_description: Manipulate entries in the key/value store of a consul cluster.
description:
- allows the addition, modification and deletion of key/value entries in a
- Allows the addition, modification and deletion of key/value entries in a
consul cluster via the agent. The entire contents of the record, including
the indices, flags and session are returned as 'value'. If the key
represents a prefix then Note that when a value is removed, the existing
the indices, flags and session are returned as 'value'.
- If the key represents a prefix then Note that when a value is removed, the existing
value if any is returned as part of the results.
- "See http://www.consul.io/docs/agent/http.html#kv for more details."
requirements:
- "python >= 2.6"
- python-consul