Client library for OpenStack containing Infra business logic
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins a3ff9afbf0 OpenDev Migration Patch 7 hours ago
devstack Replace git:// URLs with https:// 3 weeks ago
doc Decouple OpenStackCloud from Connection 6 months ago
extras List ansible/ansible in required-projects 1 year ago
playbooks/devstack Fetch tox dir and html reports 1 year ago
releasenotes Update master for stable/stein 1 month ago
shade Merge "fix the word 'bandwith'" 1 month ago
.coveragerc Start using keystoneauth for keystone sessions 3 years ago
.gitignore Switch to using stestr 1 year ago
.gitreview OpenDev Migration Patch 7 hours ago
.mailmap Add entry for James Blair to .mailmap 3 years ago
.stestr.conf Switch to using stestr 1 year ago
.zuul.yaml OpenDev Migration Patch 7 hours ago
CONTRIBUTING.rst Add minor OperatorCloud documentation 4 years ago
HACKING.rst Update the url in doc 6 months ago
LICENSE Initial cookiecutter repo 4 years ago Initial cookiecutter repo 4 years ago
README.rst Decouple OpenStackCloud from Connection 6 months ago
bindep.txt Add libffi-dev to bindep.txt 2 years ago
lower-constraints.txt Make OpenStackCloud a subclass of Connection 9 months ago
requirements.txt Make OpenStackCloud a subclass of Connection 9 months ago
setup.cfg Change openstack-dev to openstack-discuss 3 months ago Updated from global requirements 2 years ago
test-requirements.txt Updated from global requirements 1 year ago
tox.ini Fix ansible stable pin in tox test 4 months ago




shade has been superceded by openstacksdk and no longer takes new features. The existing code will continue to be maintained indefinitely for bugfixes as necessary, but improvements will be deferred to openstacksdk. Please update your applications to use openstacksdk directly.

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.


Sometimes an example is nice.

  1. Create a clouds.yml file:

       region_name: RegionOne
         username: 'mordred'
         password: XXXXXXX
         project_name: 'shade'
         auth_url: ''

    Please note: os-client-config will look for a file called clouds.yaml in the following locations:

    • Current Directory
    • ~/.config/openstack
    • /etc/openstack

    More information at

  2. Create a server with shade, configured with the clouds.yml file:

    import shade
    # Initialize and turn on debug logging
    # 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.
        'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)