53affc3220
Collections are new. openstacksdk as of now doesn't support python2. We shouldn't pretend to support python2 either. If you're using ansible new enough to use collections, you can use python3. This release of openstacksdk only supports 3.6 and onwards, so set that as our min. Change-Id: I34d544ce48f25bffde8e6e0cf82cdf9a85e681c3
258 lines
7.9 KiB
Python
258 lines
7.9 KiB
Python
#!/usr/bin/python
|
|
|
|
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: os_volume
|
|
short_description: Create/Delete Cinder Volumes
|
|
author: "Monty Taylor (@emonty)"
|
|
description:
|
|
- Create or Remove cinder block storage volumes
|
|
options:
|
|
size:
|
|
description:
|
|
- Size of volume in GB. This parameter is required when the
|
|
I(state) parameter is 'present'.
|
|
display_name:
|
|
description:
|
|
- Name of volume
|
|
required: true
|
|
display_description:
|
|
description:
|
|
- String describing the volume
|
|
volume_type:
|
|
description:
|
|
- Volume type for volume
|
|
image:
|
|
description:
|
|
- Image name or id for boot from volume
|
|
snapshot_id:
|
|
description:
|
|
- Volume snapshot id to create from
|
|
volume:
|
|
description:
|
|
- Volume name or id to create from
|
|
bootable:
|
|
description:
|
|
- Bootable flag for volume.
|
|
type: bool
|
|
default: False
|
|
state:
|
|
description:
|
|
- Should the resource be present or absent.
|
|
choices: [present, absent]
|
|
default: present
|
|
availability_zone:
|
|
description:
|
|
- Ignored. Present for backwards compatibility
|
|
scheduler_hints:
|
|
description:
|
|
- Scheduler hints passed to volume API in form of dict
|
|
metadata:
|
|
description:
|
|
- Metadata for the volume
|
|
requirements:
|
|
- "python >= 3.6""
|
|
- "openstacksdk"
|
|
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Creates a new volume
|
|
- name: create a volume
|
|
hosts: localhost
|
|
tasks:
|
|
- name: create 40g test volume
|
|
os_volume:
|
|
state: present
|
|
cloud: mordred
|
|
availability_zone: az2
|
|
size: 40
|
|
display_name: test_volume
|
|
scheduler_hints:
|
|
same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0
|
|
'''
|
|
|
|
RETURNS = '''
|
|
id:
|
|
description: Cinder's unique ID for this volume
|
|
returned: always
|
|
type: str
|
|
sample: fcc4ac1c-e249-4fe7-b458-2138bfb44c06
|
|
|
|
volume:
|
|
description: Cinder's representation of the volume object
|
|
returned: always
|
|
type: dict
|
|
sample: {'...'}
|
|
'''
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import (openstack_full_argument_spec,
|
|
openstack_module_kwargs,
|
|
openstack_cloud_from_module)
|
|
|
|
|
|
def _needs_update(module, volume):
|
|
'''
|
|
check for differences in updatable values, at the moment
|
|
openstacksdk only supports extending the volume size, this
|
|
may change in the future.
|
|
:returns: bool
|
|
'''
|
|
compare_simple = ['size']
|
|
|
|
for k in compare_simple:
|
|
if module.params[k] is not None and module.params[k] != volume.get(k):
|
|
return True
|
|
|
|
return False
|
|
|
|
|
|
def _modify_volume(module, cloud):
|
|
'''
|
|
modify volume, the only modification to an existing volume
|
|
available at the moment is extending the size, this is
|
|
limited by the openstacksdk and may change whenever the
|
|
functionality is extended.
|
|
'''
|
|
volume = cloud.get_volume(module.params['display_name'])
|
|
diff = {'before': volume, 'after': ''}
|
|
size = module.params['size']
|
|
|
|
if size < volume.get('size'):
|
|
module.fail_json(
|
|
msg='Cannot shrink volumes, size: {0} < {1}'.format(size, volume.get('size'))
|
|
)
|
|
|
|
if not _needs_update(module, volume):
|
|
diff['after'] = volume
|
|
module.exit_json(changed=False, id=volume['id'], volume=volume, diff=diff)
|
|
|
|
if module.check_mode:
|
|
diff['after'] = volume
|
|
module.exit_json(changed=True, id=volume['id'], volume=volume, diff=diff)
|
|
|
|
cloud.volume.extend_volume(
|
|
volume.id,
|
|
size
|
|
)
|
|
diff['after'] = cloud.get_volume(module.params['display_name'])
|
|
module.exit_json(changed=True, id=volume['id'], volume=volume, diff=diff)
|
|
|
|
|
|
def _present_volume(module, cloud):
|
|
if cloud.volume_exists(module.params['display_name']):
|
|
v = cloud.get_volume(module.params['display_name'])
|
|
if not _needs_update(module, v):
|
|
module.exit_json(changed=False, id=v['id'], volume=v)
|
|
_modify_volume(module, cloud)
|
|
|
|
diff = {'before': '', 'after': ''}
|
|
|
|
volume_args = dict(
|
|
size=module.params['size'],
|
|
volume_type=module.params['volume_type'],
|
|
display_name=module.params['display_name'],
|
|
display_description=module.params['display_description'],
|
|
snapshot_id=module.params['snapshot_id'],
|
|
bootable=module.params['bootable'],
|
|
availability_zone=module.params['availability_zone'],
|
|
)
|
|
if module.params['image']:
|
|
image_id = cloud.get_image_id(module.params['image'])
|
|
volume_args['imageRef'] = image_id
|
|
|
|
if module.params['volume']:
|
|
volume_id = cloud.get_volume_id(module.params['volume'])
|
|
if not volume_id:
|
|
module.fail_json(msg="Failed to find volume '%s'" % module.params['volume'])
|
|
volume_args['source_volid'] = volume_id
|
|
|
|
if module.params['scheduler_hints']:
|
|
volume_args['scheduler_hints'] = module.params['scheduler_hints']
|
|
|
|
if module.params['metadata']:
|
|
volume_args['metadata'] = module.params['metadata']
|
|
|
|
if module.check_mode:
|
|
diff['after'] = volume_args
|
|
module.exit_json(changed=True, id=None, volume=volume_args, diff=diff)
|
|
|
|
volume = cloud.create_volume(
|
|
wait=module.params['wait'], timeout=module.params['timeout'],
|
|
**volume_args)
|
|
diff['after'] = volume
|
|
module.exit_json(changed=True, id=volume['id'], volume=volume, diff=diff)
|
|
|
|
|
|
def _absent_volume(module, cloud, sdk):
|
|
changed = False
|
|
diff = {'before': '', 'after': ''}
|
|
|
|
if cloud.volume_exists(module.params['display_name']):
|
|
volume = cloud.get_volume(module.params['display_name'])
|
|
diff['before'] = volume
|
|
|
|
if module.check_mode:
|
|
module.exit_json(changed=True, diff=diff)
|
|
|
|
try:
|
|
changed = cloud.delete_volume(name_or_id=module.params['display_name'],
|
|
wait=module.params['wait'],
|
|
timeout=module.params['timeout'])
|
|
except sdk.exceptions.ResourceTimeout:
|
|
diff['after'] = volume
|
|
module.exit_json(changed=changed, diff=diff)
|
|
|
|
module.exit_json(changed=changed, diff=diff)
|
|
|
|
|
|
def main():
|
|
argument_spec = openstack_full_argument_spec(
|
|
size=dict(default=None, type='int'),
|
|
volume_type=dict(default=None),
|
|
display_name=dict(required=True, aliases=['name']),
|
|
display_description=dict(default=None, aliases=['description']),
|
|
image=dict(default=None),
|
|
snapshot_id=dict(default=None),
|
|
volume=dict(default=None),
|
|
state=dict(default='present', choices=['absent', 'present']),
|
|
scheduler_hints=dict(default=None, type='dict'),
|
|
metadata=dict(default=None, type='dict'),
|
|
bootable=dict(type='bool', default=False)
|
|
)
|
|
module_kwargs = openstack_module_kwargs(
|
|
mutually_exclusive=[
|
|
['image', 'snapshot_id', 'volume'],
|
|
],
|
|
)
|
|
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True, **module_kwargs)
|
|
|
|
state = module.params['state']
|
|
|
|
if state == 'present' and not module.params['size']:
|
|
module.fail_json(msg="Size is required when state is 'present'")
|
|
|
|
sdk, cloud = openstack_cloud_from_module(module)
|
|
try:
|
|
if state == 'present':
|
|
_present_volume(module, cloud)
|
|
if state == 'absent':
|
|
_absent_volume(module, cloud, sdk)
|
|
except sdk.exceptions.OpenStackCloudException as e:
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|