b2bc8c55ff
While running a script against all of the existing clouds, there were a few issues that popped up. Most notably: - get_openstack_vars would bomb out if your cloud didn't have security groups (rax) - nova boot has a "this is why your boot failed" field that we did not pass on to the user - TaskManager debug output showed the cloud but not the region, which is confusing when you have clouds with more than one region - The novaclient error message for when you pass in the wrong datatype for nics is "str has no attribute get" which does not tell you that what you did was pass in a dict when you were supposed to have passed in a list of dicts. The problem is easy to trap for, and in more extreme cases to provide a better error message for. Change-Id: Ie4f7c68d0ff95e020042189937ce452e596802cf
Introduction
shade is a simple client library for operating OpenStack clouds. The key word here is simple. Clouds can do many many many things - but there are probably only about 10 of them that most people care about with any regularity. If you want to do complicated things, you should probably use the lower level client libraries - or even the REST API directly. However, if what you want is to be able to write an application that talks to clouds no matter what crazy choices the deployer has made in an attempt to be more hipster than their self-entitled narcissist peers, then shade is for you.
shade started its life as some code inside of ansible. ansible has a bunch of different OpenStack related modules, and there was a ton of duplicated code. Eventually, between refactoring that duplication into an internal library, and adding logic and features that the OpenStack Infra team had developed to run client applications at scale, it turned out that we'd written nine-tenths of what we'd need to have a standalone library.
Example
Sometimes an example is nice. :
import shade
# Initialize and turn on debug loggin
shade.simple_logging(debug=True)
# Initialize cloud
# Cloud configs are read with os-client-config
cloud = shade.openstack_cloud(cloud='mordred')
# Upload an image to the cloud
image = cloud.create_image(
'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)
# Find a flavor with at least 512M of RAM
flavor = cloud.get_flavor_by_ram(512)
# Boot a server, wait for it to boot, and then do whatever is needed
# to get a public ip for it.
cloud.create_server(
'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)