Client library for OpenStack containing Infra business logic
Go to file
Monty Taylor 71322c7bbc
Fix several concurrent shade gate issues
This is a big patch because there are more than one issue happening at
the same time and we have to fix all of them to fix any of them.

Force nova microversion to 2.0

The current use of novaclient is to get the latest microversion. So far
this has not been a problem, as shade deals with different payloads
across clouds all the time. However, the latest microversion to nova
broke shade's expectations about how usage reports work. Actual
microversion support is coming soon to shade, but is too much of a task
for a gate fix. In the meantime, pin to 2.0 which is available on all of
the clouds.

Produce some debug details about nova usage objects
Capture novaclient debug logging

In chasing down the usage issue, we were missing the REST interactions
we needed to be effective in chasing down the problem. novaclient passes
its own logger to keystoneauth Session, so we needed to include it in
the debug logging setup.

Also, add a helper function to make adding things like this easier.

Consume cirros qcow2 image if it's there

The move from ami to qcow2 for cirros broke shade's finding of it as a
candidate image. Move pick_image into the base class so that we can include
add_on_exception and error messages everywhere consistently.

Add image list to debug output on failure.
When we can't find a sensible image, add the list of images to the test
output so that we can examine them.

Change-Id: Ifae65e6cdf48921eaa379b803913277affbfe22a
2017-02-15 13:18:30 -06:00
devstack Add a devstack plugin for shade 2016-10-20 15:03:09 +11:00
doc/source Update coding document to mention direct REST calls 2017-01-23 10:26:29 +01:00
extras Remove troveclient from the direct dependency list 2017-02-01 02:58:15 +00:00
releasenotes/notes Fix several concurrent shade gate issues 2017-02-15 13:18:30 -06:00
shade Fix several concurrent shade gate issues 2017-02-15 13:18:30 -06:00
.coveragerc Start using keystoneauth for keystone sessions 2015-09-21 11:12:21 -05:00
.gitignore Tell git to ignore .eggs directory 2015-10-12 12:54:39 -04:00
.gitreview Change meta info to be an Infra project 2015-01-07 13:06:42 -05:00
.mailmap Add entry for James Blair to .mailmap 2015-10-23 09:51:05 +09:00
.testr.conf Add initial compute functional tests to Shade 2015-03-13 13:40:46 +00:00
bindep.txt Add libffi-dev to bindep.txt 2016-09-06 14:25:09 -05:00
CONTRIBUTING.rst Add minor OperatorCloud documentation 2015-04-30 15:12:59 -04:00
HACKING.rst Update HACKING.rst with a couple of shade specific notes 2016-08-21 11:17:56 -05:00
LICENSE Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
MANIFEST.in Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
README.rst Change operating to interacting with in README 2016-07-14 08:14:22 +00:00
requirements.txt Remove troveclient from the direct dependency list 2017-02-01 02:58:15 +00:00
setup.cfg Change operating to interacting with in README 2016-07-14 08:14:22 +00:00
setup.py Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
test-requirements.txt Transition nova flavor tests to requests_mock 2017-01-31 22:37:14 +00:00
tox.ini Add helper script to install branch tips 2017-01-18 16:55:23 -06:00

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)