added version_added and fixed some doc parsing issues

This commit is contained in:
Brian Coca 2015-10-14 11:06:29 -04:00
parent 6e01848602
commit fdb4a58f97

View file

@ -130,6 +130,7 @@ options:
Interval must also be provided with this option. Interval must also be provided with this option.
required: false required: false
default: None default: None
version_added: "2.0"
timeout: timeout:
description: description:
- A custom HTTP check timeout. The consul default is 10 seconds. - A custom HTTP check timeout. The consul default is 10 seconds.
@ -137,6 +138,7 @@ options:
signify the units of seconds or minutes, e.g. 15s or 1m. signify the units of seconds or minutes, e.g. 15s or 1m.
required: false required: false
default: None default: None
version_added: "2.0"
token: token:
description: 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.
@ -231,8 +233,7 @@ def remove(module):
service_id = module.params.get('service_id') or module.params.get('service_name') service_id = module.params.get('service_id') or module.params.get('service_name')
check_id = module.params.get('check_id') or module.params.get('check_name') check_id = module.params.get('check_id') or module.params.get('check_name')
if not (service_id or check_id): if not (service_id or check_id):
module.fail_json(msg='services and checks are removed by id or name.'\ module.fail_json(msg='services and checks are removed by id or name. please supply a service id/name or a check id/name')
' please supply a service id/name or a check id/name')
if service_id: if service_id:
remove_service(module, service_id) remove_service(module, service_id)
else: else:
@ -245,8 +246,7 @@ def add_check(module, check):
Without this we can't compare to the supplied check and so we must assume Without this we can't compare to the supplied check and so we must assume
a change. ''' a change. '''
if not check.name: if not check.name:
module.fail_json(msg='a check name is required for a node level check,'\ module.fail_json(msg='a check name is required for a node level check, one not attached to a service')
' one not attached to a service')
consul_api = get_consul_api(module) consul_api = get_consul_api(module)
check.register(consul_api) check.register(consul_api)
@ -327,8 +327,7 @@ def parse_check(module):
if len(filter(None, [module.params.get('script'), module.params.get('ttl'), module.params.get('http')])) > 1: if len(filter(None, [module.params.get('script'), module.params.get('ttl'), module.params.get('http')])) > 1:
module.fail_json( module.fail_json(
msg='check are either script, http or ttl driven, supplying more'\ msg='check are either script, http or ttl driven, supplying more than one does not make sense')
' than one does not make sense')
if module.params.get('check_id') or module.params.get('script') or module.params.get('ttl') or module.params.get('http'): if module.params.get('check_id') or module.params.get('script') or module.params.get('ttl') or module.params.get('http'):
@ -357,10 +356,7 @@ def parse_service(module):
) )
elif module.params.get('service_name') and not module.params.get('service_port'): elif module.params.get('service_name') and not module.params.get('service_port'):
module.fail_json( module.fail_json( msg="service_name supplied but no service_port, a port is required to configure a service. Did you configure the 'port' argument meaning 'service_port'?")
msg="service_name supplied but no service_port, a port is required"\
" to configure a service. Did you configure the 'port' "\
"argument meaning 'service_port'?")
class ConsulService(): class ConsulService():
@ -505,8 +501,7 @@ class ConsulCheck():
def test_dependencies(module): def test_dependencies(module):
if not python_consul_installed: if not python_consul_installed:
module.fail_json(msg="python-consul required for this module. "\ module.fail_json(msg="python-consul required for this module. see http://python-consul.readthedocs.org/en/latest/#installation")
"see http://python-consul.readthedocs.org/en/latest/#installation")
def main(): def main():
module = AnsibleModule( module = AnsibleModule(