mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
[PR #6755/242258eb backport][stable-7] Refactor consul_session to support authentication with tokens (#6879)
Refactor consul_session to support authentication with tokens (#6755)
* Split into separate PR
* Refactor test, add author to inactive maintainers
* Add changelog fragment and correct requirements section on module documentation
* Add changelog fragment and correct requirements section on module documentation
* Update changelogs/fragments/6755-refactor-consul-session-to-use-requests-lib-instead-of-consul.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Valerio Poggi <vrpoggigmail.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 242258eb53)
Co-authored-by: Valerio Poggi <106782233+valeriopoggi@users.noreply.github.com>
This commit is contained in:
patchback[bot]
GitHub
parent
b2417accbf
commit
fe4099c163
6 changed files with 166 additions and 44 deletions
|
|
@ -17,10 +17,10 @@ description:
|
|||
to implement distributed locks. In depth documentation for working with
|
||||
sessions can be found at http://www.consul.io/docs/internals/sessions.html
|
||||
requirements:
|
||||
- python-consul
|
||||
- requests
|
||||
author:
|
||||
- Steve Gargan (@sgargan)
|
||||
- Håkon Lerring (@Hakon)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
|
@ -147,15 +147,15 @@ EXAMPLES = '''
|
|||
ttl: 600 # sec
|
||||
'''
|
||||
|
||||
try:
|
||||
import consul
|
||||
from requests.exceptions import ConnectionError
|
||||
python_consul_installed = True
|
||||
except ImportError:
|
||||
python_consul_installed = False
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
import requests
|
||||
from requests.exceptions import ConnectionError
|
||||
has_requests = True
|
||||
except ImportError:
|
||||
has_requests = False
|
||||
|
||||
|
||||
def execute(module):
|
||||
|
||||
|
|
@ -169,15 +169,74 @@ def execute(module):
|
|||
remove_session(module)
|
||||
|
||||
|
||||
class RequestError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def handle_consul_response_error(response):
|
||||
if 400 <= response.status_code < 600:
|
||||
raise RequestError('%d %s' % (response.status_code, response.content))
|
||||
|
||||
|
||||
def get_consul_url(module):
|
||||
return '%s://%s:%s/v1' % (module.params.get('scheme'),
|
||||
module.params.get('host'), module.params.get('port'))
|
||||
|
||||
|
||||
def get_auth_headers(module):
|
||||
if 'token' in module.params and module.params.get('token') is not None:
|
||||
return {'X-Consul-Token': module.params.get('token')}
|
||||
else:
|
||||
return {}
|
||||
|
||||
|
||||
def list_sessions(module, datacenter):
|
||||
url = '%s/session/list' % get_consul_url(module)
|
||||
headers = get_auth_headers(module)
|
||||
response = requests.get(
|
||||
url,
|
||||
headers=headers,
|
||||
params={
|
||||
'dc': datacenter},
|
||||
verify=module.params.get('validate_certs'))
|
||||
handle_consul_response_error(response)
|
||||
return response.json()
|
||||
|
||||
|
||||
def list_sessions_for_node(module, node, datacenter):
|
||||
url = '%s/session/node/%s' % (get_consul_url(module), node)
|
||||
headers = get_auth_headers(module)
|
||||
response = requests.get(
|
||||
url,
|
||||
headers=headers,
|
||||
params={
|
||||
'dc': datacenter},
|
||||
verify=module.params.get('validate_certs'))
|
||||
handle_consul_response_error(response)
|
||||
return response.json()
|
||||
|
||||
|
||||
def get_session_info(module, session_id, datacenter):
|
||||
url = '%s/session/info/%s' % (get_consul_url(module), session_id)
|
||||
headers = get_auth_headers(module)
|
||||
response = requests.get(
|
||||
url,
|
||||
headers=headers,
|
||||
params={
|
||||
'dc': datacenter},
|
||||
verify=module.params.get('validate_certs'))
|
||||
handle_consul_response_error(response)
|
||||
return response.json()
|
||||
|
||||
|
||||
def lookup_sessions(module):
|
||||
|
||||
datacenter = module.params.get('datacenter')
|
||||
|
||||
state = module.params.get('state')
|
||||
consul_client = get_consul_api(module)
|
||||
try:
|
||||
if state == 'list':
|
||||
sessions_list = consul_client.session.list(dc=datacenter)
|
||||
sessions_list = list_sessions(module, datacenter)
|
||||
# Ditch the index, this can be grabbed from the results
|
||||
if sessions_list and len(sessions_list) >= 2:
|
||||
sessions_list = sessions_list[1]
|
||||
|
|
@ -185,14 +244,14 @@ def lookup_sessions(module):
|
|||
sessions=sessions_list)
|
||||
elif state == 'node':
|
||||
node = module.params.get('node')
|
||||
sessions = consul_client.session.node(node, dc=datacenter)
|
||||
sessions = list_sessions_for_node(module, node, datacenter)
|
||||
module.exit_json(changed=True,
|
||||
node=node,
|
||||
sessions=sessions)
|
||||
elif state == 'info':
|
||||
session_id = module.params.get('id')
|
||||
|
||||
session_by_id = consul_client.session.info(session_id, dc=datacenter)
|
||||
session_by_id = get_session_info(module, session_id, datacenter)
|
||||
module.exit_json(changed=True,
|
||||
session_id=session_id,
|
||||
sessions=session_by_id)
|
||||
|
|
@ -201,6 +260,31 @@ def lookup_sessions(module):
|
|||
module.fail_json(msg="Could not retrieve session info %s" % e)
|
||||
|
||||
|
||||
def create_session(module, name, behavior, ttl, node,
|
||||
lock_delay, datacenter, checks):
|
||||
url = '%s/session/create' % get_consul_url(module)
|
||||
headers = get_auth_headers(module)
|
||||
create_data = {
|
||||
"LockDelay": lock_delay,
|
||||
"Node": node,
|
||||
"Name": name,
|
||||
"Checks": checks,
|
||||
"Behavior": behavior,
|
||||
}
|
||||
if ttl is not None:
|
||||
create_data["TTL"] = "%ss" % str(ttl) # TTL is in seconds
|
||||
response = requests.put(
|
||||
url,
|
||||
headers=headers,
|
||||
params={
|
||||
'dc': datacenter},
|
||||
json=create_data,
|
||||
verify=module.params.get('validate_certs'))
|
||||
handle_consul_response_error(response)
|
||||
create_session_response_dict = response.json()
|
||||
return create_session_response_dict["ID"]
|
||||
|
||||
|
||||
def update_session(module):
|
||||
|
||||
name = module.params.get('name')
|
||||
|
|
@ -211,18 +295,16 @@ def update_session(module):
|
|||
behavior = module.params.get('behavior')
|
||||
ttl = module.params.get('ttl')
|
||||
|
||||
consul_client = get_consul_api(module)
|
||||
|
||||
try:
|
||||
session = consul_client.session.create(
|
||||
name=name,
|
||||
behavior=behavior,
|
||||
ttl=ttl,
|
||||
node=node,
|
||||
lock_delay=delay,
|
||||
dc=datacenter,
|
||||
checks=checks
|
||||
)
|
||||
session = create_session(module,
|
||||
name=name,
|
||||
behavior=behavior,
|
||||
ttl=ttl,
|
||||
node=node,
|
||||
lock_delay=delay,
|
||||
datacenter=datacenter,
|
||||
checks=checks
|
||||
)
|
||||
module.exit_json(changed=True,
|
||||
session_id=session,
|
||||
name=name,
|
||||
|
|
@ -235,13 +317,22 @@ def update_session(module):
|
|||
module.fail_json(msg="Could not create/update session %s" % e)
|
||||
|
||||
|
||||
def destroy_session(module, session_id):
|
||||
url = '%s/session/destroy/%s' % (get_consul_url(module), session_id)
|
||||
headers = get_auth_headers(module)
|
||||
response = requests.put(
|
||||
url,
|
||||
headers=headers,
|
||||
verify=module.params.get('validate_certs'))
|
||||
handle_consul_response_error(response)
|
||||
return response.content == "true"
|
||||
|
||||
|
||||
def remove_session(module):
|
||||
session_id = module.params.get('id')
|
||||
|
||||
consul_client = get_consul_api(module)
|
||||
|
||||
try:
|
||||
consul_client.session.destroy(session_id)
|
||||
destroy_session(module, session_id)
|
||||
|
||||
module.exit_json(changed=True,
|
||||
session_id=session_id)
|
||||
|
|
@ -250,25 +341,22 @@ def remove_session(module):
|
|||
session_id, e))
|
||||
|
||||
|
||||
def get_consul_api(module):
|
||||
return consul.Consul(host=module.params.get('host'),
|
||||
port=module.params.get('port'),
|
||||
scheme=module.params.get('scheme'),
|
||||
verify=module.params.get('validate_certs'),
|
||||
token=module.params.get('token'))
|
||||
|
||||
|
||||
def test_dependencies(module):
|
||||
if not python_consul_installed:
|
||||
module.fail_json(msg="python-consul required for this module. "
|
||||
"see https://python-consul.readthedocs.io/en/latest/#installation")
|
||||
if not has_requests:
|
||||
raise ImportError(
|
||||
"requests required for this module. See https://pypi.org/project/requests/")
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = dict(
|
||||
checks=dict(type='list', elements='str'),
|
||||
delay=dict(type='int', default='15'),
|
||||
behavior=dict(type='str', default='release', choices=['release', 'delete']),
|
||||
behavior=dict(
|
||||
type='str',
|
||||
default='release',
|
||||
choices=[
|
||||
'release',
|
||||
'delete']),
|
||||
ttl=dict(type='int'),
|
||||
host=dict(type='str', default='localhost'),
|
||||
port=dict(type='int', default=8500),
|
||||
|
|
@ -277,7 +365,15 @@ def main():
|
|||
id=dict(type='str'),
|
||||
name=dict(type='str'),
|
||||
node=dict(type='str'),
|
||||
state=dict(type='str', default='present', choices=['absent', 'info', 'list', 'node', 'present']),
|
||||
state=dict(
|
||||
type='str',
|
||||
default='present',
|
||||
choices=[
|
||||
'absent',
|
||||
'info',
|
||||
'list',
|
||||
'node',
|
||||
'present']),
|
||||
datacenter=dict(type='str'),
|
||||
token=dict(type='str', no_log=True),
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue