ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Implement recommendations from #4864

Browse source
This commit is contained in:
Matt Martz 2014-03-26 16:25:46 -05:00
parent 972a27b14e
commit bb86443528
2 changed files with 220 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

115
library/cloud/rax_cbs
View file

@ -1,4 +1,4 @@
#!/usr/bin/python -tt #!/usr/bin/python
# This file is part of Ansible # This file is part of Ansible
# #
# Ansible is free software: you can redistribute it and/or modify # Ansible is free software: you can redistribute it and/or modify
@ -20,17 +20,48 @@ module: rax_cbs
short_description: Manipulate Rackspace Cloud Block Storage Volumes short_description: Manipulate Rackspace Cloud Block Storage Volumes
description: description:
- Manipulate Rackspace Cloud Block Storage Volumes - Manipulate Rackspace Cloud Block Storage Volumes
version_added: "1.5" version_added: 1.6
options: options:
api_key: api_key:
description: description:
- Rackspace API key (overrides C(credentials)) - Rackspace API key (overrides I(credentials))
aliases:
- password
auth_endpoint:
description:
- The URI of the authentication service
default: https://identity.api.rackspacecloud.com/v2.0/
credentials: credentials:
description: description:
- File to find the Rackspace credentials in (ignored if C(api_key) and - File to find the Rackspace credentials in (ignored if I(api_key) and
C(username) are provided) I(username) are provided)
default: null default: null
aliases: ['creds_file'] aliases:
- creds_file
env:
description:
- Environment as configured in ~/.pyrax.cfg,
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
tenant_name:
description:
- The tenant name used for authentication
username:
description:
- Rackspace username (overrides I(credentials))
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints
description: description:
description: description:
- Description to give the volume being created - Description to give the volume being created
@ -44,10 +75,6 @@ options:
- Name to give the volume being created - Name to give the volume being created
default: null default: null
required: true required: true
region:
description:
- Region to create the volume in
default: DFW
size: size:
description: description:
- Size of the volume to create in Gigabytes - Size of the volume to create in Gigabytes
@ -60,28 +87,32 @@ options:
state: state:
description: description:
- Indicate desired state of the resource - Indicate desired state of the resource
choices: ['present', 'absent'] choices:
- present
- absent
default: present default: present
required: true required: true
volume_type: volume_type:
description: description:
- Type of the volume being created - Type of the volume being created
choices: ['SATA', 'SSD'] choices:
- SATA
- SSD
default: SATA default: SATA
required: true required: true
username:
description:
- Rackspace username (overrides C(credentials))
wait: wait:
description: description:
- wait for the volume to be in state 'available' before returning - wait for the volume to be in state 'available' before returning
default: "no" default: "no"
choices: [ "yes", "no" ] choices:
- "yes"
- "no"
wait_timeout: wait_timeout:
description: description:
- how long before wait gives up, in seconds - how long before wait gives up, in seconds
default: 300 default: 300
requirements: [ "pyrax" ] requirements:
- pyrax
author: Christopher H. Laco, Matt Martz author: Christopher H. Laco, Matt Martz
notes: notes:
- The following environment variables can be used, C(RAX_USERNAME), - The following environment variables can be used, C(RAX_USERNAME),
@ -116,13 +147,14 @@ EXAMPLES = '''
import sys import sys
from uuid import UUID
from types import NoneType from types import NoneType
try: try:
import pyrax import pyrax
HAS_PYRAX = True
except ImportError: except ImportError:
print("failed=True msg='pyrax required for this module'") HAS_PYRAX = False
sys.exit(1)
NON_CALLABLES = (basestring, bool, dict, int, list, NoneType) NON_CALLABLES = (basestring, bool, dict, int, list, NoneType)
VOLUME_STATUS = ('available', 'attaching', 'creating', 'deleting', 'in-use', VOLUME_STATUS = ('available', 'attaching', 'creating', 'deleting', 'in-use',
@ -133,29 +165,33 @@ def cloud_block_storage(module, state, name, description, meta, size,
snapshot_id, volume_type, wait, wait_timeout): snapshot_id, volume_type, wait, wait_timeout):
for arg in (state, name, size, volume_type): for arg in (state, name, size, volume_type):
if not arg: if not arg:
module.fail_json(msg='%s is required for rax_clb' % arg) module.fail_json(msg='%s is required for rax_cbs' % arg)
if int(size) < 100: if size < 100:
module.fail_json(msg='"size" must be greater than or equal to 100') module.fail_json(msg='"size" must be greater than or equal to 100')
changed = False changed = False
volumes = [] volume = None
instance = {} instance = {}
cbs = pyrax.cloud_blockstorage cbs = pyrax.cloud_blockstorage
for volume in cbs.list(): if cbs is None:
if name != volume.name and name != volume.id: module.fail_json(msg='Failed to instantiate client. This '
continue 'typically indicates an invalid region or an '
'incorrectly capitalized region name.')
volumes.append(volume) try:
UUID(name)
if len(volumes) > 1: volume = cbs.get(name)
module.fail_json(msg='Multiple Storage Volumes were matched by name, ' except ValueError:
'try using the Volume ID instead') try:
volume = cbs.find(name=name)
except Exception, e:
module.fail_json(msg='%s' % e)
if state == 'present': if state == 'present':
if not volumes: if not volume:
try: try:
volume = cbs.create(name, size=size, volume_type=volume_type, volume = cbs.create(name, size=size, volume_type=volume_type,
description=description, description=description,
@ -165,7 +201,10 @@ def cloud_block_storage(module, state, name, description, meta, size,
except Exception, e: except Exception, e:
module.fail_json(msg='%s' % e.message) module.fail_json(msg='%s' % e.message)
else: else:
volume = volumes[0] if wait:
attempts = wait_timeout / 5
pyrax.utils.wait_for_build(volume, interval=5,
attempts=attempts)
volume.get() volume.get()
for key, value in vars(volume).iteritems(): for key, value in vars(volume).iteritems():
@ -186,8 +225,7 @@ def cloud_block_storage(module, state, name, description, meta, size,
module.exit_json(**result) module.exit_json(**result)
elif state == 'absent': elif state == 'absent':
if volumes: if volume:
volume = volumes[0]
try: try:
volume.delete() volume.delete()
changed = True changed = True
@ -203,12 +241,12 @@ def main():
dict( dict(
description=dict(), description=dict(),
meta=dict(type='dict', default={}), meta=dict(type='dict', default={}),
name=dict(), name=dict(required=True),
size=dict(type='int', default=100), size=dict(type='int', default=100),
snapshot_id=dict(), snapshot_id=dict(),
state=dict(default='present', choices=['present', 'absent']), state=dict(default='present', choices=['present', 'absent']),
volume_type=dict(choices=['SSD', 'SATA'], default='SATA'), volume_type=dict(choices=['SSD', 'SATA'], default='SATA'),
wait=dict(type='bool'), wait=dict(type='bool', default=False),
wait_timeout=dict(type='int', default=300) wait_timeout=dict(type='int', default=300)
) )
) )
@ -218,6 +256,9 @@ def main():
required_together=rax_required_together() required_together=rax_required_together()
) )
if not HAS_PYRAX:
module.fail_json(msg='pyrax is required for this module')
description = module.params.get('description') description = module.params.get('description')
meta = module.params.get('meta') meta = module.params.get('meta')
name = module.params.get('name') name = module.params.get('name')
@ -226,7 +267,7 @@ def main():
state = module.params.get('state') state = module.params.get('state')
volume_type = module.params.get('volume_type') volume_type = module.params.get('volume_type')
wait = module.params.get('wait') wait = module.params.get('wait')
wait_timeout = int(module.params.get('wait_timeout')) wait_timeout = module.params.get('wait_timeout')
setup_rax_module(module, pyrax) setup_rax_module(module, pyrax)

175
library/cloud/rax_cbs_attachments
View file

@ -1,4 +1,4 @@
#!/usr/bin/python -tt #!/usr/bin/python
# This file is part of Ansible # This file is part of Ansible
# #
# Ansible is free software: you can redistribute it and/or modify # Ansible is free software: you can redistribute it and/or modify
@ -20,31 +20,58 @@ module: rax_cbs_attachments
short_description: Manipulate Rackspace Cloud Block Storage Volume Attachments short_description: Manipulate Rackspace Cloud Block Storage Volume Attachments
description: description:
- Manipulate Rackspace Cloud Block Storage Volume Attachments - Manipulate Rackspace Cloud Block Storage Volume Attachments
version_added: "1.5" version_added: 1.6
options: options:
api_key: api_key:
description: description:
- Rackspace API key (overrides C(credentials)) - Rackspace API key (overrides I(credentials))
aliases:
- password
auth_endpoint:
description:
- The URI of the authentication service
default: https://identity.api.rackspacecloud.com/v2.0/
credentials: credentials:
description: description:
- File to find the Rackspace credentials in (ignored if C(api_key) and - File to find the Rackspace credentials in (ignored if I(api_key) and
C(username) are provided) I(username) are provided)
default: null default: null
aliases: ['creds_file'] aliases:
mountpoint: - creds_file
env:
description: description:
- The mount point to attach the volume to - Environment as configured in ~/.pyrax.cfg,
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
tenant_name:
description:
- The tenant name used for authentication
username:
description:
- Rackspace username (overrides I(credentials))
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints
device:
description:
- The device path to attach the volume to, e.g. /dev/xvde
default: null default: null
required: true required: true
name: volume:
description: description:
- Name or id of the volume to attach/detach - Name or id of the volume to attach/detach
default: null default: null
required: true required: true
region:
description:
- Region the volume and server are located in
default: DFW
server: server:
description: description:
- Name or id of the server to attach/detach - Name or id of the server to attach/detach
@ -53,22 +80,24 @@ options:
state: state:
description: description:
- Indicate desired state of the resource - Indicate desired state of the resource
choices: ['present', 'absent'] choices:
- present
- absent
default: present default: present
required: true required: true
username:
description:
- Rackspace username (overrides C(credentials))
wait: wait:
description: description:
- wait for the volume to be in 'in-use'/'available' state before returning - wait for the volume to be in 'in-use'/'available' state before returning
default: "no" default: "no"
choices: [ "yes", "no" ] choices:
- "yes"
- "no"
wait_timeout: wait_timeout:
description: description:
- how long before wait gives up, in seconds - how long before wait gives up, in seconds
default: 300 default: 300
requirements: [ "pyrax" ] requirements:
- pyrax
author: Christopher H. Laco, Matt Martz author: Christopher H. Laco, Matt Martz
notes: notes:
- The following environment variables can be used, C(RAX_USERNAME), - The following environment variables can be used, C(RAX_USERNAME),
@ -89,9 +118,9 @@ EXAMPLES = '''
local_action: local_action:
module: rax_cbs_attachments module: rax_cbs_attachments
credentials: ~/.raxpub credentials: ~/.raxpub
name: my-volume volume: my-volume
server: my-server server: my-server
mountpoint: /dev/xvdd device: /dev/xvdd
region: DFW region: DFW
wait: yes wait: yes
state: present state: present
@ -100,57 +129,73 @@ EXAMPLES = '''
import sys import sys
from uuid import UUID
from types import NoneType from types import NoneType
try: try:
import pyrax import pyrax
HAS_PYRAX = True
except ImportError: except ImportError:
print("failed=True msg='pyrax required for this module'") HAS_PYRAX = False
sys.exit(1)
NON_CALLABLES = (basestring, bool, dict, int, list, NoneType) NON_CALLABLES = (basestring, bool, dict, int, list, NoneType)
VOLUME_STATUS = ('available', 'attaching', 'creating', 'deleting', 'in-use',
'error', 'error_deleting')
def cloud_block_storage_attachments(module, state, name, server, mountpoint, def cloud_block_storage_attachments(module, state, volume, server, device,
wait, wait_timeout): wait, wait_timeout):
for arg in (state, name, server, mountpoint): for arg in (state, volume, server, device):
if not arg: if not arg:
module.fail_json(msg='%s is required for rax_clb_attachments' % arg) module.fail_json(msg='%s is required for rax_cbs_attachments' %
arg)
cbs = pyrax.cloud_blockstorage cbs = pyrax.cloud_blockstorage
cs = pyrax.cloudservers 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 changed = False
volumes = []
instance = {} instance = {}
for volume in cbs.list(): try:
if name == volume.display_name or name == volume.id: UUID(volume)
volumes.append(volume) volume = cbs.get(volume)
except ValueError:
try:
volume = cbs.find(name=volume)
except Exception, e:
module.fail_json(msg='%s' % e)
if len(volumes) > 1: if not volume:
module.fail_json(msg='Multiple Storage Volumes were matched by name, ' module.fail_json(msg='No matching storage volumes were found')
'try using the Volume ID instead')
elif not volumes:
module.fail_json(msg='No Storage Volumes were matched by name, '
'try using the Volume ID instead')
volume = volumes[0]
if state == 'present': if state == 'present':
try:
UUID(server)
server = cs.servers.get(server) server = cs.servers.get(server)
except ValueError:
if not server: servers = cs.servers.list(search_opts=dict(name='^%s$' % server))
if not servers:
module.fail_json(msg='No Server was matched by name, ' module.fail_json(msg='No Server was matched by name, '
'try using the Server ID instead') 'try using the Server ID instead')
else: if len(servers) > 1:
if volume.attachments and volume.attachments[0]['server_id'] == server.id: module.fail_json(msg='Multiple servers matched by name, '
'try using the Server ID instead')
# We made it this far, grab the first and hopefully only server
# in the list
server = servers[0]
if (volume.attachments and
volume.attachments[0]['server_id'] == server.id):
changed = False changed = False
elif volume.attachments: elif volume.attachments:
module.fail_json(msg='Volume is attached to another server') module.fail_json(msg='Volume is attached to another server')
else: else:
try: try:
volume.attach_to_instance(server, mountpoint=mountpoint) volume.attach_to_instance(server, mountpoint=device)
changed = True changed = True
except Exception, e: except Exception, e:
module.fail_json(msg='%s' % e.message) module.fail_json(msg='%s' % e.message)
@ -167,9 +212,9 @@ def cloud_block_storage_attachments(module, state, name, server, mountpoint,
if volume.status == 'error': if volume.status == 'error':
result['msg'] = '%s failed to build' % volume.id result['msg'] = '%s failed to build' % volume.id
elif wait: elif wait:
attempts = wait_timeout / 5
pyrax.utils.wait_until(volume, 'status', 'in-use', pyrax.utils.wait_until(volume, 'status', 'in-use',
interval=3, attempts=0, interval=5, attempts=attempts)
verbose=False)
if 'msg' in result: if 'msg' in result:
module.fail_json(**result) module.fail_json(**result)
@ -177,13 +222,24 @@ def cloud_block_storage_attachments(module, state, name, server, mountpoint,
module.exit_json(**result) module.exit_json(**result)
elif state == 'absent': elif state == 'absent':
try:
UUID(server)
server = cs.servers.get(server) server = cs.servers.get(server)
except ValueError:
if not server: servers = cs.servers.list(search_opts=dict(name='^%s$' % server))
if not servers:
module.fail_json(msg='No Server was matched by name, ' module.fail_json(msg='No Server was matched by name, '
'try using the Server ID instead') 'try using the Server ID instead')
else: if len(servers) > 1:
if volume.attachments and volume.attachments[0]['server_id'] == server.id: module.fail_json(msg='Multiple servers matched by name, '
'try using the Server ID instead')
# We made it this far, grab the first and hopefully only server
# in the list
server = servers[0]
if (volume.attachments and
volume.attachments[0]['server_id'] == server.id):
try: try:
volume.detach() volume.detach()
if wait: if wait:
@ -221,11 +277,11 @@ def main():
argument_spec = rax_argument_spec() argument_spec = rax_argument_spec()
argument_spec.update( argument_spec.update(
dict( dict(
mountpoint=dict(), device=dict(required=True),
name=dict(), volume=dict(required=True),
server=dict(), server=dict(required=True),
state=dict(default='present', choices=['present', 'absent']), state=dict(default='present', choices=['present', 'absent']),
wait=dict(type='bool'), wait=dict(type='bool', default=False),
wait_timeout=dict(type='int', default=300) wait_timeout=dict(type='int', default=300)
) )
) )
@ -235,16 +291,19 @@ def main():
required_together=rax_required_together() required_together=rax_required_together()
) )
mountpoint = module.params.get('mountpoint') if not HAS_PYRAX:
name = module.params.get('name') 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') server = module.params.get('server')
state = module.params.get('state') state = module.params.get('state')
wait = module.params.get('wait') wait = module.params.get('wait')
wait_timeout = int(module.params.get('wait_timeout')) wait_timeout = module.params.get('wait_timeout')
setup_rax_module(module, pyrax) setup_rax_module(module, pyrax)
cloud_block_storage_attachments(module, state, name, server, mountpoint, cloud_block_storage_attachments(module, state, volume, server, device,
wait, wait_timeout) wait, wait_timeout)
# import module snippets # import module snippets