Unified SDK for OpenStack
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.
 
 
 
Zuul e13b59c7bd Merge "Add deploy_steps to baremetal node provisioning" 6 days ago
devstack Finish updating links to point to opendev 2 years ago
doc Merge "Cache auth token in keyring" 1 week ago
examples Add shared file systems support 2 months ago
extras Add ansible stable-2.9 job and run 2.8 and 2.9 1 year ago
openstack Merge "Add deploy_steps to baremetal node provisioning" 6 days ago
playbooks/devstack [tests] Improve devstack/post playbook efficiency 1 year ago
releasenotes Merge "Add deploy_steps to baremetal node provisioning" 6 days ago
tools Stop subclassing object 11 months ago
.coveragerc Fix coverage configuration and execution 5 years ago
.gitignore Merge tox, tests and other support files 4 years ago
.gitreview OpenDev Migration Patch 2 years ago
.mailmap Merge tox, tests and other support files 4 years ago
.stestr.conf Merge shade and os-client-config into the tree 3 years ago
.zuul.yaml Change nodepool job to build CentOS-8-stream (unblock gate) 4 months ago
CONTRIBUTING.rst fix "How To Contribute" url 2 years ago
HACKING.rst Fix some typos 2 years ago
LICENSE setting up the initial layout; move the api proposals to api_strawman 7 years ago
MANIFEST.in setting up the initial layout; move the api proposals to api_strawman 7 years ago
README.rst Improve README to provide example of Resource usage 4 weeks ago
SHADE-MERGE-TODO.rst Use discovery instead of config to create proxies 3 years ago
babel.cfg setting up the initial layout; move the api proposals to api_strawman 7 years ago
bindep.txt pypy is not checked at gate 3 years ago
create_yaml.sh Fix the network quota tests 4 years ago
docs-requirements.txt Add requirements.txt file for readthedocs 6 years ago
lower-constraints.txt Merge "Fix l-c testing for ubuntu focal" 7 months ago
post_test_hook.sh Update load_balancer for v2 API 4 years ago
requirements.txt Fix l-c testing for ubuntu focal 7 months ago
setup.cfg Drop python3.5 support 10 months ago
setup.py Small cleanups after Python2 drop 1 year ago
test-requirements.txt Apply pep8 import order style 1 month ago
tox.ini Merge "Apply import order in more tests" 2 weeks ago

README.rst

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:

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:

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

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:

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:

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:

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