From ebeb46aa618d49ad7bb20115819925970a8f2352 Mon Sep 17 00:00:00 2001 From: Henryk Konsek Date: Thu, 12 Jul 2018 15:43:23 +0200 Subject: [PATCH] Added Scaleway volume module (#41667) * Added Scaleway volume module. * Fixed imports order. * Fixed version added. * Improved sanity checks. * Fixing style formatting. * Added new line at the end of file. Fixed typo in comment. --- .../modules/cloud/scaleway/scaleway_volume.py | 190 ++++++++++++++++++ test/legacy/scaleway_volume.yml | 53 +++++ 2 files changed, 243 insertions(+) create mode 100644 lib/ansible/modules/cloud/scaleway/scaleway_volume.py create mode 100644 test/legacy/scaleway_volume.yml diff --git a/lib/ansible/modules/cloud/scaleway/scaleway_volume.py b/lib/ansible/modules/cloud/scaleway/scaleway_volume.py new file mode 100644 index 0000000000..7c3aba06c9 --- /dev/null +++ b/lib/ansible/modules/cloud/scaleway/scaleway_volume.py @@ -0,0 +1,190 @@ +#!/usr/bin/python +# +# Scaleway volumes management module +# +# Copyright (C) 2018 Henryk Konsek Consulting (hekonsek@gmail.com). +# +# 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: scaleway_volume +short_description: Scaleway volumes management module +version_added: "2.7" +author: Henryk Konsek (@hekonsek) +description: + - This module manages volumes on Scaleway account + U(https://developer.scaleway.com) + +options: + state: + description: + - Indicate desired state of the volume. + required: true + choices: + - present + - absent + oauth_token: + description: + - Scaleway OAuth token. + required: true + region: + description: + - Scaleway region to use (for example par1). + required: true + choices: + - ams1 + - EMEA-NL-EVS + - par1 + - EMEA-FR-PAR1 + name: + description: + - Name used to identify the volume. + required: true + organization: + description: + - ScaleWay organization ID to which volume belongs. + size: + description: + - Size of the volume in bytes. + volume_type: + description: + - Type of the volume (for example 'l_ssd'). + timeout: + description: + - Timeout for API calls + default: 30 +''' + +EXAMPLES = ''' + - name: Create 10GB volume + scaleway_volume: + name: my-volume + state: present + region: par1 + organization: "{{ scw_org }}" + "size": 10000000000 + volume_type: l_ssd + register: server_creation_check_task + + - name: Make sure volume deleted + scaleway_volume: + name: my-volume + state: absent + region: par1 + +''' + +RETURN = ''' +data: + description: This is only present when C(state=present) + returned: when C(state=present) + type: dict + sample: { + "volume": { + "export_uri": null, + "id": "c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd", + "name": "volume-0-3", + "organization": "000a115d-2852-4b0a-9ce8-47f1134ba95a", + "server": null, + "size": 10000000000, + "volume_type": "l_ssd" + } +} +''' + +from ansible.module_utils.scaleway import ScalewayAPI, SCALEWAY_LOCATION +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.basic import env_fallback +from ansible.module_utils.scaleway import ScalewayAPI + + +def core(module): + api_token = module.params['oauth_token'] + region = module.params['region'] + state = module.params['state'] + name = module.params['name'] + organization = module.params['organization'] + size = module.params['size'] + volume_type = module.params['volume_type'] + + account_api = ScalewayAPI(module, + headers={'X-Auth-Token': api_token}, + base_url=SCALEWAY_LOCATION[region]['api_endpoint']) + response = account_api.get('volumes') + status_code = response.status_code + volumes_json = response.json + + if not response.ok: + module.fail_json(msg='Error getting volume [{0}: {1}]'.format( + status_code, response.json['message'])) + + volumeByName = None + for volume in volumes_json['volumes']: + if volume['organization'] == organization and volume['name'] == name: + volumeByName = volume + + if state in ('present',): + if volumeByName is not None: + module.exit_json(changed=False) + + payload = {'name': name, 'organization': organization, 'size': size, 'volume_type': volume_type} + + response = account_api.post('/volumes', payload) + + if response.ok: + module.exit_json(changed=True, data=response.json) + + module.fail_json(msg='Error creating volume [{0}: {1}]'.format( + response.status_code, response.json)) + + elif state in ('absent',): + if volumeByName is None: + module.exit_json(changed=False) + + if module.check_mode: + module.exit_json(changed=True) + + response = account_api.delete('/volumes/' + volumeByName['id']) + if response.status_code == 204: + module.exit_json(changed=True, data=response.json) + + module.fail_json(msg='Error deleting volume [{0}: {1}]'.format( + response.status_code, response.json)) + + +def main(): + module = AnsibleModule( + argument_spec=dict( + region=dict(required=True, choices=SCALEWAY_LOCATION.keys()), + oauth_token=dict( + no_log=True, + # Support environment variable for Scaleway OAuth Token + fallback=(env_fallback, ['SCW_TOKEN', 'SCW_API_KEY', 'SCW_OAUTH_TOKEN']), + required=True, + ), + state=dict(choices=['present', 'absent'], required=True), + name=dict(required=True), + size=dict(type='int'), + organization=dict(), + volume_type=dict(), + timeout=dict(type='int', default=30), + ), + supports_check_mode=True, + ) + + core(module) + + +if __name__ == '__main__': + main() diff --git a/test/legacy/scaleway_volume.yml b/test/legacy/scaleway_volume.yml new file mode 100644 index 0000000000..5ef999027c --- /dev/null +++ b/test/legacy/scaleway_volume.yml @@ -0,0 +1,53 @@ +# SCW_API_KEY='XXX' SCW_ORG='YYY' ansible-playbook ./test/legacy/scaleway_volume.yml + +- name: Test compute instance lifecyle on a Scaleway account + hosts: localhost + gather_facts: no + environment: + SCW_API_KEY: "{{ lookup('env', 'SCW_API_KEY') }}" + vars: + scw_org: "{{ lookup('env', 'SCW_ORG') }}" + + tasks: + + - name: Make sure volume is not there before tests + scaleway_volume: + name: ansible-test-volume + state: absent + region: par1 + organization: "{{ scw_org }}" + register: server_creation_check_task + + - assert: + that: + - server_creation_check_task is success + + - name: Create volume + scaleway_volume: + name: ansible-test-volume + state: present + region: par1 + organization: "{{ scw_org }}" + "size": 10000000000 + volume_type: l_ssd + register: server_creation_check_task + + - debug: var=server_creation_check_task + + - assert: + that: + - server_creation_check_task is success + - server_creation_check_task is changed + + - name: Make sure volume is deleted + scaleway_volume: + name: ansible-test-volume + state: absent + region: par1 + organization: "{{ scw_org }}" + register: server_creation_check_task + + - assert: + that: + - server_creation_check_task is success + - server_creation_check_task is changed