mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
5589bcb659
Add attributes to oneandone, ovh, and rackspace modules (#5948)
Add attributes to oneandone, ovh, and rackspace modules.
(cherry picked from commit 6bd131f2fb)
237 lines
7 KiB
Python
237 lines
7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright Ansible Project
|
|
# 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
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: rax_cbs
|
|
short_description: Manipulate Rackspace Cloud Block Storage Volumes
|
|
description:
|
|
- Manipulate Rackspace Cloud Block Storage Volumes
|
|
- This module relies on the C(pyrax) package which is deprecated in favour of using Openstack API.
|
|
- Unless maintainers step up to work on the module, it will be marked as deprecated in community.general 7.0.0 and removed in version 9.0.0.
|
|
attributes:
|
|
check_mode:
|
|
support: none
|
|
diff_mode:
|
|
support: none
|
|
options:
|
|
description:
|
|
type: str
|
|
description:
|
|
- Description to give the volume being created.
|
|
image:
|
|
type: str
|
|
description:
|
|
- Image to use for bootable volumes. Can be an C(id), C(human_id) or
|
|
C(name). This option requires C(pyrax>=1.9.3).
|
|
meta:
|
|
type: dict
|
|
default: {}
|
|
description:
|
|
- A hash of metadata to associate with the volume.
|
|
name:
|
|
type: str
|
|
description:
|
|
- Name to give the volume being created.
|
|
required: true
|
|
size:
|
|
type: int
|
|
description:
|
|
- Size of the volume to create in Gigabytes.
|
|
default: 100
|
|
snapshot_id:
|
|
type: str
|
|
description:
|
|
- The id of the snapshot to create the volume from.
|
|
state:
|
|
type: str
|
|
description:
|
|
- Indicate desired state of the resource.
|
|
choices:
|
|
- present
|
|
- absent
|
|
default: present
|
|
volume_type:
|
|
type: str
|
|
description:
|
|
- Type of the volume being created.
|
|
choices:
|
|
- SATA
|
|
- SSD
|
|
default: SATA
|
|
wait:
|
|
description:
|
|
- Wait for the volume to be in state C(available) before returning.
|
|
type: bool
|
|
default: false
|
|
wait_timeout:
|
|
type: int
|
|
description:
|
|
- how long before wait gives up, in seconds.
|
|
default: 300
|
|
author:
|
|
- "Christopher H. Laco (@claco)"
|
|
- "Matt Martz (@sivel)"
|
|
extends_documentation_fragment:
|
|
- community.general.rackspace.openstack
|
|
- community.general.attributes
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Build a Block Storage Volume
|
|
gather_facts: false
|
|
hosts: local
|
|
connection: local
|
|
tasks:
|
|
- name: Storage volume create request
|
|
local_action:
|
|
module: rax_cbs
|
|
credentials: ~/.raxpub
|
|
name: my-volume
|
|
description: My Volume
|
|
volume_type: SSD
|
|
size: 150
|
|
region: DFW
|
|
wait: true
|
|
state: present
|
|
meta:
|
|
app: my-cool-app
|
|
register: my_volume
|
|
'''
|
|
|
|
from ansible_collections.community.general.plugins.module_utils.version import LooseVersion
|
|
|
|
try:
|
|
import pyrax
|
|
HAS_PYRAX = True
|
|
except ImportError:
|
|
HAS_PYRAX = False
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.community.general.plugins.module_utils.rax import (VOLUME_STATUS, rax_argument_spec, rax_find_image, rax_find_volume,
|
|
rax_required_together, rax_to_dict, setup_rax_module)
|
|
|
|
|
|
def cloud_block_storage(module, state, name, description, meta, size,
|
|
snapshot_id, volume_type, wait, wait_timeout,
|
|
image):
|
|
changed = False
|
|
volume = None
|
|
instance = {}
|
|
|
|
cbs = pyrax.cloud_blockstorage
|
|
|
|
if cbs is None:
|
|
module.fail_json(msg='Failed to instantiate client. This '
|
|
'typically indicates an invalid region or an '
|
|
'incorrectly capitalized region name.')
|
|
|
|
if image:
|
|
# pyrax<1.9.3 did not have support for specifying an image when
|
|
# creating a volume which is required for bootable volumes
|
|
if LooseVersion(pyrax.version.version) < LooseVersion('1.9.3'):
|
|
module.fail_json(msg='Creating a bootable volume requires '
|
|
'pyrax>=1.9.3')
|
|
image = rax_find_image(module, pyrax, image)
|
|
|
|
volume = rax_find_volume(module, pyrax, name)
|
|
|
|
if state == 'present':
|
|
if not volume:
|
|
kwargs = dict()
|
|
if image:
|
|
kwargs['image'] = image
|
|
try:
|
|
volume = cbs.create(name, size=size, volume_type=volume_type,
|
|
description=description,
|
|
metadata=meta,
|
|
snapshot_id=snapshot_id, **kwargs)
|
|
changed = True
|
|
except Exception as e:
|
|
module.fail_json(msg='%s' % e.message)
|
|
else:
|
|
if wait:
|
|
attempts = wait_timeout // 5
|
|
pyrax.utils.wait_for_build(volume, interval=5,
|
|
attempts=attempts)
|
|
|
|
volume.get()
|
|
instance = rax_to_dict(volume)
|
|
|
|
result = dict(changed=changed, volume=instance)
|
|
|
|
if volume.status == 'error':
|
|
result['msg'] = '%s failed to build' % volume.id
|
|
elif wait and volume.status not in VOLUME_STATUS:
|
|
result['msg'] = 'Timeout waiting on %s' % volume.id
|
|
|
|
if 'msg' in result:
|
|
module.fail_json(**result)
|
|
else:
|
|
module.exit_json(**result)
|
|
|
|
elif state == 'absent':
|
|
if volume:
|
|
instance = rax_to_dict(volume)
|
|
try:
|
|
volume.delete()
|
|
changed = True
|
|
except Exception as e:
|
|
module.fail_json(msg='%s' % e.message)
|
|
|
|
module.exit_json(changed=changed, volume=instance)
|
|
|
|
|
|
def main():
|
|
argument_spec = rax_argument_spec()
|
|
argument_spec.update(
|
|
dict(
|
|
description=dict(type='str'),
|
|
image=dict(type='str'),
|
|
meta=dict(type='dict', default={}),
|
|
name=dict(required=True),
|
|
size=dict(type='int', default=100),
|
|
snapshot_id=dict(),
|
|
state=dict(default='present', choices=['present', 'absent']),
|
|
volume_type=dict(choices=['SSD', 'SATA'], default='SATA'),
|
|
wait=dict(type='bool', default=False),
|
|
wait_timeout=dict(type='int', default=300)
|
|
)
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
required_together=rax_required_together()
|
|
)
|
|
|
|
if not HAS_PYRAX:
|
|
module.fail_json(msg='pyrax is required for this module')
|
|
|
|
description = module.params.get('description')
|
|
image = module.params.get('image')
|
|
meta = module.params.get('meta')
|
|
name = module.params.get('name')
|
|
size = module.params.get('size')
|
|
snapshot_id = module.params.get('snapshot_id')
|
|
state = module.params.get('state')
|
|
volume_type = module.params.get('volume_type')
|
|
wait = module.params.get('wait')
|
|
wait_timeout = module.params.get('wait_timeout')
|
|
|
|
setup_rax_module(module, pyrax)
|
|
|
|
cloud_block_storage(module, state, name, description, meta, size,
|
|
snapshot_id, volume_type, wait, wait_timeout,
|
|
image)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|