4dad7b2e69
Put extra keys in both the root resource and in a properties dict. Ensure data types are correct. Make sure int, float and bool values are returned as int and bool. Change disabled in flavor to is_disabled for consistency with other bools we've added. There has been no release with the addition of disabled, so changing it now is still safe. Add locations and direct_url to images. They're optional in glance, but that's evil. Let image schema attribute fall through to extra properties. Add zone to current_location. Add readable mappings for power_state, task_state, vm_state, launched_at and terminated_at for Servers. Also add a non-camel-cased host_id. This is a big patch, but it's mostly just reorganizing and adding docs. Looking at the changes to the tests and seeing that the only change is adding zone and properties into a couple of fixtures is a good place to start. Change-Id: If5674c049c8dd85ca0b3483b7c2dc82b9e139bd6
Introduction
shade is a simple client library for interacting with 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 logging
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)