Unified SDK for OpenStack
Go to file
Thomas Bucaioni 4ad2d0d2a0 Reindentation of the docstrings
Change-Id: If2dfd76bc52ae2810d835e4a530333789f2555ca
2021-10-22 15:13:55 +00:00
devstack Finish updating links to point to opendev 2019-04-21 12:31:44 +00:00
doc Merge "Adds storage pools to shared file system" into feature/r1 2021-09-06 17:44:44 +00:00
examples Add shared file systems support 2021-02-18 08:48:21 -08:00
extras Add ansible stable-2.9 job and run 2.8 and 2.9 2020-03-24 08:43:10 -05:00
openstack Reindentation of the docstrings 2021-10-22 15:13:55 +00:00
playbooks/devstack [tests] Improve devstack/post playbook efficiency 2020-03-25 20:06:51 +00:00
releasenotes Merge "Adds storage pools to shared file system" into feature/r1 2021-09-06 17:44:44 +00:00
tools Stop subclassing object 2020-05-10 08:29:41 -05:00
.coveragerc Fix coverage configuration and execution 2016-03-14 07:34:53 +00:00
.gitignore Merge tox, tests and other support files 2017-10-04 14:51:08 -05:00
.gitreview Update .gitreview for feature/r1 2021-05-04 16:12:29 +00:00
.mailmap Merge tox, tests and other support files 2017-10-04 14:51:08 -05:00
.pre-commit-config.yaml Add pre-commit 2021-03-11 16:28:27 +00:00
.stestr.conf Merge shade and os-client-config into the tree 2017-11-15 09:03:23 -06:00
.zuul.yaml Add a manila functional check job 2021-08-26 07:14:47 +00:00
babel.cfg setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
bindep.txt pypy is not checked at gate 2018-04-27 08:56:58 -05:00
CONTRIBUTING.rst fix "How To Contribute" url 2019-09-18 14:34:22 +08:00
create_yaml.sh Fix the network quota tests 2017-02-19 09:46:52 -07:00
docs-requirements.txt Add requirements.txt file for readthedocs 2015-05-21 08:16:44 -07:00
HACKING.rst Fix some typos 2019-03-09 17:25:16 +01:00
LICENSE setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
MANIFEST.in setting up the initial layout; move the api proposals to api_strawman 2014-01-24 22:58:25 -06:00
post_test_hook.sh Update load_balancer for v2 API 2017-07-18 18:05:29 -07:00
README.rst Improve README to provide example of Resource usage 2021-03-24 13:46:03 +00:00
requirements.txt Fix l-c testing for ubuntu focal 2020-09-10 13:02:57 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-12 09:54:38 +08:00
setup.py Small cleanups after Python2 drop 2020-03-27 23:49:45 +00:00
SHADE-MERGE-TODO.rst Use discovery instead of config to create proxies 2018-10-06 07:44:29 -05:00
test-requirements.txt Apply pep8 import order style 2021-03-08 16:50:54 +01:00
tox.ini Fix import order in block_storage tests 2021-07-16 12:15:35 +02:00

openstacksdk

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 any OpenStack cloud regardless of configuration, then the Cloud Abstraction layer is for you.

More information about the history of openstacksdk can be found at https://docs.openstack.org/openstacksdk/latest/contributor/history.html

Getting started

openstacksdk aims to talk to any OpenStack cloud. To do this, it requires a configuration file. openstacksdk favours clouds.yaml files, but can also use environment variables. The clouds.yaml file should be provided by your cloud provider or deployment tooling. An example:

clouds:
  mordred:
    region_name: Dallas
    auth:
      username: 'mordred'
      password: XXXXXXX
      project_name: 'demo'
      auth_url: 'https://identity.example.com'

openstacksdk will look for clouds.yaml files in the following locations:

  • . (the current directory)
  • $HOME/.config/openstack
  • /etc/openstack

openstacksdk consists of three layers. Most users will make use of the proxy layer. Using the above clouds.yaml, consider listing servers:

import openstack

# Initialize and turn on debug logging
openstack.enable_logging(debug=True)

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

# List the servers
for server in conn.compute.servers():
    print(server.to_dict())

openstacksdk also contains a higher-level cloud layer based on logical operations:

import openstack

# Initialize and turn on debug logging
openstack.enable_logging(debug=True)

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

# List the servers
for server in conn.list_servers():
    print(server.to_dict())

The benefit of this layer is mostly seen in more complicated operations that take multiple steps and where the steps vary across providers. For example:

import openstack

# Initialize and turn on debug logging
openstack.enable_logging(debug=True)

# Initialize connection
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 address for it.
conn.create_server(
    'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)

Finally, there is the low-level resource layer. This provides support for the basic CRUD operations supported by REST APIs and is the base building block for the other layers. You typically will not need to use this directly:

import openstack
import openstack.config.loader
import openstack.compute.v2.server

# Initialize and turn on debug logging
openstack.enable_logging(debug=True)

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

# List the servers
for server in openstack.compute.v2.server.Server.list(session=conn.compute):
    print(server.to_dict())

Configuration

openstacksdk uses the openstack.config module to parse configuration. openstack.config will find cloud configuration for as few as one cloud 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

You can view the configuration identified by openstacksdk in your current environment by running openstack.config.loader. For example:

$ python -m openstack.config.loader

More information at https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html