Unified SDK for OpenStack
Go to file
Artem Goncharov cb240b1308 Fix image create with tags
When passing tags to image create _make_v2_image_params will cast tags
to string, while those should remain list. This is required to complete
switch in OSC from glanceclient to SDK.
Since we use TagMixin remove tags property from resource (it's anyway
there).

Change-Id: I4f068dfafe4bc85ddda6dbc716dffa0c316500f6
2019-09-17 16:01:59 +02:00
devstack Finish updating links to point to opendev 2019-04-21 12:31:44 +00:00
doc Rework statistics reporting 2019-08-26 15:15:25 +02:00
examples Update links 2019-07-30 07:15:55 +02:00
extras Merge "Add ansible functional tests" 2018-05-30 17:09:03 +00:00
openstack Fix image create with tags 2019-09-17 16:01:59 +02:00
playbooks/devstack Finish updating links to point to opendev 2019-04-21 12:31:44 +00:00
releasenotes Merge "Rework statistics reporting" 2019-08-30 09:32:33 +00:00
tools Fix the conflict of urlparse between python2 and python3 2018-10-31 17:00:42 +08: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 OpenDev Migration Patch 2019-04-19 19:47:46 +00:00
.mailmap Merge tox, tests and other support files 2017-10-04 14:51:08 -05:00
.stestr.conf Merge shade and os-client-config into the tree 2017-11-15 09:03:23 -06:00
.zuul.yaml Add Python 3 Train unit tests 2019-07-05 14:34:50 -04: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 Finish updating links to point to opendev 2019-04-21 12:31:44 +00: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
lower-constraints.txt Bump keystoneauth1 minimum to 3.16.0 2019-08-13 12:09:30 -05: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 Move the history lesson into the docs 2019-08-01 10:14:21 -04:00
requirements.txt Bump keystoneauth1 minimum to 3.16.0 2019-08-13 12:09:30 -05:00
setup.cfg Update links 2019-07-30 07:15:55 +02:00
setup.py Updated from global requirements 2017-03-02 11:55:11 +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 Make factory for a CloudRegion from CONF objects 2019-06-04 08:36:23 -05:00
tox.ini Enable ansible module test for keypair to check return data 2019-08-03 20:57:22 +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 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.

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

openstack

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

import openstack

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

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

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

Cloud Layer

openstacksdk contains a higher-level layer based on logical operations.

import openstack

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

for server in conn.list_servers():
    print(server.to_dict())

The benefit is mostly seen in more complicated operations that take multiple steps and where the steps vary across providers:

import openstack

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

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

openstack.config

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:

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

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 https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html

Links