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)
228 lines
7.1 KiB
Python
228 lines
7.1 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_attachments
|
|
short_description: Manipulate Rackspace Cloud Block Storage Volume Attachments
|
|
description:
|
|
- Manipulate Rackspace Cloud Block Storage Volume Attachments
|
|
- 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:
|
|
device:
|
|
type: str
|
|
description:
|
|
- The device path to attach the volume to, e.g. /dev/xvde.
|
|
- Before 2.4 this was a required field. Now it can be left to null to auto assign the device name.
|
|
volume:
|
|
type: str
|
|
description:
|
|
- Name or id of the volume to attach/detach
|
|
required: true
|
|
server:
|
|
type: str
|
|
description:
|
|
- Name or id of the server to attach/detach
|
|
required: true
|
|
state:
|
|
type: str
|
|
description:
|
|
- Indicate desired state of the resource
|
|
choices:
|
|
- present
|
|
- absent
|
|
default: present
|
|
wait:
|
|
description:
|
|
- wait for the volume to be in 'in-use'/'available' state 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: Attach a Block Storage Volume
|
|
gather_facts: false
|
|
hosts: local
|
|
connection: local
|
|
tasks:
|
|
- name: Storage volume attach request
|
|
local_action:
|
|
module: rax_cbs_attachments
|
|
credentials: ~/.raxpub
|
|
volume: my-volume
|
|
server: my-server
|
|
device: /dev/xvdd
|
|
region: DFW
|
|
wait: true
|
|
state: present
|
|
register: my_volume
|
|
'''
|
|
|
|
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 (NON_CALLABLES,
|
|
rax_argument_spec,
|
|
rax_find_server,
|
|
rax_find_volume,
|
|
rax_required_together,
|
|
rax_to_dict,
|
|
setup_rax_module,
|
|
)
|
|
|
|
|
|
def cloud_block_storage_attachments(module, state, volume, server, device,
|
|
wait, wait_timeout):
|
|
cbs = pyrax.cloud_blockstorage
|
|
cs = pyrax.cloudservers
|
|
|
|
if cbs is None or cs is None:
|
|
module.fail_json(msg='Failed to instantiate client. This '
|
|
'typically indicates an invalid region or an '
|
|
'incorrectly capitalized region name.')
|
|
|
|
changed = False
|
|
instance = {}
|
|
|
|
volume = rax_find_volume(module, pyrax, volume)
|
|
|
|
if not volume:
|
|
module.fail_json(msg='No matching storage volumes were found')
|
|
|
|
if state == 'present':
|
|
server = rax_find_server(module, pyrax, server)
|
|
|
|
if (volume.attachments and
|
|
volume.attachments[0]['server_id'] == server.id):
|
|
changed = False
|
|
elif volume.attachments:
|
|
module.fail_json(msg='Volume is attached to another server')
|
|
else:
|
|
try:
|
|
volume.attach_to_instance(server, mountpoint=device)
|
|
changed = True
|
|
except Exception as e:
|
|
module.fail_json(msg='%s' % e.message)
|
|
|
|
volume.get()
|
|
|
|
for key, value in vars(volume).items():
|
|
if (isinstance(value, NON_CALLABLES) and
|
|
not key.startswith('_')):
|
|
instance[key] = value
|
|
|
|
result = dict(changed=changed)
|
|
|
|
if volume.status == 'error':
|
|
result['msg'] = '%s failed to build' % volume.id
|
|
elif wait:
|
|
attempts = wait_timeout // 5
|
|
pyrax.utils.wait_until(volume, 'status', 'in-use',
|
|
interval=5, attempts=attempts)
|
|
|
|
volume.get()
|
|
result['volume'] = rax_to_dict(volume)
|
|
|
|
if 'msg' in result:
|
|
module.fail_json(**result)
|
|
else:
|
|
module.exit_json(**result)
|
|
|
|
elif state == 'absent':
|
|
server = rax_find_server(module, pyrax, server)
|
|
|
|
if (volume.attachments and
|
|
volume.attachments[0]['server_id'] == server.id):
|
|
try:
|
|
volume.detach()
|
|
if wait:
|
|
pyrax.utils.wait_until(volume, 'status', 'available',
|
|
interval=3, attempts=0,
|
|
verbose=False)
|
|
changed = True
|
|
except Exception as e:
|
|
module.fail_json(msg='%s' % e.message)
|
|
|
|
volume.get()
|
|
changed = True
|
|
elif volume.attachments:
|
|
module.fail_json(msg='Volume is attached to another server')
|
|
|
|
result = dict(changed=changed, volume=rax_to_dict(volume))
|
|
|
|
if volume.status == 'error':
|
|
result['msg'] = '%s failed to build' % volume.id
|
|
|
|
if 'msg' in result:
|
|
module.fail_json(**result)
|
|
else:
|
|
module.exit_json(**result)
|
|
|
|
module.exit_json(changed=changed, volume=instance)
|
|
|
|
|
|
def main():
|
|
argument_spec = rax_argument_spec()
|
|
argument_spec.update(
|
|
dict(
|
|
device=dict(required=False),
|
|
volume=dict(required=True),
|
|
server=dict(required=True),
|
|
state=dict(default='present', choices=['present', 'absent']),
|
|
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')
|
|
|
|
device = module.params.get('device')
|
|
volume = module.params.get('volume')
|
|
server = module.params.get('server')
|
|
state = module.params.get('state')
|
|
wait = module.params.get('wait')
|
|
wait_timeout = module.params.get('wait_timeout')
|
|
|
|
setup_rax_module(module, pyrax)
|
|
|
|
cloud_block_storage_attachments(module, state, volume, server, device,
|
|
wait, wait_timeout)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|