mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
ead5b1d024
* Adds k8s.py * Two module approach to support overlapping objects * Clarify docs * Clary state and force parameters * Updates examples * Add description and display_name * Fix linting issues
126 lines
2.8 KiB
Python
126 lines
2.8 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2018, Chris Houseknecht <@chouseknecht>
|
|
# 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
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = '''
|
|
|
|
module: k8s
|
|
|
|
short_description: Manage Kubernetes (K8s) objects
|
|
|
|
version_added: "2.5"
|
|
|
|
author: "Chris Houseknecht (@chouseknecht)"
|
|
|
|
description:
|
|
- Use the OpenShift Python client to perform CRUD operations on Kubernetes objects.
|
|
- Supports authentication using either a config file, certificates, password or token.
|
|
|
|
extends_documentation_fragment:
|
|
- kubernetes
|
|
|
|
requirements:
|
|
- "python >= 2.7"
|
|
- "openshift >= 0.3"
|
|
- "PyYAML >= 3.11"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Create a k8s namespace
|
|
k8s:
|
|
name: testing
|
|
api_version: v1
|
|
kind: Namespace
|
|
state: present
|
|
|
|
- name: Create a Service object from an inline definition
|
|
k8s:
|
|
state: present
|
|
definition:
|
|
apiVersion: v1
|
|
kind: Service
|
|
metadata:
|
|
name: web
|
|
namespace: testing
|
|
labels:
|
|
app: galaxy
|
|
service: web
|
|
spec:
|
|
selector:
|
|
app: galaxy
|
|
service: web
|
|
ports:
|
|
- protocol: TCP
|
|
targetPort: 8000
|
|
name: port-8000-tcp
|
|
port: 8000
|
|
|
|
- name: Create a Service object by reading the definition from a file
|
|
k8s:
|
|
state: present
|
|
src: /testing/service.yml
|
|
|
|
- name: Get an existing Service object
|
|
k8s:
|
|
api_version: v1
|
|
kind: Service
|
|
name: web
|
|
namespace: testing
|
|
register: web_service
|
|
|
|
- name: Get a list of all service objects
|
|
k8s:
|
|
api_version: v1
|
|
kind: ServiceList
|
|
namespace: testing
|
|
register: service_list
|
|
|
|
- name: Remove an existing Service object
|
|
k8s:
|
|
state: absent
|
|
api_version: v1
|
|
kind: Service
|
|
namespace: testing
|
|
name: web
|
|
'''
|
|
|
|
RETURN = '''
|
|
result:
|
|
description:
|
|
- The created, patched, or otherwise present object. Will be empty in the case of a deletion.
|
|
returned: success
|
|
type: dict
|
|
request:
|
|
description:
|
|
- The object sent to the API. Useful for troubleshooting unexpected differences and 404 errors.
|
|
returned: when diff is true
|
|
type: dict
|
|
diff:
|
|
description:
|
|
- List of differences found when determining if an existing object will be patched. A copy of the existing object
|
|
is updated with the requested options, and the updated object is then compared to the original. If there are
|
|
differences, they will appear here.
|
|
returned: when diff is true
|
|
type: list
|
|
'''
|
|
|
|
from ansible.module_utils.k8s_common import KubernetesAnsibleModule
|
|
|
|
|
|
def main():
|
|
KubernetesAnsibleModule().execute_module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|