mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
0eff87d0be
* opennebula: add one_template module
A basic module for maintaining VM templates which should be flexible enough
for most needs ...
* fixup! opennebula: add one_template module
* fixup! fixup! opennebula: add one_template module
(cherry picked from commit cdc415ea1f)
Co-authored-by: Georg Gadinger <nilsding@nilsding.org>
276 lines
7.6 KiB
Python
276 lines
7.6 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# Copyright: (c) 2021, Georg Gadinger <nilsding@nilsding.org>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Make coding more python3-ish
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: one_template
|
|
|
|
short_description: Manages OpenNebula templates
|
|
|
|
version_added: 2.4.0
|
|
|
|
requirements:
|
|
- pyone
|
|
|
|
description:
|
|
- "Manages OpenNebula templates."
|
|
|
|
options:
|
|
id:
|
|
description:
|
|
- A I(id) of the template you would like to manage. If not set then a
|
|
- new template will be created with the given I(name).
|
|
type: int
|
|
name:
|
|
description:
|
|
- A I(name) of the template you would like to manage. If a template with
|
|
- the given name does not exist it will be created, otherwise it will be
|
|
- managed by this module.
|
|
type: str
|
|
template:
|
|
description:
|
|
- A string containing the template contents.
|
|
type: str
|
|
state:
|
|
description:
|
|
- C(present) - state that is used to manage the template.
|
|
- C(absent) - delete the template.
|
|
choices: ["present", "absent"]
|
|
default: present
|
|
type: str
|
|
|
|
notes:
|
|
- Supports C(check_mode). Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually change.
|
|
|
|
extends_documentation_fragment:
|
|
- community.general.opennebula
|
|
|
|
author:
|
|
- "Georg Gadinger (@nilsding)"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Fetch the TEMPLATE by id
|
|
community.general.one_template:
|
|
id: 6459
|
|
register: result
|
|
|
|
- name: Print the TEMPLATE properties
|
|
ansible.builtin.debug:
|
|
var: result
|
|
|
|
- name: Fetch the TEMPLATE by name
|
|
community.general.one_template:
|
|
name: tf-prd-users-workerredis-p6379a
|
|
register: result
|
|
|
|
- name: Create a new or update an existing TEMPLATE
|
|
community.general.one_template:
|
|
name: generic-opensuse
|
|
template: |
|
|
CONTEXT = [
|
|
HOSTNAME = "generic-opensuse"
|
|
]
|
|
CPU = "1"
|
|
CUSTOM_ATTRIBUTE = ""
|
|
DISK = [
|
|
CACHE = "writeback",
|
|
DEV_PREFIX = "sd",
|
|
DISCARD = "unmap",
|
|
IMAGE = "opensuse-leap-15.2",
|
|
IMAGE_UNAME = "oneadmin",
|
|
IO = "threads",
|
|
SIZE = "" ]
|
|
MEMORY = "2048"
|
|
NIC = [
|
|
MODEL = "virtio",
|
|
NETWORK = "testnet",
|
|
NETWORK_UNAME = "oneadmin" ]
|
|
OS = [
|
|
ARCH = "x86_64",
|
|
BOOT = "disk0" ]
|
|
SCHED_REQUIREMENTS = "CLUSTER_ID=\\"100\\""
|
|
VCPU = "2"
|
|
|
|
- name: Delete the TEMPLATE by id
|
|
community.general.one_template:
|
|
id: 6459
|
|
state: absent
|
|
'''
|
|
|
|
RETURN = '''
|
|
id:
|
|
description: template id
|
|
type: int
|
|
returned: when I(state=present)
|
|
sample: 153
|
|
name:
|
|
description: template name
|
|
type: str
|
|
returned: when I(state=present)
|
|
sample: app1
|
|
template:
|
|
description: the parsed template
|
|
type: dict
|
|
returned: when I(state=present)
|
|
group_id:
|
|
description: template's group id
|
|
type: int
|
|
returned: when I(state=present)
|
|
sample: 1
|
|
group_name:
|
|
description: template's group name
|
|
type: str
|
|
returned: when I(state=present)
|
|
sample: one-users
|
|
owner_id:
|
|
description: template's owner id
|
|
type: int
|
|
returned: when I(state=present)
|
|
sample: 143
|
|
owner_name:
|
|
description: template's owner name
|
|
type: str
|
|
returned: when I(state=present)
|
|
sample: ansible-test
|
|
'''
|
|
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.opennebula import OpenNebulaModule
|
|
|
|
|
|
class TemplateModule(OpenNebulaModule):
|
|
def __init__(self):
|
|
argument_spec = dict(
|
|
id=dict(type='int', required=False),
|
|
name=dict(type='str', required=False),
|
|
state=dict(type='str', choices=['present', 'absent'], default='present'),
|
|
template=dict(type='str', required=False),
|
|
)
|
|
|
|
mutually_exclusive = [
|
|
['id', 'name']
|
|
]
|
|
|
|
required_one_of = [('id', 'name')]
|
|
|
|
required_if = [
|
|
['state', 'present', ['template']]
|
|
]
|
|
|
|
OpenNebulaModule.__init__(self,
|
|
argument_spec,
|
|
supports_check_mode=True,
|
|
mutually_exclusive=mutually_exclusive,
|
|
required_one_of=required_one_of,
|
|
required_if=required_if)
|
|
|
|
def run(self, one, module, result):
|
|
params = module.params
|
|
id = params.get('id')
|
|
name = params.get('name')
|
|
desired_state = params.get('state')
|
|
template_data = params.get('template')
|
|
|
|
self.result = {}
|
|
|
|
template = self.get_template_instance(id, name)
|
|
needs_creation = False
|
|
if not template and desired_state != 'absent':
|
|
if id:
|
|
module.fail_json(msg="There is no template with id=" + str(id))
|
|
else:
|
|
needs_creation = True
|
|
|
|
if desired_state == 'absent':
|
|
self.result = self.delete_template(template)
|
|
else:
|
|
if needs_creation:
|
|
self.result = self.create_template(name, template_data)
|
|
else:
|
|
self.result = self.update_template(template, template_data)
|
|
|
|
self.exit()
|
|
|
|
def get_template(self, predicate):
|
|
# -3 means "Resources belonging to the user"
|
|
# the other two parameters are used for pagination, -1 for both essentially means "return all"
|
|
pool = self.one.templatepool.info(-3, -1, -1)
|
|
|
|
for template in pool.VMTEMPLATE:
|
|
if predicate(template):
|
|
return template
|
|
|
|
return None
|
|
|
|
def get_template_by_id(self, template_id):
|
|
return self.get_template(lambda template: (template.ID == template_id))
|
|
|
|
def get_template_by_name(self, template_name):
|
|
return self.get_template(lambda template: (template.NAME == template_name))
|
|
|
|
def get_template_instance(self, requested_id, requested_name):
|
|
if requested_id:
|
|
return self.get_template_by_id(requested_id)
|
|
else:
|
|
return self.get_template_by_name(requested_name)
|
|
|
|
def get_template_info(self, template):
|
|
info = {
|
|
'id': template.ID,
|
|
'name': template.NAME,
|
|
'template': template.TEMPLATE,
|
|
'user_name': template.UNAME,
|
|
'user_id': template.UID,
|
|
'group_name': template.GNAME,
|
|
'group_id': template.GID,
|
|
}
|
|
|
|
return info
|
|
|
|
def create_template(self, name, template_data):
|
|
if not self.module.check_mode:
|
|
self.one.template.allocate("NAME = \"" + name + "\"\n" + template_data)
|
|
|
|
result = self.get_template_info(self.get_template_by_name(name))
|
|
result['changed'] = True
|
|
|
|
return result
|
|
|
|
def update_template(self, template, template_data):
|
|
if not self.module.check_mode:
|
|
# 0 = replace the whole template
|
|
self.one.template.update(template.ID, template_data, 0)
|
|
|
|
result = self.get_template_info(self.get_template_by_id(template.ID))
|
|
if self.module.check_mode:
|
|
# Unfortunately it is not easy to detect if the template would have changed, therefore always report a change here.
|
|
result['changed'] = True
|
|
else:
|
|
# if the previous parsed template data is not equal to the updated one, this has changed
|
|
result['changed'] = template.TEMPLATE != result['template']
|
|
|
|
return result
|
|
|
|
def delete_template(self, template):
|
|
if not template:
|
|
return {'changed': False}
|
|
|
|
if not self.module.check_mode:
|
|
self.one.template.delete(template.ID)
|
|
|
|
return {'changed': True}
|
|
|
|
|
|
def main():
|
|
TemplateModule().run_module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|