cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Refactor rax module

Browse source
This commit is contained in:
Matt Martz 2013-11-15 12:25:21 -06:00
parent af0cdd464c
commit 234a78673b
1 changed files with 513 additions and 191 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

704
library/cloud/rax
View file

@ -19,82 +19,111 @@ DOCUMENTATION = '''
module: rax module: rax
short_description: create / delete an instance in Rackspace Public Cloud short_description: create / delete an instance in Rackspace Public Cloud
description: description:
- creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be 'running'. - creates / deletes a Rackspace Public Cloud instance and optionally
waits for it to be 'running'.
version_added: "1.2" version_added: "1.2"
options: options:
service:
description:
- Cloud service to interact with
choices: ['cloudservers']
default: cloudservers
state:
description:
- Indicate desired state of the resource
choices: ['present', 'active', 'absent', 'deleted']
default: present
credentials:
description:
- File to find the Rackspace credentials in (ignored if C(api_key) and
C(username) are provided)
default: null
aliases: ['creds_file']
api_key: api_key:
description: description:
- Rackspace API key (overrides C(credentials)) - Rackspace API key (overrides I(credentials))
username: count:
description: description:
- Rackspace username (overrides C(credentials)) - number of instances to launch
name: default: 1
version_added: 1.4
count_offset:
description: description:
- Name to give the instance - number count to start at
default: 1
version_added: 1.4
credentials:
description:
- File to find the Rackspace credentials in (ignored if I(api_key) and
I(username) are provided)
default: null default: null
flavor: aliases: ['creds_file']
description:
- flavor to use for the instance
default: null
image:
description:
- image to use for the instance
default: null
meta:
description:
- A hash of metadata to associate with the instance
default: null
key_name:
description:
- key pair to use on the instance
default: null
aliases: ['keypair']
files:
description:
- Files to insert into the instance. remotefilename:localcontent
default: null
region:
description:
- Region to create an instance in
default: DFW
disk_config: disk_config:
description: description:
- Disk partitioning strategy - Disk partitioning strategy
choices: ['auto', 'manual'] choices: ['auto', 'manual']
version_added: '1.4' version_added: '1.4'
default: auto default: auto
exact_count:
description:
- Explicitly ensure an exact count of instances, used with
state=active/present
default: no
version_added: 1.4
files:
description:
- Files to insert into the instance. remotefilename:localcontent
default: null
flavor:
description:
- flavor to use for the instance
default: null
group:
description:
- host group to assign to server, is also used for idempotent operations
to ensure a specific number of instances
version_added: 1.4
image:
description:
- image to use for the instance. Can be an C(id), C(human_id) or C(name)
default: null
instance_ids:
description:
- list of instance ids, currently only used when state='absent' to
remove instances
version_added: 1.4
key_name:
description:
- key pair to use on the instance
default: null
aliases: ['keypair']
meta:
description:
- A hash of metadata to associate with the instance
default: null
name:
description:
- Name to give the instance
default: null
networks:
description:
- The network to attach to the instances. If specified, you must include
ALL networks including the public and private interfaces. Can be C(id)
or C(label).
default: ['public', 'private']
version_added: 1.4
region:
description:
- Region to create an instance in
default: DFW
state:
description:
- Indicate desired state of the resource
choices: ['present', 'absent']
default: present
username:
description:
- Rackspace username (overrides I(credentials))
wait: wait:
description: description:
- wait for the instance to be in state 'running' before returning - wait for the instance to be in state 'running' 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: Jesse Keating author: Jesse Keating, Matt Martz
notes: notes:
- The following environment variables can be used, C(RAX_USERNAME), - The following environment variables can be used, C(RAX_USERNAME),
C(RAX_API_KEY), C(RAX_CREDS), C(RAX_CREDENTIALS), C(RAX_REGION). C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
- C(RAX_CREDENTIALS) and C(RAX_CREDS) points to a credentials file - C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
appropriate for pyrax appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file - C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...) - C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
''' '''
@ -102,13 +131,11 @@ notes:
EXAMPLES = ''' EXAMPLES = '''
- name: Build a Cloud Server - name: Build a Cloud Server
gather_facts: False gather_facts: False
tasks: tasks:
- name: Server build request - name: Server build request
local_action: local_action:
module: rax module: rax
credentials: ~/.raxpub credentials: ~/.raxpub
service: cloudservers
name: rax-test1 name: rax-test1
flavor: 5 flavor: 5
image: b11d9567-e412-4255-96b9-bd63ab23bcfe image: b11d9567-e412-4255-96b9-bd63ab23bcfe
@ -117,179 +144,479 @@ EXAMPLES = '''
/root/test.txt: /home/localuser/test.txt /root/test.txt: /home/localuser/test.txt
wait: yes wait: yes
state: present state: present
networks:
- private
- public
''' '''
import sys import sys
import time import time
import os import os
import re
from uuid import UUID
from types import NoneType
try: try:
import pyrax import pyrax
import pyrax.utils
except ImportError: except ImportError:
print("failed=True msg='pyrax required for this module'") print("failed=True msg='pyrax is required for this module'")
sys.exit(1) sys.exit(1)
# These are possible services, but only cloudservers is supported at this time ACTIVE_STATUSES = ('ACTIVE', 'BUILD', 'HARD_REBOOT', 'MIGRATING', 'PASSWORD',
#SUPPORTEDSERVICES = ['cloudservers', 'cloudfiles', 'cloud_blockstorage', 'REBOOT', 'REBUILD', 'RESCUE', 'RESIZE', 'REVERT_RESIZE')
# 'cloud_databases', 'cloud_loadbalancers'] FINAL_STATUSES = ('ACTIVE', 'ERROR')
SUPPORTEDSERVICES = ['cloudservers'] NON_CALLABLES = (basestring, bool, dict, int, list, NoneType)
PUBLIC_NET_ID = "00000000-0000-0000-0000-000000000000"
SERVICE_NET_ID = "11111111-1111-1111-1111-111111111111"
def rax_slugify(value):
return 'rax_%s' % (re.sub('[^\w-]', '_', value).lower().lstrip('_'))
def pyrax_object_to_dict(obj):
instance = {}
for key in dir(obj):
value = getattr(obj, key)
if (isinstance(value, NON_CALLABLES) and not key.startswith('_')):
key = rax_slugify(key)
instance[key] = value
for attr in ['id', 'accessIPv4', 'name', 'status']:
instance[attr] = instance.get(rax_slugify(attr))
return instance
def create(module, names, flavor, image, meta, key_name, files,
wait, wait_timeout, disk_config, group, nics):
cs = pyrax.cloudservers
changed = False
# Handle the file contents
for rpath in files.keys():
lpath = os.path.expanduser(files[rpath])
try:
fileobj = open(lpath, 'r')
files[rpath] = fileobj
except Exception, e:
module.fail_json(msg='Failed to load %s' % lpath)
try:
servers = []
for name in names:
servers.append(cs.servers.create(name=name, image=image,
flavor=flavor, meta=meta,
key_name=key_name,
files=files, nics=nics,
disk_config=disk_config))
except Exception, e:
module.fail_json(msg='%s' % e.message)
else:
changed = True
if wait:
end_time = time.time() + wait_timeout
infinite = wait_timeout == 0
while infinite or time.time() < end_time:
for server in servers:
try:
server.get()
except:
server.status == 'ERROR'
if not filter(lambda s: s.status not in FINAL_STATUSES,
servers):
break
time.sleep(5)
success = []
error = []
timeout = []
for server in servers:
try:
server.get()
except:
server.status == 'ERROR'
instance = pyrax_object_to_dict(server)
if server.status == 'ACTIVE' or not wait:
success.append(instance)
elif server.status == 'ERROR':
error.append(instance)
elif wait:
timeout.append(instance)
results = {
'changed': changed,
'action': 'create',
'instances': success + error + timeout,
'success': success,
'error': error,
'timeout': timeout,
'instance_ids': {
'instances': [i['id'] for i in success + error + timeout],
'success': [i['id'] for i in success],
'error': [i['id'] for i in error],
'timeout': [i['id'] for i in timeout]
}
}
if timeout:
results['msg'] = 'Timeout waiting for all servers to build'
elif error:
results['msg'] = 'Failed to build all servers'
if 'msg' in results:
module.fail_json(**results)
else:
module.exit_json(**results)
def delete(module, instance_ids, wait, wait_timeout):
cs = pyrax.cloudservers
changed = False
instances = {}
servers = []
for instance_id in instance_ids:
servers.append(cs.servers.get(instance_id))
for server in servers:
try:
server.delete()
except Exception, e:
module.fail_json(msg=e.message)
else:
changed = True
instance = pyrax_object_to_dict(server)
instances[instance['id']] = instance
# If requested, wait for server deletion
if wait:
end_time = time.time() + wait_timeout
infinite = wait_timeout == 0
while infinite or time.time() < end_time:
for server in servers:
instance_id = server.id
try:
server.get()
except:
instances[instance_id]['status'] = 'DELETED'
if not filter(lambda s: s['status'] not in ('', 'DELETED',
'ERROR'),
instances.values()):
break
time.sleep(5)
timeout = filter(lambda s: s['status'] not in ('', 'DELETED', 'ERROR'),
instances.values())
error = filter(lambda s: s['status'] in ('ERROR'),
instances.values())
success = filter(lambda s: s['status'] in ('', 'DELETED'),
instances.values())
results = {
'changed': changed,
'action': 'delete',
'instances': success + error + timeout,
'success': success,
'error': error,
'timeout': timeout,
'instance_ids': {
'instances': [i['id'] for i in success + error + timeout],
'success': [i['id'] for i in success],
'error': [i['id'] for i in error],
'timeout': [i['id'] for i in timeout]
}
}
if timeout:
results['msg'] = 'Timeout waiting for all servers to delete'
elif error:
results['msg'] = 'Failed to delete all servers'
if 'msg' in results:
module.fail_json(**results)
else:
module.exit_json(**results)
def cloudservers(module, state, name, flavor, image, meta, key_name, files, def cloudservers(module, state, name, flavor, image, meta, key_name, files,
wait, wait_timeout, disk_config): wait, wait_timeout, disk_config, count, group,
# Check our args (this could be done better) instance_ids, exact_count, networks, count_offset):
for arg in (state, name, flavor, image): cs = pyrax.cloudservers
if not arg: cnw = pyrax.cloud_networks
module.fail_json(msg='%s is required for cloudservers' % arg)
instances = []
changed = False
servers = [] servers = []
# See if we can find servers that match our options
for server in pyrax.cloudservers.list(): # Add the group meta key
if name != server.name: if group and 'group' not in meta:
continue meta['group'] = group
if int(flavor) != int(server.flavor['id']): elif 'group' in meta and group is None:
continue group = meta['group']
if image != server.image['id']:
continue # Check if the provided image is a UUID and if not, search for an
if meta != server.metadata: # appropriate image using human_id and name
continue if image:
# Nothing else ruled us not a match, so consider it a winner try:
servers.append(server) UUID(image)
except ValueError:
try:
image = cs.images.find(human_id=image)
except (pyrax.exceptions.NotFound,
pyrax.exceptions.NoUniqueMatch):
try:
image = cs.images.find(name=image)
except (pyrax.exceptions.NotFound,
pyrax.exceptions.NoUniqueMatch):
module.fail_json(msg='No matching image found (%s)' %
image)
image = pyrax.utils.get_id(image)
# Check if the provided network is a UUID and if not, search for an
# appropriate network using label
nics = []
if networks:
for network in networks:
try:
UUID(network)
except ValueError:
if network.lower() == 'public':
nics.extend(cnw.get_server_networks(PUBLIC_NET_ID))
elif network.lower() == 'private':
nics.extend(cnw.get_server_networks(SERVICE_NET_ID))
else:
try:
network_obj = cnw.find_network_by_label(network)
except (pyrax.exceptions.NetworkNotFound,
pyrax.exceptions.NetworkLabelNotUnique):
module.fail_json(msg='No matching network found (%s)' %
network)
else:
nics.extend(cnw.get_server_networks(network_obj))
else:
nics.extend(cnw.get_server_networks(network))
# act on the state # act on the state
if state in ('active', 'present'): if state == 'present':
if not servers: for arg, value in dict(name=name, flavor=flavor,
# Handle the file contents image=image).iteritems():
for rpath in files.keys(): if not value:
lpath = os.path.expanduser(files[rpath]) module.fail_json(msg='%s is required for the "rax" module' %
arg)
# Idempotent ensurance of a specific count of servers
if exact_count is not False:
# See if we can find servers that match our options
if group is None:
module.fail_json(msg='"group" must be provided when using '
'"exact_count"')
else:
numbers = set()
try: try:
fileobj = open(lpath, 'r') name % 0
files[rpath] = fileobj except TypeError, e:
except Exception, e: if e.message.startswith('not all'):
module.fail_json(msg = 'Failed to load %s' % lpath) name = '%s%%d' % name
try: else:
servers = [pyrax.cloudservers.servers.create(name=name, module.fail_json(msg=e.message)
image=image,
flavor=flavor,
key_name=key_name,
meta=meta,
files=files,
disk_config=disk_config)]
changed = True
except Exception, e:
module.fail_json(msg = '%s' % e.message)
for server in servers: pattern = re.sub(r'%\d+[sd]', r'(\d+)', name)
# If requested, wait for server activation for server in cs.servers.list():
if wait: if server.metadata.get('group') == group:
pyrax.utils.wait_until(server, 'status', ('ACTIVE', 'ERROR'), servers.append(server)
interval=5, attempts=wait_timeout/5) match = re.search(pattern, server.name)
if match:
number = int(match.group(1))
numbers.add(number)
# Get a fresh copy of the server details number_range = xrange(count_offset, count_offset + count)
server.get() available_numbers = list(set(number_range).difference(numbers))
if server.status == 'ACTIVE': if len(servers) > count:
instance = {'id': server.id, state = 'absent'
'accessIPv4': server.accessIPv4, del servers[:count]
'name': server.name, instance_ids = []
'status': server.status} for server in servers:
instances.append(instance) instance_ids.append(server.id)
elif server.status == 'ERROR': delete(module, instance_ids, wait, wait_timeout)
module.fail_json(msg = '%s failed to build' % server.id) elif len(servers) < count:
elif wait: names = []
# waiting took too long numbers_to_use = available_numbers[:count - len(servers)]
module.fail_json(msg = 'Timeout waiting on %s' % server.id) for number in numbers_to_use:
names.append(name % number)
else:
module.exit_json(changed=False, action=None, instances=[],
success=[], error=[], timeout=[],
instance_ids={'instances': [],
'success': [], 'error': [],
'timeout': []})
else:
if group is not None:
numbers = set()
elif state in ('absent', 'deleted'): try:
# See if we can find a server that matches our credentials name % 0
for server in servers: except TypeError, e:
if server.name == name: if e.message.startswith('not all'):
if int(server.flavor['id']) == int(flavor) and \ name = '%s%%d' % name
server.image['id'] == image and \ else:
server.metadata == meta: module.fail_json(msg=e.message)
try:
server.delete()
except Exception, e:
module.fail_json(msg = e.message)
instance = {'id': server.id, pattern = re.sub(r'%\d+[sd]', r'(\d+)', name)
'accessIPv4': server.accessIPv4, for server in cs.servers.list():
'name': server.name, if server.metadata.get('group') == group:
'status': 'DELETING'} servers.append(server)
match = re.search(pattern, server.name)
if match:
number = int(match.group(1))
numbers.add(number)
# If requested, wait for server deletion number_range = xrange(count_offset,
if wait: count_offset + count + len(numbers))
try: available_numbers = list(set(number_range).difference(numbers))
pyrax.utils.wait_until(server, 'status', '', interval=5, names = []
attempts=wait_timeout/5) numbers_to_use = available_numbers[:count]
# Get a fresh copy of the server details for number in numbers_to_use:
server.get() names.append(name % number)
except Exception, e: else:
# In this case, an exception means the server is NotFound search_opts = {
instance['status'] = 'DELETED' 'name': name,
else: 'image': image,
# waiting took too long 'flavor': flavor
module.fail_json(msg = 'Timeout waiting on delete %s (%s)' % (server.id, server.status)) }
servers = []
for server in cs.servers.list(search_opts=search_opts):
if server.metadata != meta:
continue
servers.append(server)
instances.append(instance) if len(servers) >= count:
changed = True instances = []
for server in servers:
instances.append(pyrax_object_to_dict(server))
instance_ids = [i['id'] for i in instances]
module.exit_json(changed=False, action=None,
instances=instances, success=[], error=[],
timeout=[],
instance_ids={'instances': instance_ids,
'success': [], 'error': [],
'timeout': []})
names = [name] * (count - len(servers))
create(module, names, flavor, image, meta, key_name, files,
wait, wait_timeout, disk_config, group, nics)
elif state == 'absent':
if instance_ids is None:
for arg, value in dict(name=name, flavor=flavor,
image=image).iteritems():
if not value:
module.fail_json(msg='%s is required for the "rax" '
'module' % arg)
search_opts = {
'name': name,
'image': image,
'flavor': flavor
}
for server in cs.servers.list(search_opts=search_opts):
if meta != server.metadata:
continue
servers.append(server)
instance_ids = []
for server in servers:
if len(instance_ids) < count:
instance_ids.append(server.id)
else:
break
if not instance_ids:
module.exit_json(changed=False, action=None, instances=[],
success=[], error=[], timeout=[],
instance_ids={'instances': [],
'success': [], 'error': [],
'timeout': []})
delete(module, instance_ids, wait, wait_timeout)
module.exit_json(changed=changed, instances=instances)
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec = dict( argument_spec=dict(
service = dict(default='cloudservers', choices=SUPPORTEDSERVICES),
state = dict(default='present', choices=['active', 'present',
'deleted', 'absent']),
credentials = dict(aliases = ['creds_file']),
api_key=dict(), api_key=dict(),
count=dict(default=1, type='int'),
count_offset=dict(default=1, type='int'),
credentials=dict(aliases=['creds_file']),
disk_config=dict(default='auto', choices=['auto', 'manual']),
exact_count=dict(choices=BOOLEANS, default=False, type='bool'),
files=dict(type='dict', default={}),
flavor=dict(),
group=dict(),
image=dict(),
instance_ids=dict(type='list'),
key_name=dict(aliases=['keypair']),
meta=dict(type='dict', default={}),
name=dict(),
networks=dict(type='list', default=['public', 'private']),
region=dict(),
service=dict(),
state=dict(default='present', choices=['present', 'absent']),
username=dict(), username=dict(),
name = dict(), wait=dict(choices=BOOLEANS, default=False, type='bool'),
flavor = dict(), wait_timeout=dict(default=300),
image = dict(), ),
disk_config = dict(default='auto', choices=['auto', 'manual']),
meta = dict(type='dict', default={}),
key_name = dict(aliases = ['keypair']),
files = dict(type='dict', default={}),
region = dict(),
wait = dict(type='bool'),
wait_timeout = dict(default=300),
)
) )
service = module.params.get('service') service = module.params.get('service')
state = module.params.get('state')
credentials = module.params.get('credentials') if service is not None:
module.fail_json(msg='The "service" attribute has been deprecated, '
'please remove "service: cloudservers" from your '
'playbook pertaining to the "rax" module')
api_key = module.params.get('api_key') api_key = module.params.get('api_key')
username = module.params.get('username') count = module.params.get('count')
name = module.params.get('name') count_offset = module.params.get('count_offset')
flavor = module.params.get('flavor') credentials = module.params.get('credentials')
image = module.params.get('image') disk_config = module.params.get('disk_config').upper()
meta = module.params.get('meta') exact_count = module.params.get('exact_count', False)
key_name = module.params.get('key_name')
files = module.params.get('files') files = module.params.get('files')
flavor = module.params.get('flavor')
group = module.params.get('group')
image = module.params.get('image')
instance_ids = module.params.get('instance_ids')
key_name = module.params.get('key_name')
meta = module.params.get('meta')
name = module.params.get('name')
networks = module.params.get('networks')
region = module.params.get('region') region = module.params.get('region')
state = module.params.get('state')
username = module.params.get('username')
wait = module.params.get('wait') wait = module.params.get('wait')
wait_timeout = int(module.params.get('wait_timeout')) wait_timeout = int(module.params.get('wait_timeout'))
disk_config = module.params.get('disk_config').upper()
# Setup the credentials and region # Setup the credentials and region
try: try:
username = username or os.environ.get('RAX_USERNAME') username = username or os.environ.get('RAX_USERNAME')
api_key = api_key or os.environ.get('RAX_API_KEY') api_key = api_key or os.environ.get('RAX_API_KEY')
credentials = credentials or os.environ.get('RAX_CREDENTIALS') or \ credentials = (credentials or os.environ.get('RAX_CREDENTIALS') or
os.environ.get('RAX_CREDS_FILE') os.environ.get('RAX_CREDS_FILE'))
region = region or os.environ.get('RAX_REGION') region = region or os.environ.get('RAX_REGION')
except KeyError, e: except KeyError, e:
module.fail_json(msg = 'Unable to load %s' % e.message) module.fail_json(msg='Unable to load %s' % e.message)
# setup the auth # setup the auth
try: try:
pyrax.set_setting("identity_type", "rackspace") pyrax.set_setting('identity_type', 'rackspace')
if api_key and username: if api_key and username:
pyrax.set_credentials(username, api_key=api_key, region=region) pyrax.set_credentials(username, api_key=api_key, region=region)
elif credentials: elif credentials:
@ -298,19 +625,14 @@ def main():
else: else:
raise Exception('No credentials supplied!') raise Exception('No credentials supplied!')
except Exception, e: except Exception, e:
module.fail_json(msg = '%s' % e.message) module.fail_json(msg='%s' % e.message)
# Act based on service cloudservers(module, state, name, flavor, image, meta, key_name, files,
if service == 'cloudservers': wait, wait_timeout, disk_config, count, group,
cloudservers(module, state, name, flavor, image, meta, key_name, files, instance_ids, exact_count, networks, count_offset)
wait, wait_timeout, disk_config)
elif service in ['cloudfiles', 'cloud_blockstorage',
'cloud_databases', 'cloud_loadbalancers']:
module.fail_json(msg = 'Service %s is not supported at this time' %
service)
# this is magic, see lib/ansible/module_common.py from ansible.module_utils.basic import *
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
### invoke the module
main() main()