mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
Hetzner failover IP: refactoring (#56203)
* Rename helper function. * Extract hetzner.py module_utils. * Rewrite docs. * Add module docs fragment. * Split up get_failover function. * Add tests for new function. * hetzner_pass -> hetzner_password * Move common argspec to module_utils.
This commit is contained in:
Felix Fontein
René Moser
parent
7a02c40bbc
commit
bd47e64bc7
4 changed files with 222 additions and 139 deletions
|
|
@ -22,17 +22,13 @@ author:
|
|||
- Felix Fontein (@felixfontein)
|
||||
description:
|
||||
- Manage Hetzner's failover IPs.
|
||||
- See L(https://wiki.hetzner.de/index.php/Failover/en,Hetzner's documentation) for details
|
||||
on failover IPs.
|
||||
seealso:
|
||||
- name: Failover IP documentation
|
||||
description: Hetzner's documentation on failover IPs.
|
||||
link: https://wiki.hetzner.de/index.php/Failover/en
|
||||
extends_documentation_fragment:
|
||||
- hetzner
|
||||
options:
|
||||
hetzner_user:
|
||||
description: The username for the Robot webservice user.
|
||||
type: str
|
||||
required: yes
|
||||
hetzner_pass:
|
||||
description: The password for the Robot webservice user.
|
||||
type: str
|
||||
required: yes
|
||||
failover_ip:
|
||||
description: The failover IP address.
|
||||
type: str
|
||||
|
|
@ -65,14 +61,14 @@ EXAMPLES = r'''
|
|||
- name: Set value of failover IP 1.2.3.4 to 5.6.7.8
|
||||
hetzner_failover_ip:
|
||||
hetzner_user: foo
|
||||
hetzner_pass: bar
|
||||
hetzner_password: bar
|
||||
failover_ip: 1.2.3.4
|
||||
value: 5.6.7.8
|
||||
|
||||
- name: Set value of failover IP 1.2.3.4 to unrouted
|
||||
hetzner_failover_ip:
|
||||
hetzner_user: foo
|
||||
hetzner_pass: bar
|
||||
hetzner_password: bar
|
||||
failover_ip: 1.2.3.4
|
||||
state: unrouted
|
||||
'''
|
||||
|
|
@ -92,119 +88,24 @@ state:
|
|||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.urls import fetch_url
|
||||
from ansible.module_utils.six.moves.urllib.parse import urlencode
|
||||
|
||||
# The API endpoint is fixed.
|
||||
BASE_URL = "https://robot-ws.your-server.de"
|
||||
|
||||
|
||||
def fetch_url_json(module, url, method='GET', timeout=10, data=None, headers=None, accept_errors=None):
|
||||
'''
|
||||
Make general request to Hetzner's JSON robot API.
|
||||
'''
|
||||
module.params['url_username'] = module.params['hetzner_user']
|
||||
module.params['url_password'] = module.params['hetzner_pass']
|
||||
resp, info = fetch_url(module, url, method=method, timeout=timeout, data=data, headers=headers)
|
||||
try:
|
||||
content = resp.read()
|
||||
except AttributeError:
|
||||
content = info.pop('body', None)
|
||||
|
||||
if not content:
|
||||
module.fail_json(msg='Cannot retrieve content from {0}'.format(url))
|
||||
|
||||
try:
|
||||
result = module.from_json(content.decode('utf8'))
|
||||
if 'error' in result:
|
||||
if accept_errors:
|
||||
if result['error']['code'] in accept_errors:
|
||||
return result, result['error']['code']
|
||||
module.fail_json(msg='Request failed: {0} {1} ({2})'.format(
|
||||
result['error']['status'],
|
||||
result['error']['code'],
|
||||
result['error']['message']
|
||||
))
|
||||
return result, None
|
||||
except ValueError:
|
||||
module.fail_json(msg='Cannot decode content retrieved from {0}'.format(url))
|
||||
|
||||
|
||||
def get_failover(module, ip):
|
||||
'''
|
||||
Get current routing target of failover IP.
|
||||
|
||||
The value ``None`` represents unrouted.
|
||||
|
||||
See https://robot.your-server.de/doc/webservice/en.html#get-failover-failover-ip
|
||||
'''
|
||||
url = "{0}/failover/{1}".format(BASE_URL, ip)
|
||||
result, error = fetch_url_json(module, url)
|
||||
if 'failover' not in result:
|
||||
module.fail_json(msg='Cannot interpret result: {0}'.format(result))
|
||||
return result['failover']['active_server_ip']
|
||||
|
||||
|
||||
def set_failover(module, ip, value, timeout=180):
|
||||
'''
|
||||
Set current routing target of failover IP.
|
||||
|
||||
Return a pair ``(value, changed)``. The value ``None`` for ``value`` represents unrouted.
|
||||
|
||||
See https://robot.your-server.de/doc/webservice/en.html#post-failover-failover-ip
|
||||
and https://robot.your-server.de/doc/webservice/en.html#delete-failover-failover-ip
|
||||
'''
|
||||
url = "{0}/failover/{1}".format(BASE_URL, ip)
|
||||
if value is None:
|
||||
result, error = fetch_url_json(
|
||||
module,
|
||||
url,
|
||||
method='DELETE',
|
||||
timeout=timeout,
|
||||
accept_errors=['FAILOVER_ALREADY_ROUTED']
|
||||
)
|
||||
else:
|
||||
headers = {"Content-type": "application/x-www-form-urlencoded"}
|
||||
data = dict(
|
||||
active_server_ip=value,
|
||||
)
|
||||
result, error = fetch_url_json(
|
||||
module,
|
||||
url,
|
||||
method='POST',
|
||||
timeout=timeout,
|
||||
data=urlencode(data),
|
||||
headers=headers,
|
||||
accept_errors=['FAILOVER_ALREADY_ROUTED']
|
||||
)
|
||||
if error is not None:
|
||||
return value, False
|
||||
else:
|
||||
return result['failover']['active_server_ip'], True
|
||||
|
||||
|
||||
def get_state(value):
|
||||
'''
|
||||
Create result dictionary for failover IP's value.
|
||||
|
||||
The value ``None`` represents unrouted.
|
||||
'''
|
||||
return dict(
|
||||
value=value,
|
||||
state='routed' if value else 'unrouted'
|
||||
)
|
||||
from ansible.module_utils.hetzner import (
|
||||
HETZNER_DEFAULT_ARGUMENT_SPEC,
|
||||
get_failover,
|
||||
set_failover,
|
||||
get_failover_state,
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = dict(
|
||||
failover_ip=dict(type='str', required=True),
|
||||
state=dict(type='str', default='routed', choices=['routed', 'unrouted']),
|
||||
value=dict(type='str'),
|
||||
timeout=dict(type='int', default=180),
|
||||
)
|
||||
argument_spec.update(HETZNER_DEFAULT_ARGUMENT_SPEC)
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
hetzner_user=dict(type='str', required=True),
|
||||
hetzner_pass=dict(type='str', required=True, no_log=True),
|
||||
failover_ip=dict(type='str', required=True),
|
||||
state=dict(type='str', default='routed', choices=['routed', 'unrouted']),
|
||||
value=dict(type='str'),
|
||||
timeout=dict(type='int', default=180),
|
||||
),
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_if=(
|
||||
('state', 'routed', ['value']),
|
||||
|
|
@ -214,7 +115,7 @@ def main():
|
|||
failover_ip = module.params['failover_ip']
|
||||
value = get_failover(module, failover_ip)
|
||||
changed = False
|
||||
before = get_state(value)
|
||||
before = get_failover_state(value)
|
||||
|
||||
if module.params['state'] == 'routed':
|
||||
new_value = module.params['value']
|
||||
|
|
@ -228,7 +129,7 @@ def main():
|
|||
else:
|
||||
value, changed = set_failover(module, failover_ip, new_value, timeout=module.params['timeout'])
|
||||
|
||||
after = get_state(value)
|
||||
after = get_failover_state(value)
|
||||
module.exit_json(
|
||||
changed=changed,
|
||||
diff=dict(
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue