mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
0f893027c4
Start using this to construct shade OpenStack Cloud objects in a consistent manner. This will let us centralize things like dealing with password arguments and whatnot. It also allows us to introduce the ability to pass a fully formed config dict directly to the module. Migrate all OpenStack modules to use openstack_cloud_from_module. Have it return the shade library since it's responsible for importing shade and shade is needed for the exceptions. Only pull specific OpenStack arguments for the constructor Rather than passing **module.params to the shade constructor, pull out only the values that make sense. This should prevent the issues with module parameters stepping on shade parameters. Replace module.params.pop with module.params.get We don't need to pop these anymore since the shade constructor is now using opt-in values. Using real urls is ungood. Use example.com domains. Also, get rid of the antiquated port numbers.
146 lines
4.2 KiB
Python
146 lines
4.2 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8 -*-
|
|
|
|
# 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)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: os_server_volume
|
|
short_description: Attach/Detach Volumes from OpenStack VM's
|
|
extends_documentation_fragment: openstack
|
|
version_added: "2.0"
|
|
author: "Monty Taylor (@emonty)"
|
|
description:
|
|
- Attach or Detach volumes from OpenStack VM's
|
|
options:
|
|
state:
|
|
description:
|
|
- Should the resource be present or absent.
|
|
choices: [present, absent]
|
|
default: present
|
|
required: false
|
|
server:
|
|
description:
|
|
- Name or ID of server you want to attach a volume to
|
|
required: true
|
|
volume:
|
|
description:
|
|
- Name or id of volume you want to attach to a server
|
|
required: true
|
|
device:
|
|
description:
|
|
- Device you want to attach. Defaults to auto finding a device name.
|
|
required: false
|
|
default: None
|
|
availability_zone:
|
|
description:
|
|
- Ignored. Present for backwards compatibility
|
|
required: false
|
|
requirements:
|
|
- "python >= 2.6"
|
|
- "shade"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Attaches a volume to a compute host
|
|
- name: attach a volume
|
|
hosts: localhost
|
|
tasks:
|
|
- name: attach volume to host
|
|
os_server_volume:
|
|
state: present
|
|
cloud: mordred
|
|
server: Mysql-server
|
|
volume: mysql-data
|
|
device: /dev/vdb
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.openstack import openstack_full_argument_spec, openstack_module_kwargs, openstack_cloud_from_module
|
|
|
|
|
|
def _system_state_change(state, device):
|
|
"""Check if system state would change."""
|
|
if state == 'present':
|
|
if device:
|
|
return False
|
|
return True
|
|
if state == 'absent':
|
|
if device:
|
|
return True
|
|
return False
|
|
return False
|
|
|
|
|
|
def main():
|
|
argument_spec = openstack_full_argument_spec(
|
|
server=dict(required=True),
|
|
volume=dict(required=True),
|
|
device=dict(default=None), # None == auto choose device name
|
|
state=dict(default='present', choices=['absent', 'present']),
|
|
)
|
|
|
|
module_kwargs = openstack_module_kwargs()
|
|
module = AnsibleModule(argument_spec,
|
|
supports_check_mode=True,
|
|
**module_kwargs)
|
|
|
|
state = module.params['state']
|
|
wait = module.params['wait']
|
|
timeout = module.params['timeout']
|
|
|
|
shade, cloud = openstack_cloud_from_module(module)
|
|
try:
|
|
server = cloud.get_server(module.params['server'])
|
|
volume = cloud.get_volume(module.params['volume'])
|
|
dev = cloud.get_volume_attach_device(volume, server.id)
|
|
|
|
if module.check_mode:
|
|
module.exit_json(changed=_system_state_change(state, dev))
|
|
|
|
if state == 'present':
|
|
if dev:
|
|
# Volume is already attached to this server
|
|
module.exit_json(changed=False)
|
|
|
|
cloud.attach_volume(server, volume, module.params['device'],
|
|
wait=wait, timeout=timeout)
|
|
|
|
server = cloud.get_server(module.params['server']) # refresh
|
|
volume = cloud.get_volume(module.params['volume']) # refresh
|
|
hostvars = cloud.get_openstack_vars(server)
|
|
|
|
module.exit_json(
|
|
changed=True,
|
|
id=volume['id'],
|
|
attachments=volume['attachments'],
|
|
openstack=hostvars
|
|
)
|
|
|
|
elif state == 'absent':
|
|
if not dev:
|
|
# Volume is not attached to this server
|
|
module.exit_json(changed=False)
|
|
|
|
cloud.detach_volume(server, volume, wait=wait, timeout=timeout)
|
|
module.exit_json(
|
|
changed=True,
|
|
result='Detached volume from server'
|
|
)
|
|
|
|
except (shade.OpenStackCloudException, shade.OpenStackCloudTimeout) as e:
|
|
module.fail_json(msg=str(e))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|