Client library for OpenStack containing Infra business logic
Go to file
Monty Taylor 68a8d513dd
Handle pagination for glance images
The default glance image list pagination seems to be about 20, which
means for v2 you really need to deal with pagination every time. It also
seems that the limit parameter does _not_ allow you to get more items
than the server default, so you can't just say "limit 100000" and be
done with it.

In order to accomplish this, we need to have the adapter stop trying to
return only the image list when there are other top level keys (so the
code can read the next link) and then do a loop requesting the next
link.

To make us even happier, glance returns the next link as '/v2/images' but
we have already set the adapter to 'https://example.com/v2' due to
version discovery. Since we're setting the endpoint_override on the
adapater, it treats that as the root, leaving us with
https://example.com/v2/v2/images. To deal with that, introduce a 'raw'
adapter which is bound to whatever is in the catalog, rather than
whatever we found through version discovery.

Change-Id: I030147e0275d0c4ee89588e21b5970f7d81800d3
Story: 2000837
2017-01-06 10:23:23 -06:00
devstack Add a devstack plugin for shade 2016-10-20 15:03:09 +11:00
doc/source Add new attributes to floating ips 2016-12-13 12:24:15 -06:00
extras Make sure Ansible tests only use cirros images 2016-05-13 09:51:45 -04:00
releasenotes/notes Handle pagination for glance images 2017-01-06 10:23:23 -06:00
shade Handle pagination for glance images 2017-01-06 10:23:23 -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 glanceclient and warlock from shade 2016-12-12 14:01:54 -06: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 Remove glanceclient and warlock from shade 2016-12-12 14:01:54 -06:00
tox.ini Tox: optimize the docs target 2016-12-07 12:28:26 +01: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)