4bad718783
This is a large and invasive change to the underlying guts. Most casual use should not notice a difference, but advanced users, especially those using the Profile or Authenticator interfaces or making use of pluggable providers will be broken. The overall intent is to align directly on top of the mechanisms that came from os-client-config for config and to use keystoneauth1's Adapter interface to make use of the canonical implementations of such things as service and version discovery. The end goal is that openstacksdk provides the REST interaction layer for python-openstackclient, shade, Ansible and nodepool. Replace profile with openstack.config os-client-config is used by shade and python-openstackclient to read and process configuration. openstacksdk also can use the os-client-config interface, but translates it internally into the Profile object. As os-client-config has been injested into openstack.config, remove Profile and just use the config classes. Make proxy subclass of adapter This gives every service a generic passthrough for REST calls, which means we can map unknown service-type values to a generic proxy. Strip endpoint_filter We're passing Adapters around, not sessions. Doing so means that self.service and endpoint_filter have become unnecessary. Rename _Request.uri to _Request.url This is a stepping-stone to replacing _Request with requests.Request and using requests.Session.prepare_request inside of _prepare_request. Rename service proxy instances to match their official service-type. Aliases are kept for the old versions, but make the canonical versions match the official name. Rename bare_metal to baremetal Rename cluster to clustering Rename block_store to block_storage Rename telemetry to meter Create generic proxies for all services in STA Every service listed in service types authority is an OpenStack service. Even if we don't know about it in SDK, we should at the very least have a low-level Adapter for it so that people can use REST calls while waiting on the SDK to add higher-level constructs. The pypy jobs are happily green. Run them as voting rather than non-voting. Add syntatic sugar alias for making connections Typing: import openstack.connection conn = openstack.connection.Connection(cloud='example') is annoying. This allows: import openstack conn = openstack.connect(cloud='example') Use task_manager and Adapter from shade As a stepping-stone towards shade and sdk codepaths being rationalized, we need to get SDK using the Adapter from shade that submits requests into the TaskManager. For normal operation this is a passthrough/no-op sort of thing, but it's essential for high-volume consumers such as nodepool. This exposes a bunch of places in tests where we're mocking a bit too deeply. We should go back through and fix all of those via requests_mock, but that's WAY too much for today. This was a 'for later' task, but it turns out that the move to Adapter was causing exceptions to be thrown that were not the exceptions that were intended to be caught in the SDK layer, which was causing functional tests of things like GET operations to fail. So it became a today task. Change-Id: I7b46e263a76d84573bdfbbece57b1048764ed939
openstacksdk
openstacksdk is a client library for 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 a simple 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
openstack.cloud 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 Ansible. 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 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.
os-client-config was a library for collecting client
configuration for using an OpenStack cloud in a consistent and
comprehensive manner. In parallel, the python-openstacksdk team was
working on a library to expose the OpenStack APIs to developers in a
consistent and predictable manner. After a while it became clear that
there was value in both a high-level layer that contains business logic,
a lower-level SDK that exposes services and their resources as Python
objects, and also to be able to make direct REST calls when needed with
a properly configured Session or Adapter from python-requests. This led
to the merger of the three projects.
The contents of the shade library have been moved into
openstack.cloud and os-client-config has been moved in to
openstack.config. The next release of shade will be a thin
compatibility layer that subclasses the objects from
openstack.cloud and provides different argument defaults
where needed for compat. Similarly the next release of os-client-config
will be a compat layer shim around openstack.config.
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://developer.openstack.org/sdks/python/openstacksdk/users/config
openstack.cloud
Create a server using objects configured with the
clouds.yaml file:
import openstack.cloud
# Initialize and turn on debug logging
openstack.cloud.simple_logging(debug=True)
# Initialize cloud
# Cloud configs are read with openstack.config
cloud = openstack.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.
cloud.create_server(
'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)