minor doc fixes

reviewable/pr18780/r1
Brian Coca 9 years ago
parent cc305adfb6
commit cf764bf060

@ -21,7 +21,7 @@ short_description: manage CloudTrail creation and deletion
description: description:
- Creates or deletes CloudTrail configuration. Ensures logging is also enabled. - Creates or deletes CloudTrail configuration. Ensures logging is also enabled.
version_added: "2.0" version_added: "2.0"
author: author:
- "Ansible Core Team" - "Ansible Core Team"
- "Ted Timmons" - "Ted Timmons"
requirements: requirements:

@ -19,30 +19,30 @@
DOCUMENTATION = """ DOCUMENTATION = """
module: consul module: consul
short_description: "Add, modify & delete services within a consul cluster. short_description: "Add, modify & delete services within a consul cluster."
See http://consul.io for more details."
description: description:
- registers services and checks for an agent with a consul cluster. A service - Registers services and checks for an agent with a consul cluster.
is some process running on the agent node that should be advertised by 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, consul's discovery mechanism. It may optionally supply a check definition,
a periodic service test to notify the consul cluster of service's health. 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. 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 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:'. by Consul from the Service name and id respectively by appending 'service:'
Node level checks require a check_name and optionally a check_id. 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 - 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 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 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 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 changed occurred. An api method is planned to supply this metadata so at that
stage change management will be added. stage change management will be added.
- "See http://consul.io for more details."
requirements: requirements:
- "python >= 2.6" - "python >= 2.6"
- python-consul - python-consul
- requests - requests
version_added: "2.0" version_added: "2.0"
author: "Steve Gargan (@sgargan)" author: "Steve Gargan (@sgargan)"
options: options:
state: state:
description: description:
@ -50,7 +50,7 @@ options:
required: true required: true
choices: ['present', 'absent'] choices: ['present', 'absent']
service_name: service_name:
desciption: description:
- Unique name for the service on a node, must be unique per node, - Unique name for the service on a node, must be unique per node,
required if registering a service. May be ommitted if registering required if registering a service. May be ommitted if registering
a node level check a node level check
@ -95,11 +95,11 @@ options:
interval: interval:
description: description:
- the interval at which the service check will be run. This is a number - the interval at which the service check will be run. This is a number
with a s or m suffix to signify the units of seconds or minutes e.g with a s or m suffix to signify the units of seconds or minutes e.g
15s or 1m. If no suffix is supplied, m will be used by default e.g. 15s or 1m. If no suffix is supplied, m will be used by default e.g.
1 will be 1m. Required if the script param is specified. 1 will be 1m. Required if the script param is specified.
required: false required: false
default: None default: None
check_id: check_id:
description: description:
- an ID for the service check, defaults to the check name, ignored if - an ID for the service check, defaults to the check name, ignored if
@ -113,20 +113,19 @@ options:
required: false required: false
default: None default: None
ttl: ttl:
description: description:
- checks can be registered with a ttl instead of a script and interval - checks can be registered with a ttl instead of a script and interval
this means that the service will check in with the agent before the 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 Required if registering a check and the script an interval are missing
Similar to the interval this is a number with a s or m suffix to Similar to the interval this is a number with a s or m suffix to
signify the units of seconds or minutes e.g 15s or 1m. If no suffix signify the units of seconds or minutes e.g 15s or 1m. If no suffix
is supplied, m will be used by default e.g. 1 will be 1m is supplied, m will be used by default e.g. 1 will be 1m
required: false required: false
default: None default: None
token: token:
description: description:
- the token key indentifying an ACL rule set. May be required to - the token key indentifying an ACL rule set. May be required to register services.
register services.
required: false required: false
default: None default: None
""" """

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

Loading…
Cancel
Save