deb-python-openstacksdk/doc/source/users/index.rst

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 <../glossary>.

Installation

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

$ pip install 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.

Connect to an OpenStack Cloud <guides/connect> Connect to an OpenStack Cloud Using a Config File <guides/connect_from_config> Logging <guides/logging> Bare Metal <guides/bare_metal> Block Store <guides/block_store> Cluster <guides/cluster> Compute <guides/compute> Database <guides/database> Identity <guides/identity> Image <guides/image> Key Manager <guides/key_manager> Message <guides/message> Network <guides/network> Object Store <guides/object_store> Orchestration <guides/orchestration> Telemetry <guides/telemetry>

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 profile, providing you with a set of higher-level interfaces to work with OpenStack services.

connection profile

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

Bare Metal <proxies/bare_metal> Block Store <proxies/block_store> Cluster <proxies/cluster> Compute <proxies/compute> Database <proxies/database> Identity v2 <proxies/identity_v2> Identity v3 <proxies/identity_v3> Image v1 <proxies/image_v1> Image v2 <proxies/image_v2> Key Manager <proxies/key_manager> Load Balancer <proxies/load_balancer_v2> Message v1 <proxies/message_v1> Message v2 <proxies/message_v2> Network <proxies/network> Metric <proxies/metric> Object Store <proxies/object_store> Orchestration <proxies/orchestration> Telemetry <proxies/telemetry> Workflow <proxies/workflow>

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.

Bare Metal <resources/bare_metal/index> Block Store <resources/block_store/index> Cluster <resources/cluster/index> Compute <resources/compute/index> Database <resources/database/index> Identity <resources/identity/index> Image <resources/image/index> Key Management <resources/key_manager/index> Metric <resources/metric/index> Network <resources/network/index> Orchestration <resources/orchestration/index> Object Store <resources/object_store/index> Telemetry <resources/telemetry/index> Workflow <resources/workflow/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 resource resource2 service_filter utils