f254c915f0
The OpenStack client utilities consume a set of input environment variables for things like username and auth_url, so it's very common for OpenStack users to have such settings set in their environment. Indeed, things like devstack also output a shell file to be sourced to set them. Although in a playbook it's entirely expected that variables should be used to pass in system settings like api passwords, for ad-hoc command line usage, needing to pass in five parameters which are almost certainly in the environment already reduces the utility. Grab the environment variables and inject them as default. Special care is taken to ensure that in the case where the values are not found, the behavior of which parameters are required is not altered.
295 lines
12 KiB
Python
295 lines
12 KiB
Python
#!/usr/bin/python
|
|
#coding: utf-8 -*-
|
|
|
|
# (c) 2013, Benno Joy <benno@ansible.com>
|
|
# (c) 2013, John Dewey <john@dewey.ws>
|
|
#
|
|
# This module is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This software is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this software. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import os
|
|
|
|
try:
|
|
from novaclient.v1_1 import client as nova_client
|
|
from novaclient import exceptions
|
|
import time
|
|
except ImportError:
|
|
print("failed=True msg='novaclient is required for this module'")
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: nova_compute
|
|
version_added: "1.2"
|
|
short_description: Create/Delete VMs from OpenStack
|
|
description:
|
|
- Create or Remove virtual machines from Openstack.
|
|
options:
|
|
login_username:
|
|
description:
|
|
- login username to authenticate to keystone
|
|
required: true
|
|
default: admin
|
|
login_password:
|
|
description:
|
|
- Password of login user
|
|
required: true
|
|
default: 'yes'
|
|
login_tenant_name:
|
|
description:
|
|
- The tenant name of the login user
|
|
required: true
|
|
default: 'yes'
|
|
auth_url:
|
|
description:
|
|
- The keystone url for authentication
|
|
required: false
|
|
default: 'http://127.0.0.1:35357/v2.0/'
|
|
region_name:
|
|
description:
|
|
- Name of the region
|
|
required: false
|
|
default: None
|
|
state:
|
|
description:
|
|
- Indicate desired state of the resource
|
|
choices: ['present', 'absent']
|
|
default: present
|
|
name:
|
|
description:
|
|
- Name that has to be given to the instance
|
|
required: true
|
|
default: None
|
|
image_id:
|
|
description:
|
|
- The id of the image that has to be cloned
|
|
required: true
|
|
default: None
|
|
flavor_id:
|
|
description:
|
|
- The id of the flavor in which the new VM has to be created
|
|
required: false
|
|
default: 1
|
|
key_name:
|
|
description:
|
|
- The key pair name to be used when creating a VM
|
|
required: false
|
|
default: None
|
|
security_groups:
|
|
description:
|
|
- The name of the security group to which the VM should be added
|
|
required: false
|
|
default: None
|
|
nics:
|
|
description:
|
|
- A list of network id's to which the VM's interface should be attached
|
|
required: false
|
|
default: None
|
|
meta:
|
|
description:
|
|
- A list of key value pairs that should be provided as a metadata to the new VM
|
|
required: false
|
|
default: None
|
|
wait:
|
|
description:
|
|
- If the module should wait for the VM to be created.
|
|
required: false
|
|
default: 'yes'
|
|
wait_for:
|
|
description:
|
|
- The amount of time the module should wait for the VM to get into active state
|
|
required: false
|
|
default: 180
|
|
user_data:
|
|
description:
|
|
- Opaque blob of data which is made available to the instance
|
|
required: false
|
|
default: None
|
|
version_added: "1.6"
|
|
requirements: ["novaclient"]
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Creates a new VM and attaches to a network and passes metadata to the instance
|
|
- nova_compute:
|
|
state: present
|
|
login_username: admin
|
|
login_password: admin
|
|
login_tenant_name: admin
|
|
name: vm1
|
|
image_id: 4f905f38-e52a-43d2-b6ec-754a13ffb529
|
|
key_name: ansible_key
|
|
wait_for: 200
|
|
flavor_id: 4
|
|
nics:
|
|
- net-id: 34605f38-e52a-25d2-b6ec-754a13ffb723
|
|
meta:
|
|
hostname: test1
|
|
group: uge_master
|
|
'''
|
|
|
|
def _delete_server(module, nova):
|
|
name = None
|
|
server_list = None
|
|
try:
|
|
server_list = nova.servers.list(True, {'name': module.params['name']})
|
|
if server_list:
|
|
server = [x for x in server_list if x.name == module.params['name']]
|
|
nova.servers.delete(server.pop())
|
|
except Exception, e:
|
|
module.fail_json( msg = "Error in deleting vm: %s" % e.message)
|
|
if module.params['wait'] == 'no':
|
|
module.exit_json(changed = True, result = "deleted")
|
|
expire = time.time() + int(module.params['wait_for'])
|
|
while time.time() < expire:
|
|
name = nova.servers.list(True, {'name': module.params['name']})
|
|
if not name:
|
|
module.exit_json(changed = True, result = "deleted")
|
|
time.sleep(5)
|
|
module.fail_json(msg = "Timed out waiting for server to get deleted, please check manually")
|
|
|
|
|
|
def _create_server(module, nova):
|
|
bootargs = [module.params['name'], module.params['image_id'], module.params['flavor_id']]
|
|
bootkwargs = {
|
|
'nics' : module.params['nics'],
|
|
'meta' : module.params['meta'],
|
|
'key_name': module.params['key_name'],
|
|
'security_groups': module.params['security_groups'].split(','),
|
|
#userdata is unhyphenated in novaclient, but hyphenated here for consistency with the ec2 module:
|
|
'userdata': module.params['user_data'],
|
|
}
|
|
if not module.params['key_name']:
|
|
del bootkwargs['key_name']
|
|
try:
|
|
server = nova.servers.create(*bootargs, **bootkwargs)
|
|
server = nova.servers.get(server.id)
|
|
except Exception, e:
|
|
module.fail_json( msg = "Error in creating instance: %s " % e.message)
|
|
if module.params['wait'] == 'yes':
|
|
expire = time.time() + int(module.params['wait_for'])
|
|
while time.time() < expire:
|
|
try:
|
|
server = nova.servers.get(server.id)
|
|
except Exception, e:
|
|
module.fail_json( msg = "Error in getting info from instance: %s " % e.message)
|
|
if server.status == 'ACTIVE':
|
|
private = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if 'OS-EXT-IPS:type' in x and x['OS-EXT-IPS:type'] == 'fixed']
|
|
public = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if 'OS-EXT-IPS:type' in x and x['OS-EXT-IPS:type'] == 'floating']
|
|
module.exit_json(changed = True, id = server.id, private_ip=''.join(private), public_ip=''.join(public), status = server.status, info = server._info)
|
|
if server.status == 'ERROR':
|
|
module.fail_json(msg = "Error in creating the server, please check logs")
|
|
time.sleep(2)
|
|
|
|
module.fail_json(msg = "Timeout waiting for the server to come up.. Please check manually")
|
|
if server.status == 'ERROR':
|
|
module.fail_json(msg = "Error in creating the server.. Please check manually")
|
|
private = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if x['OS-EXT-IPS:type'] == 'fixed']
|
|
public = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if x['OS-EXT-IPS:type'] == 'floating']
|
|
module.exit_json(changed = True, id = info['id'], private_ip=''.join(private), public_ip=''.join(public), status = server.status, info = server._info)
|
|
|
|
|
|
def _get_server_state(module, nova):
|
|
server = None
|
|
try:
|
|
servers = nova.servers.list(True, {'name': module.params['name']})
|
|
if servers:
|
|
# the {'name': module.params['name']} will also return servers
|
|
# with names that partially match the server name, so we have to
|
|
# strictly filter here
|
|
servers = [x for x in servers if x.name == module.params['name']]
|
|
if servers:
|
|
server = servers[0]
|
|
except Exception, e:
|
|
module.fail_json(msg = "Error in getting the server list: %s" % e.message)
|
|
if server and module.params['state'] == 'present':
|
|
if server.status != 'ACTIVE':
|
|
module.fail_json( msg="The VM is available but not Active. state:" + server.status)
|
|
private = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if 'OS-EXT-IPS:type' in x and x['OS-EXT-IPS:type'] == 'fixed']
|
|
public = [ x['addr'] for x in getattr(server, 'addresses').itervalues().next() if 'OS-EXT-IPS:type' in x and x['OS-EXT-IPS:type'] == 'floating']
|
|
module.exit_json(changed = False, id = server.id, public_ip = ''.join(public), private_ip = ''.join(private), info = server._info)
|
|
if server and module.params['state'] == 'absent':
|
|
return True
|
|
if module.params['state'] == 'absent':
|
|
module.exit_json(changed = False, result = "not present")
|
|
return True
|
|
|
|
|
|
|
|
def main():
|
|
# Consume standard OpenStack environment variables.
|
|
# This is mainly only useful for ad-hoc command line operation as
|
|
# in playbooks one would assume variables would be used appropriately
|
|
OS_USERNAME=os.environ.get('OS_USERNAME', 'admin')
|
|
OS_PASSWORD=os.environ.get('OS_PASSWORD', None)
|
|
login_password_arg = dict()
|
|
if OS_PASSWORD:
|
|
login_password_arg['default'] = OS_PASSWORD
|
|
else:
|
|
login_password_arg['required'] = True
|
|
OS_TENANT_NAME=os.environ.get('OS_TENANT_NAME', None)
|
|
tenant_name_arg = dict()
|
|
if OS_TENANT_NAME:
|
|
tenant_name_arg['default'] = OS_TENANT_NAME
|
|
else:
|
|
tenant_name_arg['required'] = True
|
|
OS_REGION_NAME=os.environ.get('OS_REGION_NAME', None)
|
|
OS_AUTH_URL=os.environ.get('OS_AUTH_URL', 'http://127.0.0.1:35357/v2.0/')
|
|
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
login_username = dict(default=OS_USERNAME),
|
|
login_password = login_password_arg,
|
|
login_tenant_name = tenant_name_arg,
|
|
auth_url = dict(default=OS_AUTH_URL),
|
|
region_name = dict(default=OS_REGION_NAME),
|
|
name = dict(required=True),
|
|
image_id = dict(default=None),
|
|
flavor_id = dict(default=1),
|
|
key_name = dict(default=None),
|
|
security_groups = dict(default='default'),
|
|
nics = dict(default=None),
|
|
meta = dict(default=None),
|
|
wait = dict(default='yes', choices=['yes', 'no']),
|
|
wait_for = dict(default=180),
|
|
state = dict(default='present', choices=['absent', 'present']),
|
|
user_data = dict(default=None)
|
|
),
|
|
)
|
|
|
|
nova = nova_client.Client(module.params['login_username'],
|
|
module.params['login_password'],
|
|
module.params['login_tenant_name'],
|
|
module.params['auth_url'],
|
|
region_name=module.params['region_name'],
|
|
service_type='compute')
|
|
try:
|
|
nova.authenticate()
|
|
except exceptions.Unauthorized, e:
|
|
module.fail_json(msg = "Invalid OpenStack Nova credentials.: %s" % e.message)
|
|
except exceptions.AuthorizationFailure, e:
|
|
module.fail_json(msg = "Unable to authorize user: %s" % e.message)
|
|
|
|
if module.params['state'] == 'present':
|
|
if not module.params['image_id']:
|
|
module.fail_json( msg = "Parameter 'image_id' is required if state == 'present'")
|
|
else:
|
|
_get_server_state(module, nova)
|
|
_create_server(module, nova)
|
|
if module.params['state'] == 'absent':
|
|
_get_server_state(module, nova)
|
|
_delete_server(module, nova)
|
|
|
|
# this is magic, see lib/ansible/module.params['common.py
|
|
from ansible.module_utils.basic import *
|
|
main()
|
|
|