mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
334 lines
12 KiB
Python
334 lines
12 KiB
Python
|
# -*- coding: utf-8 -*-
|
||
|
|
# (c) 2017, René Moser <mail@renemoser.net>
|
||
|
|
# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
|
||
|
|
|
||
|
|
from __future__ import absolute_import, division, print_function
|
||
|
|
__metaclass__ = type
|
||
|
|
|
||
|
|
import os
|
||
|
|
import time
|
||
|
|
import random
|
||
|
|
import urllib
|
||
|
|
from ansible.module_utils.six.moves import configparser
|
||
|
|
from ansible.module_utils._text import to_text, to_native
|
||
|
|
from ansible.module_utils.urls import fetch_url
|
||
|
|
|
||
|
|
|
||
|
|
VULTR_API_ENDPOINT = "https://api.vultr.com"
|
||
|
|
VULTR_USER_AGENT = 'Ansible Vultr'
|
||
|
|
|
||
|
|
|
||
|
|
def vultr_argument_spec():
|
||
|
|
return dict(
|
||
|
|
api_key=dict(type='str', default=os.environ.get('VULTR_API_KEY'), no_log=True),
|
||
|
|
api_timeout=dict(type='int', default=os.environ.get('VULTR_API_TIMEOUT')),
|
||
|
|
api_retries=dict(type='int', default=os.environ.get('VULTR_API_RETRIES')),
|
||
|
|
api_retry_max_delay=dict(type='int', default=os.environ.get('VULTR_API_RETRY_MAX_DELAY')),
|
||
|
|
api_account=dict(type='str', default=os.environ.get('VULTR_API_ACCOUNT') or 'default'),
|
||
|
|
api_endpoint=dict(type='str', default=os.environ.get('VULTR_API_ENDPOINT')),
|
||
|
|
validate_certs=dict(type='bool', default=True),
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class Vultr:
|
||
|
|
|
||
|
|
def __init__(self, module, namespace):
|
||
|
|
|
||
|
|
if module._name.startswith('vr_'):
|
||
|
|
module.deprecate("The Vultr modules were renamed. The prefix of the modules changed from vr_ to vultr_", version='2.11')
|
||
|
|
|
||
|
|
self.module = module
|
||
|
|
|
||
|
|
# Namespace use for returns
|
||
|
|
self.namespace = namespace
|
||
|
|
self.result = {
|
||
|
|
'changed': False,
|
||
|
|
namespace: dict(),
|
||
|
|
'diff': dict(before=dict(), after=dict())
|
||
|
|
}
|
||
|
|
|
||
|
|
# For caching HTTP API responses
|
||
|
|
self.api_cache = dict()
|
||
|
|
|
||
|
|
try:
|
||
|
|
config = self.read_env_variables()
|
||
|
|
config.update(Vultr.read_ini_config(self.module.params.get('api_account')))
|
||
|
|
except KeyError:
|
||
|
|
config = {}
|
||
|
|
|
||
|
|
try:
|
||
|
|
self.api_config = {
|
||
|
|
'api_key': self.module.params.get('api_key') or config.get('key'),
|
||
|
|
'api_timeout': self.module.params.get('api_timeout') or int(config.get('timeout') or 60),
|
||
|
|
'api_retries': self.module.params.get('api_retries') or int(config.get('retries') or 5),
|
||
|
|
'api_retry_max_delay': self.module.params.get('api_retry_max_delay') or int(config.get('retry_max_delay') or 12),
|
||
|
|
'api_endpoint': self.module.params.get('api_endpoint') or config.get('endpoint') or VULTR_API_ENDPOINT,
|
||
|
|
}
|
||
|
|
except ValueError as e:
|
||
|
|
self.fail_json(msg="One of the following settings, "
|
||
|
|
"in section '%s' in the ini config file has not an int value: timeout, retries. "
|
||
|
|
"Error was %s" % (self.module.params.get('api_account'), to_native(e)))
|
||
|
|
|
||
|
|
if not self.api_config.get('api_key'):
|
||
|
|
self.module.fail_json(msg="The API key is not speicied. Please refer to the documentation.")
|
||
|
|
|
||
|
|
# Common vultr returns
|
||
|
|
self.result['vultr_api'] = {
|
||
|
|
'api_account': self.module.params.get('api_account'),
|
||
|
|
'api_timeout': self.api_config['api_timeout'],
|
||
|
|
'api_retries': self.api_config['api_retries'],
|
||
|
|
'api_retry_max_delay': self.api_config['api_retry_max_delay'],
|
||
|
|
'api_endpoint': self.api_config['api_endpoint'],
|
||
|
|
}
|
||
|
|
|
||
|
|
# Headers to be passed to the API
|
||
|
|
self.headers = {
|
||
|
|
'API-Key': "%s" % self.api_config['api_key'],
|
||
|
|
'User-Agent': VULTR_USER_AGENT,
|
||
|
|
'Accept': 'application/json',
|
||
|
|
}
|
||
|
|
|
||
|
|
def read_env_variables(self):
|
||
|
|
keys = ['key', 'timeout', 'retries', 'retry_max_delay', 'endpoint']
|
||
|
|
env_conf = {}
|
||
|
|
for key in keys:
|
||
|
|
if 'VULTR_API_%s' % key.upper() not in os.environ:
|
||
|
|
continue
|
||
|
|
env_conf[key] = os.environ['VULTR_API_%s' % key.upper()]
|
||
|
|
|
||
|
|
return env_conf
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def read_ini_config(ini_group):
|
||
|
|
paths = (
|
||
|
|
os.path.join(os.path.expanduser('~'), '.vultr.ini'),
|
||
|
|
os.path.join(os.getcwd(), 'vultr.ini'),
|
||
|
|
)
|
||
|
|
if 'VULTR_API_CONFIG' in os.environ:
|
||
|
|
paths += (os.path.expanduser(os.environ['VULTR_API_CONFIG']),)
|
||
|
|
|
||
|
|
conf = configparser.ConfigParser()
|
||
|
|
conf.read(paths)
|
||
|
|
|
||
|
|
if not conf._sections.get(ini_group):
|
||
|
|
return dict()
|
||
|
|
|
||
|
|
return dict(conf.items(ini_group))
|
||
|
|
|
||
|
|
def fail_json(self, **kwargs):
|
||
|
|
self.result.update(kwargs)
|
||
|
|
self.module.fail_json(**self.result)
|
||
|
|
|
||
|
|
def get_yes_or_no(self, key):
|
||
|
|
if self.module.params.get(key) is not None:
|
||
|
|
return 'yes' if self.module.params.get(key) is True else 'no'
|
||
|
|
|
||
|
|
def switch_enable_disable(self, resource, param_key, resource_key=None):
|
||
|
|
if resource_key is None:
|
||
|
|
resource_key = param_key
|
||
|
|
|
||
|
|
param = self.module.params.get(param_key)
|
||
|
|
if param is None:
|
||
|
|
return
|
||
|
|
|
||
|
|
r_value = resource.get(resource_key)
|
||
|
|
if r_value in ['yes', 'no']:
|
||
|
|
if param and r_value != 'yes':
|
||
|
|
return "enable"
|
||
|
|
elif not param and r_value != 'no':
|
||
|
|
return "disable"
|
||
|
|
else:
|
||
|
|
if param and not r_value:
|
||
|
|
return "enable"
|
||
|
|
elif not param and r_value:
|
||
|
|
return "disable"
|
||
|
|
|
||
|
|
def api_query(self, path="/", method="GET", data=None):
|
||
|
|
url = self.api_config['api_endpoint'] + path
|
||
|
|
|
||
|
|
if data:
|
||
|
|
data_encoded = dict()
|
||
|
|
data_list = ""
|
||
|
|
for k, v in data.items():
|
||
|
|
if isinstance(v, list):
|
||
|
|
for s in v:
|
||
|
|
try:
|
||
|
|
data_list += '&%s[]=%s' % (k, urllib.quote(s))
|
||
|
|
except AttributeError:
|
||
|
|
data_list += '&%s[]=%s' % (k, urllib.parse.quote(s))
|
||
|
|
elif v is not None:
|
||
|
|
data_encoded[k] = v
|
||
|
|
try:
|
||
|
|
data = urllib.urlencode(data_encoded) + data_list
|
||
|
|
except AttributeError:
|
||
|
|
data = urllib.parse.urlencode(data_encoded) + data_list
|
||
|
|
|
||
|
|
retry_max_delay = self.api_config['api_retry_max_delay']
|
||
|
|
randomness = random.randint(0, 1000) / 1000.0
|
||
|
|
|
||
|
|
for retry in range(0, self.api_config['api_retries']):
|
||
|
|
response, info = fetch_url(
|
||
|
|
module=self.module,
|
||
|
|
url=url,
|
||
|
|
data=data,
|
||
|
|
method=method,
|
||
|
|
headers=self.headers,
|
||
|
|
timeout=self.api_config['api_timeout'],
|
||
|
|
)
|
||
|
|
|
||
|
|
if info.get('status') == 200:
|
||
|
|
break
|
||
|
|
|
||
|
|
# Vultr has a rate limiting requests per second, try to be polite
|
||
|
|
# Use exponential backoff plus a little bit of randomness
|
||
|
|
delay = 2 ** retry + randomness
|
||
|
|
if delay > retry_max_delay:
|
||
|
|
delay = retry_max_delay + randomness
|
||
|
|
time.sleep(delay)
|
||
|
|
|
||
|
|
else:
|
||
|
|
self.fail_json(msg="Reached API retries limit %s for URL %s, method %s with data %s. Returned %s, with body: %s %s" % (
|
||
|
|
self.api_config['api_retries'],
|
||
|
|
url,
|
||
|
|
method,
|
||
|
|
data,
|
||
|
|
info['status'],
|
||
|
|
info['msg'],
|
||
|
|
info.get('body')
|
||
|
|
))
|
||
|
|
|
||
|
|
if info.get('status') != 200:
|
||
|
|
self.fail_json(msg="URL %s, method %s with data %s. Returned %s, with body: %s %s" % (
|
||
|
|
url,
|
||
|
|
method,
|
||
|
|
data,
|
||
|
|
info['status'],
|
||
|
|
info['msg'],
|
||
|
|
info.get('body')
|
||
|
|
))
|
||
|
|
|
||
|
|
res = response.read()
|
||
|
|
if not res:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
try:
|
||
|
|
return self.module.from_json(to_native(res)) or {}
|
||
|
|
except ValueError as e:
|
||
|
|
self.module.fail_json(msg="Could not process response into json: %s" % e)
|
||
|
|
|
||
|
|
def query_resource_by_key(self, key, value, resource='regions', query_by='list', params=None, use_cache=False, id_key=None, optional=False):
|
||
|
|
if not value:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
r_list = None
|
||
|
|
if use_cache:
|
||
|
|
r_list = self.api_cache.get(resource)
|
||
|
|
|
||
|
|
if not r_list:
|
||
|
|
r_list = self.api_query(path="/v1/%s/%s" % (resource, query_by), data=params)
|
||
|
|
if use_cache:
|
||
|
|
self.api_cache.update({
|
||
|
|
resource: r_list
|
||
|
|
})
|
||
|
|
|
||
|
|
if not r_list:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
elif isinstance(r_list, list):
|
||
|
|
for r_data in r_list:
|
||
|
|
if str(r_data[key]) == str(value):
|
||
|
|
return r_data
|
||
|
|
if id_key is not None and to_text(r_data[id_key]) == to_text(value):
|
||
|
|
return r_data
|
||
|
|
elif isinstance(r_list, dict):
|
||
|
|
for r_id, r_data in r_list.items():
|
||
|
|
if str(r_data[key]) == str(value):
|
||
|
|
return r_data
|
||
|
|
if id_key is not None and to_text(r_data[id_key]) == to_text(value):
|
||
|
|
return r_data
|
||
|
|
if not optional:
|
||
|
|
if id_key:
|
||
|
|
msg = "Could not find %s with ID or %s: %s" % (resource, key, value)
|
||
|
|
else:
|
||
|
|
msg = "Could not find %s with %s: %s" % (resource, key, value)
|
||
|
|
self.module.fail_json(msg=msg)
|
||
|
|
return {}
|
||
|
|
|
||
|
|
@staticmethod
|
||
|
|
def normalize_result(resource, schema, remove_missing_keys=True):
|
||
|
|
if remove_missing_keys:
|
||
|
|
fields_to_remove = set(resource.keys()) - set(schema.keys())
|
||
|
|
for field in fields_to_remove:
|
||
|
|
resource.pop(field)
|
||
|
|
|
||
|
|
for search_key, config in schema.items():
|
||
|
|
if search_key in resource:
|
||
|
|
if 'convert_to' in config:
|
||
|
|
if config['convert_to'] == 'int':
|
||
|
|
resource[search_key] = int(resource[search_key])
|
||
|
|
elif config['convert_to'] == 'float':
|
||
|
|
resource[search_key] = float(resource[search_key])
|
||
|
|
elif config['convert_to'] == 'bool':
|
||
|
|
resource[search_key] = True if resource[search_key] == 'yes' else False
|
||
|
|
|
||
|
|
if 'transform' in config:
|
||
|
|
resource[search_key] = config['transform'](resource[search_key])
|
||
|
|
|
||
|
|
if 'key' in config:
|
||
|
|
resource[config['key']] = resource[search_key]
|
||
|
|
del resource[search_key]
|
||
|
|
|
||
|
|
return resource
|
||
|
|
|
||
|
|
def get_result(self, resource):
|
||
|
|
if resource:
|
||
|
|
if isinstance(resource, list):
|
||
|
|
self.result[self.namespace] = [Vultr.normalize_result(item, self.returns) for item in resource]
|
||
|
|
else:
|
||
|
|
self.result[self.namespace] = Vultr.normalize_result(resource, self.returns)
|
||
|
|
|
||
|
|
return self.result
|
||
|
|
|
||
|
|
def get_plan(self, plan=None, key='name', optional=False):
|
||
|
|
value = plan or self.module.params.get('plan')
|
||
|
|
|
||
|
|
return self.query_resource_by_key(
|
||
|
|
key=key,
|
||
|
|
value=value,
|
||
|
|
resource='plans',
|
||
|
|
use_cache=True,
|
||
|
|
id_key='VPSPLANID',
|
||
|
|
optional=optional,
|
||
|
|
)
|
||
|
|
|
||
|
|
def get_firewallgroup(self, firewallgroup=None, key='description'):
|
||
|
|
value = firewallgroup or self.module.params.get('firewallgroup')
|
||
|
|
|
||
|
|
return self.query_resource_by_key(
|
||
|
|
key=key,
|
||
|
|
value=value,
|
||
|
|
resource='firewall',
|
||
|
|
query_by='group_list',
|
||
|
|
use_cache=True
|
||
|
|
)
|
||
|
|
|
||
|
|
def get_application(self, application=None, key='name'):
|
||
|
|
value = application or self.module.params.get('application')
|
||
|
|
|
||
|
|
return self.query_resource_by_key(
|
||
|
|
key=key,
|
||
|
|
value=value,
|
||
|
|
resource='app',
|
||
|
|
use_cache=True
|
||
|
|
)
|
||
|
|
|
||
|
|
def get_region(self, region=None, key='name'):
|
||
|
|
value = region or self.module.params.get('region')
|
||
|
|
|
||
|
|
return self.query_resource_by_key(
|
||
|
|
key=key,
|
||
|
|
value=value,
|
||
|
|
resource='regions',
|
||
|
|
use_cache=True
|
||
|
|
)
|