1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/cloud/scaleway/scaleway_user_data.py

174 lines
5.1 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
#!/usr/bin/python
# -*- coding: utf-8 -*-
2020-03-09 10:11:07 +01:00
#
# Scaleway user data management module
#
# Copyright (C) 2018 Online SAS.
# https://www.scaleway.com
#
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
module: scaleway_user_data
short_description: Scaleway user_data management module
author: Remy Leone (@remyleone)
2020-03-09 10:11:07 +01:00
description:
- "This module manages user_data on compute instances on Scaleway."
- "It can be used to configure cloud-init for instance"
extends_documentation_fragment:
- community.general.scaleway
options:
server_id:
Tidy up validate-modules ignores for cloud/scaleway modules (#1268) * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_compute.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_lb.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_rule.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_sshkey.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_user_data.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume.py * Enabling validation-modules for cloud/scaleway modules * Reverted invalid-documentation validations in 2.9
2020-11-12 08:26:54 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Scaleway Compute instance ID of the server
required: true
user_data:
Tidy up validate-modules ignores for cloud/scaleway modules (#1268) * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_compute.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_lb.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_rule.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_sshkey.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_user_data.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume.py * Enabling validation-modules for cloud/scaleway modules * Reverted invalid-documentation validations in 2.9
2020-11-12 08:26:54 +01:00
type: dict
2020-03-09 10:11:07 +01:00
description:
2022-06-22 22:43:48 +02:00
- User defined data. Typically used with C(cloud-init).
2020-03-09 10:11:07 +01:00
- Pass your cloud-init script here as a string
required: false
region:
Tidy up validate-modules ignores for cloud/scaleway modules (#1268) * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_compute.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_lb.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_rule.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_sshkey.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_user_data.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume.py * Enabling validation-modules for cloud/scaleway modules * Reverted invalid-documentation validations in 2.9
2020-11-12 08:26:54 +01:00
type: str
2020-03-09 10:11:07 +01:00
description:
- Scaleway compute zone
required: true
choices:
- ams1
- EMEA-NL-EVS
- par1
- EMEA-FR-PAR1
2021-01-28 12:51:07 +01:00
- par2
- EMEA-FR-PAR2
- waw1
- EMEA-PL-WAW1
2020-03-09 10:11:07 +01:00
'''
EXAMPLES = '''
- name: Update the cloud-init
community.general.scaleway_user_data:
2020-03-09 10:11:07 +01:00
server_id: '5a33b4ab-57dd-4eb6-8b0a-d95eb63492ce'
region: ams1
user_data:
cloud-init: 'final_message: "Hello World!"'
'''
RETURN = '''
'''
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.scaleway import SCALEWAY_LOCATION, scaleway_argument_spec, Scaleway
def patch_user_data(compute_api, server_id, key, value):
compute_api.module.debug("Starting patching user_data attributes")
path = "servers/%s/user_data/%s" % (server_id, key)
response = compute_api.patch(path=path, data=value, headers={"Content-Type": "text/plain"})
2020-03-09 10:11:07 +01:00
if not response.ok:
msg = 'Error during user_data patching: %s %s' % (response.status_code, response.body)
compute_api.module.fail_json(msg=msg)
return response
def delete_user_data(compute_api, server_id, key):
compute_api.module.debug("Starting deleting user_data attributes: %s" % key)
response = compute_api.delete(path="servers/%s/user_data/%s" % (server_id, key))
if not response.ok:
msg = 'Error during user_data deleting: (%s) %s' % response.status_code, response.body
compute_api.module.fail_json(msg=msg)
return response
def get_user_data(compute_api, server_id, key):
compute_api.module.debug("Starting patching user_data attributes")
path = "servers/%s/user_data/%s" % (server_id, key)
response = compute_api.get(path=path)
if not response.ok:
msg = 'Error during user_data patching: %s %s' % (response.status_code, response.body)
compute_api.module.fail_json(msg=msg)
return response.json
def core(module):
region = module.params["region"]
server_id = module.params["server_id"]
user_data = module.params["user_data"]
changed = False
module.params['api_url'] = SCALEWAY_LOCATION[region]["api_endpoint"]
compute_api = Scaleway(module=module)
user_data_list = compute_api.get(path="servers/%s/user_data" % server_id)
if not user_data_list.ok:
msg = 'Error during user_data fetching: %s %s' % user_data_list.status_code, user_data_list.body
compute_api.module.fail_json(msg=msg)
present_user_data_keys = user_data_list.json["user_data"]
present_user_data = dict(
(key, get_user_data(compute_api=compute_api, server_id=server_id, key=key))
for key in present_user_data_keys
)
if present_user_data == user_data:
module.exit_json(changed=changed, msg=user_data_list.json)
# First we remove keys that are not defined in the wished user_data
for key in present_user_data:
if key not in user_data:
changed = True
if compute_api.module.check_mode:
module.exit_json(changed=changed, msg={"status": "User-data of %s would be patched." % server_id})
delete_user_data(compute_api=compute_api, server_id=server_id, key=key)
# Then we patch keys that are different
for key, value in user_data.items():
if key not in present_user_data or user_data[key] != present_user_data[key]:
changed = True
if compute_api.module.check_mode:
module.exit_json(changed=changed, msg={"status": "User-data of %s would be patched." % server_id})
patch_user_data(compute_api=compute_api, server_id=server_id, key=key, value=value)
module.exit_json(changed=changed, msg=user_data)
def main():
argument_spec = scaleway_argument_spec()
argument_spec.update(dict(
Tidy up validate-modules ignores for cloud/scaleway modules (#1268) * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_compute.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_image_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_ip.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_lb.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_security_group_rule.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_server_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_snapshot_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_sshkey.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_user_data.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_facts.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume_info.py * fixed validation-modules for plugins/modules/cloud/scaleway/scaleway_volume.py * Enabling validation-modules for cloud/scaleway modules * Reverted invalid-documentation validations in 2.9
2020-11-12 08:26:54 +01:00
region=dict(required=True, choices=list(SCALEWAY_LOCATION.keys())),
2020-03-09 10:11:07 +01:00
user_data=dict(type="dict"),
server_id=dict(required=True),
))
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
)
core(module)
if __name__ == '__main__':
main()