mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
This reverts commit 4373b155a5.
This commit is contained in:
Adam Miller
GitHub
parent
950ff6bce6
commit
78023e79d7
18 changed files with 1881 additions and 538 deletions
|
|
@ -19,17 +19,31 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
import os
|
||||
import re
|
||||
import copy
|
||||
import json
|
||||
|
||||
from datetime import datetime
|
||||
|
||||
from ansible.module_utils.six import iteritems
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
from ansible.module_utils.k8s.helper import\
|
||||
AnsibleMixin,\
|
||||
HAS_STRING_UTILS
|
||||
|
||||
try:
|
||||
import kubernetes
|
||||
from openshift.dynamic import DynamicClient
|
||||
from openshift.helper.kubernetes import KubernetesObjectHelper
|
||||
from openshift.helper.openshift import OpenShiftObjectHelper
|
||||
from openshift.helper.exceptions import KubernetesException
|
||||
HAS_K8S_MODULE_HELPER = True
|
||||
except ImportError:
|
||||
except ImportError as exc:
|
||||
class KubernetesObjectHelper(object):
|
||||
pass
|
||||
|
||||
class OpenShiftObjectHelper(object):
|
||||
pass
|
||||
|
||||
HAS_K8S_MODULE_HELPER = False
|
||||
|
||||
try:
|
||||
|
|
@ -38,188 +52,52 @@ try:
|
|||
except ImportError:
|
||||
HAS_YAML = False
|
||||
|
||||
try:
|
||||
import dictdiffer
|
||||
HAS_DICTDIFFER = True
|
||||
except ImportError:
|
||||
HAS_DICTDIFFER = False
|
||||
|
||||
try:
|
||||
import urllib3
|
||||
urllib3.disable_warnings()
|
||||
except ImportError:
|
||||
def remove_secret_data(obj_dict):
|
||||
""" Remove any sensitive data from a K8s dict"""
|
||||
if obj_dict.get('data'):
|
||||
# Secret data
|
||||
obj_dict.pop('data')
|
||||
if obj_dict.get('string_data'):
|
||||
# The API should not return sting_data in Secrets, but just in case
|
||||
obj_dict.pop('string_data')
|
||||
if obj_dict['metadata'].get('annotations'):
|
||||
# Remove things like 'openshift.io/token-secret' from metadata
|
||||
for key in [k for k in obj_dict['metadata']['annotations'] if 'secret' in k]:
|
||||
obj_dict['metadata']['annotations'].pop(key)
|
||||
|
||||
|
||||
def to_snake(name):
|
||||
""" Convert a string from camel to snake """
|
||||
if not name:
|
||||
return name
|
||||
|
||||
def _replace(m):
|
||||
m = m.group(0)
|
||||
return m[0] + '_' + m[1:]
|
||||
|
||||
p = r'[a-z][A-Z]|' \
|
||||
r'[A-Z]{2}[a-z]'
|
||||
return re.sub(p, _replace, name).lower()
|
||||
|
||||
|
||||
class DateTimeEncoder(json.JSONEncoder):
|
||||
# When using json.dumps() with K8s object, pass cls=DateTimeEncoder to handle any datetime objects
|
||||
def default(self, o):
|
||||
if isinstance(o, datetime):
|
||||
return o.isoformat()
|
||||
return json.JSONEncoder.default(self, o)
|
||||
|
||||
|
||||
class KubernetesAnsibleModuleHelper(AnsibleMixin, KubernetesObjectHelper):
|
||||
pass
|
||||
|
||||
ARG_ATTRIBUTES_BLACKLIST = ('property_path',)
|
||||
|
||||
COMMON_ARG_SPEC = {
|
||||
'state': {
|
||||
'default': 'present',
|
||||
'choices': ['present', 'absent'],
|
||||
},
|
||||
'force': {
|
||||
'type': 'bool',
|
||||
'default': False,
|
||||
},
|
||||
'resource_definition': {
|
||||
'type': 'dict',
|
||||
'aliases': ['definition', 'inline']
|
||||
},
|
||||
'src': {
|
||||
'type': 'path',
|
||||
},
|
||||
'kind': {},
|
||||
'name': {},
|
||||
'namespace': {},
|
||||
'api_version': {
|
||||
'default': 'v1',
|
||||
'aliases': ['api', 'version'],
|
||||
},
|
||||
}
|
||||
|
||||
AUTH_ARG_SPEC = {
|
||||
'kubeconfig': {
|
||||
'type': 'path',
|
||||
},
|
||||
'context': {},
|
||||
'host': {},
|
||||
'api_key': {
|
||||
'no_log': True,
|
||||
},
|
||||
'username': {},
|
||||
'password': {
|
||||
'no_log': True,
|
||||
},
|
||||
'verify_ssl': {
|
||||
'type': 'bool',
|
||||
},
|
||||
'ssl_ca_cert': {
|
||||
'type': 'path',
|
||||
},
|
||||
'cert_file': {
|
||||
'type': 'path',
|
||||
},
|
||||
'key_file': {
|
||||
'type': 'path',
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
class K8sAnsibleMixin(object):
|
||||
_argspec_cache = None
|
||||
|
||||
@property
|
||||
def argspec(self):
|
||||
"""
|
||||
Introspect the model properties, and return an Ansible module arg_spec dict.
|
||||
:return: dict
|
||||
"""
|
||||
if self._argspec_cache:
|
||||
return self._argspec_cache
|
||||
argument_spec = copy.deepcopy(COMMON_ARG_SPEC)
|
||||
argument_spec.update(copy.deepcopy(AUTH_ARG_SPEC))
|
||||
self._argspec_cache = argument_spec
|
||||
return self._argspec_cache
|
||||
|
||||
def get_api_client(self, **auth):
|
||||
auth_args = AUTH_ARG_SPEC.keys()
|
||||
|
||||
auth = auth or getattr(self, 'params', {})
|
||||
|
||||
configuration = kubernetes.client.Configuration()
|
||||
for key, value in iteritems(auth):
|
||||
if key in auth_args and value is not None:
|
||||
if key == 'api_key':
|
||||
setattr(configuration, key, {'authorization': "Bearer {0}".format(value)})
|
||||
else:
|
||||
setattr(configuration, key, value)
|
||||
elif key in auth_args and value is None:
|
||||
env_value = os.getenv('K8S_AUTH_{0}'.format(key.upper()), None)
|
||||
if env_value is not None:
|
||||
setattr(configuration, key, env_value)
|
||||
|
||||
kubernetes.client.Configuration.set_default(configuration)
|
||||
|
||||
if auth.get('username') and auth.get('password') and auth.get('host'):
|
||||
auth_method = 'params'
|
||||
elif auth.get('api_key') and auth.get('host'):
|
||||
auth_method = 'params'
|
||||
elif auth.get('kubeconfig') or auth.get('context'):
|
||||
auth_method = 'file'
|
||||
else:
|
||||
auth_method = 'default'
|
||||
|
||||
# First try to do incluster config, then kubeconfig
|
||||
if auth_method == 'default':
|
||||
try:
|
||||
kubernetes.config.load_incluster_config()
|
||||
return DynamicClient(kubernetes.client.ApiClient())
|
||||
except kubernetes.config.ConfigException:
|
||||
return DynamicClient(self.client_from_kubeconfig(auth.get('kubeconfig'), auth.get('context')))
|
||||
|
||||
if auth_method == 'file':
|
||||
return DynamicClient(self.client_from_kubeconfig(auth.get('kubeconfig'), auth.get('context')))
|
||||
|
||||
if auth_method == 'params':
|
||||
return DynamicClient(kubernetes.client.ApiClient(configuration))
|
||||
|
||||
def client_from_kubeconfig(self, config_file, context):
|
||||
try:
|
||||
return kubernetes.config.new_client_from_config(config_file, context)
|
||||
except (IOError, kubernetes.config.ConfigException):
|
||||
# If we failed to load the default config file then we'll return
|
||||
# an empty configuration
|
||||
# If one was specified, we will crash
|
||||
if not config_file:
|
||||
return kubernetes.client.ApiClient()
|
||||
raise
|
||||
|
||||
def remove_aliases(self):
|
||||
"""
|
||||
The helper doesn't know what to do with aliased keys
|
||||
"""
|
||||
for k, v in iteritems(self.argspec):
|
||||
if 'aliases' in v:
|
||||
for alias in v['aliases']:
|
||||
if alias in self.params:
|
||||
self.params.pop(alias)
|
||||
|
||||
def load_resource_definitions(self, src):
|
||||
""" Load the requested src path """
|
||||
result = None
|
||||
path = os.path.normpath(src)
|
||||
if not os.path.exists(path):
|
||||
self.fail_json(msg="Error accessing {0}. Does the file exist?".format(path))
|
||||
try:
|
||||
with open(path, 'r') as f:
|
||||
result = list(yaml.safe_load_all(f))
|
||||
except (IOError, yaml.YAMLError) as exc:
|
||||
self.fail_json(msg="Error loading resource_definition: {0}".format(exc))
|
||||
return result
|
||||
|
||||
@staticmethod
|
||||
def diff_objects(existing, new):
|
||||
if not HAS_DICTDIFFER:
|
||||
return False, []
|
||||
|
||||
def get_shared_attrs(o1, o2):
|
||||
shared_attrs = {}
|
||||
for k, v in o2.items():
|
||||
if isinstance(v, dict):
|
||||
shared_attrs[k] = get_shared_attrs(o1.get(k, {}), v)
|
||||
else:
|
||||
shared_attrs[k] = o1.get(k)
|
||||
return shared_attrs
|
||||
|
||||
diffs = list(dictdiffer.diff(new, get_shared_attrs(existing, new)))
|
||||
match = len(diffs) == 0
|
||||
return match, diffs
|
||||
|
||||
|
||||
class KubernetesAnsibleModule(AnsibleModule, K8sAnsibleMixin):
|
||||
class KubernetesAnsibleModule(AnsibleModule):
|
||||
resource_definition = None
|
||||
api_version = None
|
||||
kind = None
|
||||
helper = None
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
|
||||
|
|
@ -232,5 +110,114 @@ class KubernetesAnsibleModule(AnsibleModule, K8sAnsibleMixin):
|
|||
if not HAS_YAML:
|
||||
self.fail_json(msg="This module requires PyYAML. Try `pip install PyYAML`")
|
||||
|
||||
if not HAS_STRING_UTILS:
|
||||
self.fail_json(msg="This module requires Python string utils. Try `pip install python-string-utils`")
|
||||
|
||||
@property
|
||||
def argspec(self):
|
||||
raise NotImplementedError()
|
||||
|
||||
def get_helper(self, api_version, kind):
|
||||
try:
|
||||
helper = KubernetesAnsibleModuleHelper(api_version=api_version, kind=kind, debug=False)
|
||||
helper.get_model(api_version, kind)
|
||||
return helper
|
||||
except KubernetesException as exc:
|
||||
self.fail_json(msg="Error initializing module helper: {0}".format(exc.message))
|
||||
|
||||
def execute_module(self):
|
||||
raise NotImplementedError()
|
||||
|
||||
def exit_json(self, **return_attributes):
|
||||
""" Filter any sensitive data that we don't want logged """
|
||||
if return_attributes.get('result') and \
|
||||
return_attributes['result'].get('kind') in ('Secret', 'SecretList'):
|
||||
if return_attributes['result'].get('data'):
|
||||
remove_secret_data(return_attributes['result'])
|
||||
elif return_attributes['result'].get('items'):
|
||||
for item in return_attributes['result']['items']:
|
||||
remove_secret_data(item)
|
||||
super(KubernetesAnsibleModule, self).exit_json(**return_attributes)
|
||||
|
||||
def authenticate(self):
|
||||
try:
|
||||
auth_options = {}
|
||||
auth_args = ('host', 'api_key', 'kubeconfig', 'context', 'username', 'password',
|
||||
'cert_file', 'key_file', 'ssl_ca_cert', 'verify_ssl')
|
||||
for key, value in iteritems(self.params):
|
||||
if key in auth_args and value is not None:
|
||||
auth_options[key] = value
|
||||
self.helper.set_client_config(**auth_options)
|
||||
except KubernetesException as e:
|
||||
self.fail_json(msg='Error loading config', error=str(e))
|
||||
|
||||
def remove_aliases(self):
|
||||
"""
|
||||
The helper doesn't know what to do with aliased keys
|
||||
"""
|
||||
for k, v in iteritems(self.argspec):
|
||||
if 'aliases' in v:
|
||||
for alias in v['aliases']:
|
||||
if alias in self.params:
|
||||
self.params.pop(alias)
|
||||
|
||||
def load_resource_definition(self, src):
|
||||
""" Load the requested src path """
|
||||
result = None
|
||||
path = os.path.normpath(src)
|
||||
if not os.path.exists(path):
|
||||
self.fail_json(msg="Error accessing {0}. Does the file exist?".format(path))
|
||||
try:
|
||||
result = yaml.safe_load(open(path, 'r'))
|
||||
except (IOError, yaml.YAMLError) as exc:
|
||||
self.fail_json(msg="Error loading resource_definition: {0}".format(exc))
|
||||
return result
|
||||
|
||||
def resource_to_parameters(self, resource):
|
||||
""" Converts a resource definition to module parameters """
|
||||
parameters = {}
|
||||
for key, value in iteritems(resource):
|
||||
if key in ('apiVersion', 'kind', 'status'):
|
||||
continue
|
||||
elif key == 'metadata' and isinstance(value, dict):
|
||||
for meta_key, meta_value in iteritems(value):
|
||||
if meta_key in ('name', 'namespace', 'labels', 'annotations'):
|
||||
parameters[meta_key] = meta_value
|
||||
elif key in self.helper.argspec and value is not None:
|
||||
parameters[key] = value
|
||||
elif isinstance(value, dict):
|
||||
self._add_parameter(value, [to_snake(key)], parameters)
|
||||
return parameters
|
||||
|
||||
def _add_parameter(self, request, path, parameters):
|
||||
for key, value in iteritems(request):
|
||||
if path:
|
||||
param_name = '_'.join(path + [to_snake(key)])
|
||||
else:
|
||||
param_name = to_snake(key)
|
||||
if param_name in self.helper.argspec and value is not None:
|
||||
parameters[param_name] = value
|
||||
elif isinstance(value, dict):
|
||||
continue_path = copy.copy(path) if path else []
|
||||
continue_path.append(to_snake(key))
|
||||
self._add_parameter(value, continue_path, parameters)
|
||||
else:
|
||||
self.fail_json(
|
||||
msg=("Error parsing resource definition. Encountered {0}, which does not map to a parameter "
|
||||
"expected by the OpenShift Python module.".format(param_name))
|
||||
)
|
||||
|
||||
|
||||
class OpenShiftAnsibleModuleHelper(AnsibleMixin, OpenShiftObjectHelper):
|
||||
pass
|
||||
|
||||
|
||||
class OpenShiftAnsibleModuleMixin(object):
|
||||
|
||||
def get_helper(self, api_version, kind):
|
||||
try:
|
||||
helper = OpenShiftAnsibleModuleHelper(api_version=api_version, kind=kind, debug=False)
|
||||
helper.get_model(api_version, kind)
|
||||
return helper
|
||||
except KubernetesException as exc:
|
||||
self.fail_json(msg="Error initializing module helper: {0}".format(exc.message))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue