409f1683c4
Considering the path to the guides is doc/source/users/userguides, the extra user in userguides looks weird and unnecessary. Change-Id: I57c94907e150de2d9de28ed8073e20b494203c97
138 lines
3.9 KiB
ReStructuredText
138 lines
3.9 KiB
ReStructuredText
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 :doc:`glossary <../glossary>`.
|
|
|
|
Installation
|
|
------------
|
|
|
|
The OpenStack SDK is available on
|
|
`PyPI <https://pypi.python.org/pypi/openstacksdk>`_ 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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Connecting to an OpenStack Cloud <guides/usage>
|
|
Logging <guides/logging>
|
|
Block Store <guides/block_store>
|
|
CDN <guides/cdn>
|
|
Compute <guides/compute>
|
|
Database <guides/database>
|
|
Identity <guides/identity>
|
|
Image <guides/image>
|
|
Key Management <guides/key_management>
|
|
Metric <guides/metric>
|
|
Network <guides/network>
|
|
Object Store <guides/object_store>
|
|
Orchestration <guides/orchestration>
|
|
Telemetry <guides/telemetry>
|
|
|
|
It may also be useful to try out some working code examples:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
examples
|
|
|
|
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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Block Store <proxies/block_store>
|
|
CDN <proxies/cdn>
|
|
Compute <proxies/compute>
|
|
Database <proxies/database>
|
|
Identity <proxies/identity>
|
|
Image <proxies/image>
|
|
Key Management <proxies/key_management>
|
|
Metric <proxies/metric>
|
|
Network <proxies/network>
|
|
Object Store <proxies/object_store>
|
|
Orchestration <proxies/orchestration>
|
|
Telemetry <proxies/telemetry>
|
|
|
|
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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
Block Store <resources/block_store/index>
|
|
Compute <resources/compute/index>
|
|
Database <resources/database/index>
|
|
Identity <resources/identity/index>
|
|
Image <resources/image/index>
|
|
Key Management <resources/key_management/index>
|
|
Metric <resources/metric/index>
|
|
Network <resources/network/index>
|
|
Orchestration <resources/orchestration/index>
|
|
Object Store <resources/object_store/index>
|
|
Telemetry <resources/telemetry/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.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
session
|
|
transport
|
|
base_auth_plugin
|
|
identity_base
|
|
identity_v2
|
|
identity_v3
|
|
module_loader
|
|
resource
|
|
service_filter
|
|
utils
|