Client library for OpenStack containing Infra business logic
Go to file
Jenkins 5662df15f0 Merge "Improve test coverage: project API" 2015-12-03 16:12:51 +00:00
doc/source Split out OpenStackCloud and OperatorCloud classes 2015-10-31 15:18:32 -04:00
extras Allow specifying cloud name to ansible tests 2015-11-21 14:27:54 +00:00
shade Merge "Improve test coverage: project API" 2015-12-03 16:12:51 +00: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
CONTRIBUTING.rst Add minor OperatorCloud documentation 2015-04-30 15:12:59 -04:00
HACKING.rst Initial cookiecutter repo 2014-08-30 17:05:28 -07: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 Update README to not reference client passthrough 2015-11-01 15:20:45 -05:00
requirements.txt Remove cinderclient version pin 2015-12-02 06:24:03 -08:00
setup.cfg Add inventory command to shade 2015-06-05 13:46:59 -04:00
setup.py Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
test-requirements.txt Update pbr version pins 2015-05-28 10:52:59 -04:00
tox.ini Allow specifying cloud name to ansible tests 2015-11-21 14:27:54 +00:00

README.rst

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)