mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-26 21:33:02 +00:00
486a179c7a
Address the following error with the test-suite: - plugins/modules/k8s.py:0:0: doc-default-does-not-match-spec: Argument 'append_hash' in argument_spec defines default as (False) but documentation defines default as (None) - plugins/modules/k8s.py:0:0: doc-default-does-not-match-spec: Argument 'apply' in argument_spec defines default as (False) but documentation defines default as (None) - plugins/modules/k8s_service.py:0:0: doc-default-does-not-match-spec: Argument 'apply' in argument_spec defines default as (False) but documentation defines default as (None)
274 lines
8.0 KiB
Python
274 lines
8.0 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2018, KubeVirt Team <@kubevirt>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
|
|
module: k8s_service
|
|
|
|
short_description: Manage Services on Kubernetes
|
|
|
|
author: KubeVirt Team (@kubevirt)
|
|
|
|
description:
|
|
- Use Openshift Python SDK to manage Services on Kubernetes
|
|
|
|
extends_documentation_fragment:
|
|
- community.kubernetes.k8s_auth_options
|
|
- community.kubernetes.k8s_resource_options
|
|
- community.kubernetes.k8s_state_options
|
|
|
|
options:
|
|
merge_type:
|
|
description:
|
|
- Whether to override the default patch merge approach with a specific type. By default, the strategic
|
|
merge will typically be used.
|
|
- For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may
|
|
want to use C(merge) if you see "strategic merge patch format is not supported"
|
|
- See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)
|
|
- Requires openshift >= 0.6.2
|
|
- If more than one merge_type is given, the merge_types will be tried in order
|
|
- If openshift >= 0.6.2, this defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters
|
|
on resource kinds that combine Custom Resources and built-in resources. For openshift < 0.6.2, the default
|
|
is simply C(strategic-merge).
|
|
choices:
|
|
- json
|
|
- merge
|
|
- strategic-merge
|
|
type: list
|
|
elements: str
|
|
name:
|
|
description:
|
|
- Use to specify a Service object name.
|
|
required: true
|
|
type: str
|
|
namespace:
|
|
description:
|
|
- Use to specify a Service object namespace.
|
|
required: true
|
|
type: str
|
|
type:
|
|
description:
|
|
- Specifies the type of Service to create.
|
|
- See U(https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
|
|
choices:
|
|
- NodePort
|
|
- ClusterIP
|
|
- LoadBalancer
|
|
- ExternalName
|
|
type: str
|
|
ports:
|
|
description:
|
|
- A list of ports to expose.
|
|
- U(https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services)
|
|
type: list
|
|
elements: dict
|
|
selector:
|
|
description:
|
|
- Label selectors identify objects this Service should apply to.
|
|
- U(https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
|
|
type: dict
|
|
apply:
|
|
description:
|
|
- C(apply) compares the desired resource definition with the previously supplied resource definition,
|
|
ignoring properties that are automatically generated
|
|
- C(apply) works better with Services than 'force=yes'
|
|
- mutually exclusive with C(merge_type)
|
|
default: False
|
|
type: bool
|
|
|
|
requirements:
|
|
- python >= 2.7
|
|
- openshift >= 0.6.2
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Expose https port with ClusterIP
|
|
community.kubernetes.k8s_service:
|
|
state: present
|
|
name: test-https
|
|
namespace: default
|
|
ports:
|
|
- port: 443
|
|
protocol: TCP
|
|
selector:
|
|
key: special
|
|
|
|
- name: Expose https port with ClusterIP using spec
|
|
community.kubernetes.k8s_service:
|
|
state: present
|
|
name: test-https
|
|
namespace: default
|
|
inline:
|
|
spec:
|
|
ports:
|
|
- port: 443
|
|
protocol: TCP
|
|
selector:
|
|
key: special
|
|
'''
|
|
|
|
RETURN = r'''
|
|
result:
|
|
description:
|
|
- The created, patched, or otherwise present Service object. Will be empty in the case of a deletion.
|
|
returned: success
|
|
type: complex
|
|
contains:
|
|
api_version:
|
|
description: The versioned schema of this representation of an object.
|
|
returned: success
|
|
type: str
|
|
kind:
|
|
description: Always 'Service'.
|
|
returned: success
|
|
type: str
|
|
metadata:
|
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
|
returned: success
|
|
type: complex
|
|
spec:
|
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
|
returned: success
|
|
type: complex
|
|
status:
|
|
description: Current status details for the object.
|
|
returned: success
|
|
type: complex
|
|
'''
|
|
|
|
import copy
|
|
import traceback
|
|
|
|
from collections import defaultdict
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.kubernetes.plugins.module_utils.common import (
|
|
K8sAnsibleMixin, AUTH_ARG_SPEC, COMMON_ARG_SPEC, RESOURCE_ARG_SPEC)
|
|
|
|
|
|
SERVICE_ARG_SPEC = {
|
|
'apply': {
|
|
'type': 'bool',
|
|
'default': False,
|
|
},
|
|
'name': {'required': True},
|
|
'namespace': {'required': True},
|
|
'merge_type': {'type': 'list', 'elements': 'str', 'choices': ['json', 'merge', 'strategic-merge']},
|
|
'selector': {'type': 'dict'},
|
|
'type': {
|
|
'type': 'str',
|
|
'choices': [
|
|
'NodePort', 'ClusterIP', 'LoadBalancer', 'ExternalName'
|
|
],
|
|
},
|
|
'ports': {'type': 'list', 'elements': 'dict'},
|
|
}
|
|
|
|
|
|
class KubernetesService(K8sAnsibleMixin):
|
|
def __init__(self, *args, **kwargs):
|
|
mutually_exclusive = [
|
|
('resource_definition', 'src'),
|
|
('merge_type', 'apply'),
|
|
]
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=self.argspec,
|
|
mutually_exclusive=mutually_exclusive,
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
self.module = module
|
|
self.check_mode = self.module.check_mode
|
|
self.params = self.module.params
|
|
self.fail_json = self.module.fail_json
|
|
self.fail = self.module.fail_json
|
|
self.exit_json = self.module.exit_json
|
|
|
|
super(KubernetesService, self).__init__(*args, **kwargs)
|
|
|
|
self.client = None
|
|
self.warnings = []
|
|
|
|
self.kind = self.params.get('kind')
|
|
self.api_version = self.params.get('api_version')
|
|
self.name = self.params.get('name')
|
|
self.namespace = self.params.get('namespace')
|
|
|
|
self.check_library_version()
|
|
self.set_resource_definitions()
|
|
|
|
@staticmethod
|
|
def merge_dicts(x, y):
|
|
for k in set(x.keys()).union(y.keys()):
|
|
if k in x and k in y:
|
|
if isinstance(x[k], dict) and isinstance(y[k], dict):
|
|
yield (k, dict(KubernetesService.merge_dicts(x[k], y[k])))
|
|
else:
|
|
yield (k, y[k])
|
|
elif k in x:
|
|
yield (k, x[k])
|
|
else:
|
|
yield (k, y[k])
|
|
|
|
@property
|
|
def argspec(self):
|
|
""" argspec property builder """
|
|
argument_spec = copy.deepcopy(AUTH_ARG_SPEC)
|
|
argument_spec.update(COMMON_ARG_SPEC)
|
|
argument_spec.update(RESOURCE_ARG_SPEC)
|
|
argument_spec.update(SERVICE_ARG_SPEC)
|
|
return argument_spec
|
|
|
|
def execute_module(self):
|
|
""" Module execution """
|
|
self.client = self.get_api_client()
|
|
|
|
api_version = 'v1'
|
|
selector = self.params.get('selector')
|
|
service_type = self.params.get('type')
|
|
ports = self.params.get('ports')
|
|
|
|
definition = defaultdict(defaultdict)
|
|
|
|
definition['kind'] = 'Service'
|
|
definition['apiVersion'] = api_version
|
|
|
|
def_spec = definition['spec']
|
|
def_spec['type'] = service_type
|
|
def_spec['ports'] = ports
|
|
def_spec['selector'] = selector
|
|
|
|
def_meta = definition['metadata']
|
|
def_meta['name'] = self.params.get('name')
|
|
def_meta['namespace'] = self.params.get('namespace')
|
|
|
|
# 'resource_definition:' has lower priority than module parameters
|
|
definition = dict(self.merge_dicts(self.resource_definitions[0], definition))
|
|
|
|
resource = self.find_resource('Service', api_version, fail=True)
|
|
definition = self.set_defaults(resource, definition)
|
|
result = self.perform_action(resource, definition)
|
|
|
|
self.exit_json(**result)
|
|
|
|
|
|
def main():
|
|
module = KubernetesService()
|
|
try:
|
|
module.execute_module()
|
|
except Exception as e:
|
|
module.fail_json(msg=str(e), exception=traceback.format_exc())
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|