Ian Wienand e0b417623d Add a __main__ handler, version command

Recently I've been querying what versions of openstacksdk are
installed in various environments, it would be handy to have a quick
way to see what's installed.  This adds a __main__ handler and a
single command "version" to print the full version (with git
reference).

Change-Id: I690f2987740c804735879985d19752c31490c7c9

2018-11-07 16:04:05 +11:00

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

Installation

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

$ pip install openstacksdk

To check the installed version you can call the module with :

$ python -m openstack version

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.

Configuration <config/index> Connect to an OpenStack Cloud <guides/connect> Connect to an OpenStack Cloud Using a Config File <guides/connect_from_config> Logging <guides/logging> Microversions <microversions> Baremetal <guides/baremetal> Block Storage <guides/block_storage> Clustering <guides/clustering> 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>

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.

The Cloud Abstraction layer has a data model.

model

Connection Interface

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

connection

Once you have a Connection instance, services are accessed through instances of ~openstack.proxy.Proxy or subclasses of it that exist as attributes on the ~openstack.connection.Connection.

Service Proxies

The following service proxies exist on the ~openstack.connection.Connection. The service proxies are all always present on the ~openstack.connection.Connection object, but the combination of your CloudRegion and the catalog of the cloud in question control which services can be used.

Baremetal <proxies/baremetal> Block Storage <proxies/block_storage> Clustering <proxies/clustering> 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 v2 <proxies/message_v2> Network <proxies/network> Object Store <proxies/object_store> Orchestration <proxies/orchestration> 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.

Baremetal <resources/baremetal/index> Block Storage <resources/block_storage/index> Clustering <resources/clustering/index> Compute <resources/compute/index> Database <resources/database/index> Identity <resources/identity/index> Image <resources/image/index> Key Management <resources/key_manager/index> Load Balancer <resources/load_balancer/index> Network <resources/network/index> Orchestration <resources/orchestration/index> Object Store <resources/object_store/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.

resource service_description utils

Presentations

multi-cloud-demo

4.7 KiB Raw Blame History