Client library for OpenStack containing Infra business logic
Go to file
Jenkins e2efb08994 Merge "Add methods to create and delete networks" 2015-03-17 13:47:35 +00:00
doc/source Fix up copyright headers 2015-01-07 12:31:15 -05:00
shade Merge "Add methods to create and delete networks" 2015-03-17 13:47:35 +00:00
.coveragerc Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
.gitignore Add cover to .gitignore 2015-03-06 10:25:27 +01:00
.gitreview Change meta info to be an Infra project 2015-01-07 13:06:42 -05:00
.mailmap Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
.testr.conf Add initial compute functional tests to Shade 2015-03-13 13:40:46 +00:00
CONTRIBUTING.rst Change meta info to be an Infra project 2015-01-07 13:06:42 -05: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 Revamp README file 2015-02-19 18:47:15 +01:00
requirements.txt Add behavior to enable ironic noauth mode 2015-03-01 10:52:18 -05:00
setup.cfg Change meta info to be an Infra project 2015-01-07 13:06:42 -05:00
setup.py Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
test-requirements.txt Initial cookiecutter repo 2014-08-30 17:05:28 -07:00
tox.ini Clean up race condition in functional tests 2015-03-16 12:27:24 -04:00

README.rst

shade

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. :

from shade import *
import time

# Initialize cloud
# Cloud configs are read with os-client-config
cloud = openstack_cloud('mordred')

# OpenStackCloud object has an interface exposing OpenStack services methods
print cloud.list_servers()
s = cloud.list_servers()[0]

# But you can also access the underlying python-*client objects
cinder = cloud.cinder_client
volumes = cinder.volumes.list()
volume_id = [v for v in volumes if v.status == 'available'][0].id
nova = cloud.nova_client
print nova.volumes.create_server_volume(s.id, volume_id, None)
attachments = []
print volume_id
while not attachments:
    print "Waiting for attach to finish"
    time.sleep(1)
    attachments = cinder.volumes.get(volume_id).attachments
print attachments