Skip to content
Unified SDK for OpenStack
Branch: master
Clone or download
OpenDev Sysadmins
OpenDev Sysadmins OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at with any
questions you may have.
Latest commit f198347 Apr 19, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
devstack Rename python-openstacksdk to openstacksdk in zuul.yaml Mar 23, 2018
doc Merge "Make PATCH a first class operation and support it for baremetal" Mar 28, 2019
examples Add DNS support Mar 2, 2019
extras Merge "Add ansible functional tests" May 30, 2018
openstack Merge "Allow replacing service implementation" Apr 18, 2019
releasenotes Actually pass on network_data when building configdrive Apr 17, 2019
tools Fix the conflict of urlparse between python2 and python3 Oct 31, 2018
.gitignore Merge tox, tests and other support files Oct 4, 2017
.mailmap Merge tox, tests and other support files Oct 4, 2017
.stestr.conf Merge shade and os-client-config into the tree Nov 15, 2017
.zuul.yaml OpenDev Migration Patch Apr 19, 2019
HACKING.rst Fix some typos Mar 9, 2019
LICENSE Initial Cookiecutter Commit. Sep 20, 2014
README.rst Change openstack-dev to openstack-discuss Dec 14, 2018
babel.cfg Initial Cookiecutter Commit. Sep 20, 2014
bindep.txt pypy is not checked at gate Apr 27, 2018 Fix the network quota tests Feb 19, 2017
lower-constraints.txt Collect request stats Mar 11, 2019 Update load_balancer for v2 API Jul 19, 2017
requirements.txt Revert "Revert "Replace TaskManager with a keystoneauth concurrency"" Mar 10, 2019
setup.cfg Change openstack-dev to openstack-discuss Dec 4, 2018 Manually sync with g-r Jul 24, 2017
test-requirements.txt Collect request stats Mar 11, 2019
tox.ini Move pep8 requirements in to test-requirements Mar 10, 2019



openstacksdk is a client library for building applications to work with OpenStack clouds. The project aims to provide a consistent and complete set of interactions with OpenStack's many services, along with complete documentation, examples, and tools.

It also contains an abstraction interface layer. Clouds can do 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, the per-service oriented portions of the SDK are for you. 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 the Cloud Abstraction layer is for you.

A Brief History

openstacksdk started its life as three different libraries: shade, os-client-config and python-openstacksdk.

shade started its life as some code inside of OpenStack Infra's nodepool project, and as some code inside of the Ansible OpenStack Modules. Ansible had 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 the 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.

Because of its background from nodepool, shade contained abstractions to work around deployment differences and is resource oriented rather than service oriented. This allows a user to think about Security Groups without having to know whether Security Groups are provided by Nova or Neutron on a given cloud. On the other hand, as an interface that provides an abstraction, it deviates from the published OpenStack REST API and adds its own opinions, which may not get in the way of more advanced users with specific needs.

os-client-config was a library for collecting client configuration for using an OpenStack cloud in a consistent and comprehensive manner, which introduced the clouds.yaml file for expressing named cloud configurations.

python-openstacksdk was a library that exposed the OpenStack APIs to developers in a consistent and predictable manner.

After a while it became clear that there was value in both the high-level layer that contains additional business logic and the lower-level SDK that exposes services and their resources faithfully and consistently as Python objects.

Even with both of those layers, it is still beneficial at times to be able to make direct REST calls and to do so with the same properly configured Session from python-requests.

This led to the merge of the three projects.

The original contents of the shade library have been moved into and os-client-config has been moved in to openstack.config. Future releases of shade will provide a thin compatibility layer that subclasses the objects from and provides different argument defaults where needed for compatibility. Similarly future releases of os-client-config will provide a compatibility layer shim around openstack.config.


List servers using objects configured with the clouds.yaml file:

import openstack

# Initialize and turn on debug logging

# Initialize cloud
conn = openstack.connect(cloud='mordred')

for server in conn.compute.servers():


openstack.config will find cloud configuration for as few as 1 clouds and as many as you want to put in a config file. It will read environment variables and config files, and it also contains some vendor specific default values so that you don't have to know extra info to use OpenStack

  • If you have a config file, you will get the clouds listed in it
  • If you have environment variables, you will get a cloud named envvars
  • If you have neither, you will get a cloud named defaults with base defaults

Sometimes an example is nice.

Create a clouds.yaml file:

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

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

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

More information at

Create a server using objects configured with the clouds.yaml file:


# Initialize and turn on debug logging

# Initialize connection
# Cloud configs are read with openstack.config
conn = openstack.connect(cloud='mordred')

# Upload an image to the cloud
image = conn.create_image(
    'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)

# Find a flavor with at least 512M of RAM
flavor = conn.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)


You can’t perform that action at this time.