3 # jose.lausuch@ericsson.com
4 # valentin.boucher@orange.com
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
15 # ----------------------------------------------------------
19 # -----------------------------------------------------------
22 # *********************************************
24 # *********************************************
25 def check_credentials():
27 Check if the OpenStack credentials (openrc) are sourced
29 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
30 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
33 def get_credentials(service):
34 """Returns a creds dictionary filled with the following keys:
36 * password/api_key (depending on the service)
37 * tenant_name/project_id (depending on the service)
39 :param service: a string indicating the name of the service
40 requesting the credentials.
43 # Unfortunately, each of the OpenStack client will request slightly
44 # different entries in their credentials dict.
45 if service.lower() in ("nova", "cinder"):
50 tenant = "tenant_name"
52 # The most common way to pass these info to the script is to do it through
53 # environment variables.
55 "username": os.environ.get('OS_USERNAME', "admin"),
56 password: os.environ.get("OS_PASSWORD", 'admin'),
57 "auth_url": os.environ.get("OS_AUTH_URL",
58 "http://192.168.20.71:5000/v2.0"),
59 tenant: os.environ.get("OS_TENANT_NAME", "admin"),
61 cacert = os.environ.get("OS_CACERT")
62 if cacert is not None:
63 # each openstack client uses differnt kwargs for this
64 creds.update({"cacert": cacert,
66 "https_ca_cert": cacert,
67 "https_cacert": cacert,
69 creds.update({"insecure": "True", "https_insecure": "True"})
70 if not os.path.isfile(cacert):
71 print ("WARNING: The 'OS_CACERT' environment variable is " +
72 "set to %s but the file does not exist." % cacert)
76 # *********************************************
78 # *********************************************
79 def get_instances(nova_client):
81 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
84 print "Error [get_instances(nova_client)]:", e
88 def get_instance_status(nova_client, instance):
90 instance = nova_client.servers.get(instance.id)
91 return instance.status
93 # print ("Error [get_instance_status(nova_client, '%s')]:" %
98 def get_instance_by_name(nova_client, instance_name):
100 instance = nova_client.servers.find(name=instance_name)
103 print ("Error [get_instance_by_name(nova_client, '%s')]:" %
108 def get_flavor_id(nova_client, flavor_name):
109 flavors = nova_client.flavors.list(detailed=True)
112 if f.name == flavor_name:
118 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
119 flavors = nova_client.flavors.list(detailed=True)
122 if min_ram <= f.ram and f.ram <= max_ram:
128 def get_floating_ips(nova_client):
130 floating_ips = nova_client.floating_ips.list()
133 print "Error [get_floating_ips(nova_client)]:", e
137 def create_flavor(nova_client, flavor_name, ram, disk, vcpus):
139 flavor = nova_client.flavors.create(flavor_name, ram, vcpus, disk)
141 print ("Error [create_flavor(nova_client, '%s', '%s', '%s', "
142 "'%s')]:" % (flavor_name, ram, disk, vcpus), e)
147 def create_floating_ip(neutron_client):
148 extnet_id = get_external_net_id(neutron_client)
149 props = {'floating_network_id': extnet_id}
151 ip_json = neutron_client.create_floatingip({'floatingip': props})
152 fip_addr = ip_json['floatingip']['floating_ip_address']
153 fip_id = ip_json['floatingip']['id']
155 print "Error [create_floating_ip(neutron_client)]:", e
157 return {'fip_addr': fip_addr, 'fip_id': fip_id}
160 def add_floating_ip(nova_client, server_id, floatingip_id):
162 nova_client.servers.add_floating_ip(server_id, floatingip_id)
165 print ("Error [add_floating_ip(nova_client, '%s', '%s')]:" %
166 (server_id, floatingip_id), e)
170 def delete_instance(nova_client, instance_id):
172 nova_client.servers.force_delete(instance_id)
175 print "Error [delete_instance(nova_client, '%s')]:" % instance_id, e
179 def delete_floating_ip(nova_client, floatingip_id):
181 nova_client.floating_ips.delete(floatingip_id)
184 print ("Error [delete_floating_ip(nova_client, '%s')]:" %
189 # *********************************************
191 # *********************************************
192 def get_network_list(neutron_client):
193 network_list = neutron_client.list_networks()['networks']
194 if len(network_list) == 0:
200 def get_router_list(neutron_client):
201 router_list = neutron_client.list_routers()['routers']
202 if len(router_list) == 0:
208 def get_port_list(neutron_client):
209 port_list = neutron_client.list_ports()['ports']
210 if len(port_list) == 0:
216 def get_network_id(neutron_client, network_name):
217 networks = neutron_client.list_networks()['networks']
220 if n['name'] == network_name:
226 def get_subnet_id(neutron_client, subnet_name):
227 subnets = neutron_client.list_subnets()['subnets']
230 if s['name'] == subnet_name:
236 def get_router_id(neutron_client, router_name):
237 routers = neutron_client.list_routers()['routers']
240 if r['name'] == router_name:
246 def get_private_net(neutron_client):
247 # Checks if there is an existing shared private network
248 networks = neutron_client.list_networks()['networks']
249 if len(networks) == 0:
252 if (net['router:external'] is False) and (net['shared'] is True):
257 def get_external_net(neutron_client):
258 for network in neutron_client.list_networks()['networks']:
259 if network['router:external']:
260 return network['name']
264 def get_external_net_id(neutron_client):
265 for network in neutron_client.list_networks()['networks']:
266 if network['router:external']:
271 def check_neutron_net(neutron_client, net_name):
272 for network in neutron_client.list_networks()['networks']:
273 if network['name'] == net_name:
274 for subnet in network['subnets']:
279 def create_neutron_net(neutron_client, name):
280 json_body = {'network': {'name': name,
281 'admin_state_up': True}}
283 network = neutron_client.create_network(body=json_body)
284 network_dict = network['network']
285 return network_dict['id']
287 print "Error [create_neutron_net(neutron_client, '%s')]:" % name, e
291 def create_neutron_subnet(neutron_client, name, cidr, net_id):
292 json_body = {'subnets': [{'name': name, 'cidr': cidr,
293 'ip_version': 4, 'network_id': net_id}]}
295 subnet = neutron_client.create_subnet(body=json_body)
296 return subnet['subnets'][0]['id']
298 print ("Error [create_neutron_subnet(neutron_client, '%s', '%s', "
299 "'%s')]:" % (name, cidr, net_id), e)
303 def create_neutron_router(neutron_client, name):
304 json_body = {'router': {'name': name, 'admin_state_up': True}}
306 router = neutron_client.create_router(json_body)
307 return router['router']['id']
309 print "Error [create_neutron_router(neutron_client, '%s')]:" % name, e
313 def create_neutron_port(neutron_client, name, network_id, ip):
314 json_body = {'port': {
315 'admin_state_up': True,
317 'network_id': network_id,
318 'fixed_ips': [{"ip_address": ip}]
321 port = neutron_client.create_port(body=json_body)
322 return port['port']['id']
324 print ("Error [create_neutron_port(neutron_client, '%s', '%s', "
325 "'%s')]:" % (name, network_id, ip), e)
329 def update_neutron_net(neutron_client, network_id, shared=False):
330 json_body = {'network': {'shared': shared}}
332 neutron_client.update_network(network_id, body=json_body)
335 print ("Error [update_neutron_net(neutron_client, '%s', '%s')]:" %
336 (network_id, str(shared)), e)
340 def update_neutron_port(neutron_client, port_id, device_owner):
341 json_body = {'port': {
342 'device_owner': device_owner,
345 port = neutron_client.update_port(port=port_id,
347 return port['port']['id']
349 print ("Error [update_neutron_port(neutron_client, '%s', '%s')]:" %
350 (port_id, device_owner), e)
354 def add_interface_router(neutron_client, router_id, subnet_id):
355 json_body = {"subnet_id": subnet_id}
357 neutron_client.add_interface_router(router=router_id, body=json_body)
360 print ("Error [add_interface_router(neutron_client, '%s', '%s')]:" %
361 (router_id, subnet_id), e)
365 def add_gateway_router(neutron_client, router_id):
366 ext_net_id = get_external_net_id(neutron_client)
367 router_dict = {'network_id': ext_net_id}
369 neutron_client.add_gateway_router(router_id, router_dict)
372 print ("Error [add_gateway_router(neutron_client, '%s')]:" %
377 def delete_neutron_net(neutron_client, network_id):
379 neutron_client.delete_network(network_id)
382 print ("Error [delete_neutron_net(neutron_client, '%s')]:" %
387 def delete_neutron_subnet(neutron_client, subnet_id):
389 neutron_client.delete_subnet(subnet_id)
392 print ("Error [delete_neutron_subnet(neutron_client, '%s')]:" %
397 def delete_neutron_router(neutron_client, router_id):
399 neutron_client.delete_router(router=router_id)
402 print ("Error [delete_neutron_router(neutron_client, '%s')]:" %
407 def delete_neutron_port(neutron_client, port_id):
409 neutron_client.delete_port(port_id)
412 print "Error [delete_neutron_port(neutron_client, '%s')]:" % port_id, e
416 def remove_interface_router(neutron_client, router_id, subnet_id):
417 json_body = {"subnet_id": subnet_id}
419 neutron_client.remove_interface_router(router=router_id,
423 print ("Error [remove_interface_router(neutron_client, '%s', '%s')]:" %
424 (router_id, subnet_id), e)
428 def remove_gateway_router(neutron_client, router_id):
430 neutron_client.remove_gateway_router(router_id)
433 print ("Error [remove_gateway_router(neutron_client, '%s')]:" %
438 # *********************************************
440 # *********************************************
441 def get_security_groups(neutron_client):
443 security_groups = neutron_client.list_security_groups()[
445 return security_groups
447 print "Error [get_security_groups(neutron_client)]:", e
451 def get_security_group_id(neutron_client, sg_name):
452 security_groups = get_security_groups(neutron_client)
454 for sg in security_groups:
455 if sg['name'] == sg_name:
461 def create_security_group(neutron_client, sg_name, sg_description):
462 json_body = {'security_group': {'name': sg_name,
463 'description': sg_description}}
465 secgroup = neutron_client.create_security_group(json_body)
466 return secgroup['security_group']
468 print ("Error [create_security_group(neutron_client, '%s', '%s')]:" %
469 (sg_name, sg_description), e)
473 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
474 port_range_min=None, port_range_max=None):
475 if port_range_min is None and port_range_max is None:
476 json_body = {'security_group_rule': {'direction': direction,
477 'security_group_id': sg_id,
478 'protocol': protocol}}
479 elif port_range_min is not None and port_range_max is not None:
480 json_body = {'security_group_rule': {'direction': direction,
481 'security_group_id': sg_id,
482 'port_range_min': port_range_min,
483 'port_range_max': port_range_max,
484 'protocol': protocol}}
486 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
487 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
488 port_range_min, port_range_max,
490 " Invalid values for port_range_min, port_range_max")
493 neutron_client.create_security_group_rule(json_body)
496 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
497 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
498 port_range_min, port_range_max,
503 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
505 nova_client.servers.add_security_group(instance_id, secgroup_id)
508 print ("Error [add_secgroup_to_instance(nova_client, '%s', '%s')]: " %
509 (instance_id, secgroup_id), e)
513 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
514 json_body = {"quota": {
515 "security_group": sg_quota,
516 "security_group_rule": sg_rule_quota
520 neutron_client.update_quota(tenant_id=tenant_id,
524 print ("Error [update_sg_quota(neutron_client, '%s', '%s', "
525 "'%s')]:" % (tenant_id, sg_quota, sg_rule_quota), e)
529 def delete_security_group(neutron_client, secgroup_id):
531 neutron_client.delete_security_group(secgroup_id)
534 print ("Error [delete_security_group(neutron_client, '%s')]:" %
539 # *********************************************
541 # *********************************************
542 def get_images(nova_client):
544 images = nova_client.images.list()
547 print "Error [get_images]:", e
551 def get_image_id(glance_client, image_name):
552 images = glance_client.images.list()
555 if i.name == image_name:
561 def create_glance_image(glance_client, image_name, file_path, public=True):
562 if not os.path.isfile(file_path):
563 print "Error: file " + file_path + " does not exist."
566 with open(file_path) as fimage:
567 image = glance_client.images.create(name=image_name,
570 container_format="bare",
574 print ("Error [create_glance_image(glance_client, '%s', '%s', "
575 "'%s')]:" % (image_name, file_path, str(public)), e)
579 def delete_glance_image(nova_client, image_id):
581 nova_client.images.delete(image_id)
584 print ("Error [delete_glance_image(nova_client, '%s')]:" % image_id, e)
588 # *********************************************
590 # *********************************************
591 def get_volumes(cinder_client):
593 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
596 print "Error [get_volumes(cinder_client)]:", e
600 def list_volume_types(cinder_client, public=True, private=True):
602 volume_types = cinder_client.volume_types.list()
604 volume_types = [vt for vt in volume_types if not vt.is_public]
606 volume_types = [vt for vt in volume_types if vt.is_public]
609 print "Error [list_volume_types(cinder_client)]:", e
613 def create_volume_type(cinder_client, name):
615 volume_type = cinder_client.volume_types.create(name)
618 print "Error [create_volume_type(cinder_client, '%s')]:" % name, e
622 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
623 snapshots_quota, gigabytes_quota):
624 quotas_values = {"volumes": vols_quota,
625 "snapshots": snapshots_quota,
626 "gigabytes": gigabytes_quota}
629 cinder_client.quotas.update(tenant_id, **quotas_values)
632 print ("Error [update_cinder_quota(cinder_client, '%s', '%s', '%s'"
633 "'%s')]:" % (tenant_id, vols_quota,
634 snapshots_quota, gigabytes_quota), e)
638 def delete_volume(cinder_client, volume_id, forced=False):
642 cinder_client.volumes.detach(volume_id)
644 print "Error:", sys.exc_info()[0]
645 cinder_client.volumes.force_delete(volume_id)
647 cinder_client.volumes.delete(volume_id)
650 print ("Error [delete_volume(cinder_client, '%s', '%s')]:" %
651 (volume_id, str(forced)), e)
655 def delete_volume_type(cinder_client, volume_type):
657 cinder_client.volume_types.delete(volume_type)
660 print ("Error [delete_volume_type(cinder_client, '%s')]:" %
665 # *********************************************
667 # *********************************************
668 def get_tenants(keystone_client):
670 tenants = keystone_client.tenants.list()
673 print "Error [get_tenants(keystone_client)]:", e
677 def get_users(keystone_client):
679 users = keystone_client.users.list()
682 print "Error [get_users(keystone_client)]:", e
686 def get_tenant_id(keystone_client, tenant_name):
687 tenants = keystone_client.tenants.list()
690 if t.name == tenant_name:
696 def get_user_id(keystone_client, user_name):
697 users = keystone_client.users.list()
700 if u.name == user_name:
706 def get_role_id(keystone_client, role_name):
707 roles = keystone_client.roles.list()
710 if r.name == role_name:
716 def create_tenant(keystone_client, tenant_name, tenant_description):
718 tenant = keystone_client.tenants.create(tenant_name,
723 print ("Error [create_tenant(cinder_client, '%s', '%s')]:" %
724 (tenant_name, tenant_description), e)
728 def create_user(keystone_client, user_name, user_password,
729 user_email, tenant_id):
731 user = keystone_client.users.create(user_name, user_password,
732 user_email, tenant_id,
736 print ("Error [create_user(keystone_client, '%s', '%s', '%s'"
737 "'%s')]:" % (user_name, user_password, user_email, tenant_id),
742 def add_role_user(keystone_client, user_id, role_id, tenant_id):
744 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
747 print ("Error [add_role_user(keystone_client, '%s', '%s'"
748 "'%s')]:" % (user_id, role_id, tenant_id), e)
752 def delete_tenant(keystone_client, tenant_id):
754 keystone_client.tenants.delete(tenant_id)
757 print "Error [delete_tenant(keystone_client, '%s')]:" % tenant_id, e
761 def delete_user(keystone_client, user_id):
763 keystone_client.users.delete(user_id)
766 print "Error [delete_user(keystone_client, '%s')]:" % user_id, e