Files

Brian Curtin 8dcff5a621 Add logging functionality to openstack.utils

This change moves the ability to enable logging out of the
examples.common module and into the openstack.utils since it is
generally useful.

This is intended to give users a short-term solution to receive
debugging messages. If they want to always have our messages logged in
their application they should create their own logging handler(s) with
their own format, and that will cause our messages to be sent to their
handlers as they wish.
https://bugs.launchpad.net/python-openstacksdk/+bug/1418307 is open to
track the documentation aspect of this.

Change-Id: Ic8768d529d0389b9b04bd4ea31453a82f30faf33

2015-02-16 17:29:13 -06:00

2.9 KiB

Raw Blame History

Getting started with the OpenStack SDK

For a listing of terms used throughout the SDK, including the names of projects and services supported by it, see the Glossary.

Installation

The OpenStack SDK is available on PyPI under the name python-openstacksdk. To install it, use pip:

$ pip install python-openstacksdk

User Guides

These guides walk you through how to make use of the libraries we provide to work with each OpenStack service. If you're looking for a cookbook approach, this is where you'll want to begin.

Connecting to an OpenStack Cloud <userguides/usage> Working with data in the Object Store <userguides/object_store>

API Documentation

Service APIs are exposed through a two-layered approach. The classes exposed through our Connection interface are the place to start if you're an application developer consuming an OpenStack cloud. The Resource interface is the layer upon which the Connection is built, with Connection methods accepting and returning Resource objects.

Connection Interface

A Connection instance maintains your session, authentication, transport, and preferences, providing you with a set of higher-level interfaces to work with OpenStack services.

connection user_preference

Once you have a Connection instance, the following services may be exposed to you. Your user preferences determine the full set of exposed services, but listed below are the ones provided by this SDK by default.

Object Store <proxies/object_store>

Resource Interface

The Resource layer is a lower-level interface to communicate with OpenStack services. While the classes exposed by the Connection build a convenience layer on top of this, Resources can be used directly. However, the most common usage of this layer is in receiving an object from a class in the Connection layer, modifying it, and sending it back into the Connection layer, such as to update a resource on the server.

The following services have exposed Resource classes.

Compute <resources/compute/index> Database <resources/database/index> Network <resources/network/index> Object Store <resources/object_store/index>

Low-Level Classes

The following classes are not commonly used by application developers, but are used to construct applications to talk to OpenStack APIs. Typically these parts are managed through the Connection Interface, but their use can be customized.

session transport base_auth_plugin identity_base identity_v2 identity_v3 resource service_filter utils

2.9 KiB Raw Blame History