Files

Brian Curtin 9b2729cdd5 Build up user documentation section

This change creates a section of the documentation focused on users,
holding the guides, API docs, etc. Another change will focus on
documentation for contributors.

* Installation details were moved straight into the user index.
  Installation details for contributors will go into that section.
* The old usage.rst section was moved into the userguides/ section and
  will grow into a Connection guide in another change.
* The sections were organized according top to bottom in order of
  likelihood of utility to users. The guides will help people get
  started, the API docs will help them go from there, and anyone needing
  to customize lower-level things will have already scrolled through the
  preceeding sections to get to the end.
* In order to see how the Resource docs turn out to be organized, I
  added pages for Compute and Database resources. We'll need to add them
  for every service, but I didn't want to overload this change with all
  of those additions.
* Since glossary isn't linked in a TOC anywhere, just mentioned
  explicitly at the beginning of the user section, I added an exclude
  for it in the conf.py. It still gets built, but that allows it to not
  become a warning for being left out of TOCs.

Change-Id: If9d1e4726ed14d5b7592c9da00c27591d2a4291c
Partial-Bug: 1416553

2015-02-05 14:22:44 -06:00

2.8 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> 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

2.8 KiB Raw Blame History