openstack/deb-sahara
Code Issues Proposed changes

adding developer docs guidelines about clients

Browse Source 
this change adds some brief documentation about the usage and creation
of OpenStack clients in sahara.

Change-Id: Ic41eed6c75c8b2aba67a3d17243ef17a52595bfa
Partial-Implements: blueprint keystone-sessions
This commit is contained in:
Michael McCune 2015-08-27 12:03:55 -04:00
parent a580ceb7f3
commit f15478dc21
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/devref/development.guidelines.rst
View File

@ -148,3 +148,19 @@ in module ``sahara/utils/cluster_progress_ops.py``.
.. note::
It's strictly recommended to use ``event_wrapper`` for events handling
OpenStack client usage guidelines
---------------------------------
The sahara project uses several OpenStack clients internally. These clients
are all wrapped by utility functions which make using them more convenient.
When developing sahara, if you need to use a OpenStack client you should
check the ``sahara.utils.openstack`` package for the appropriate one.
When developing new OpenStack client interactions in sahara, it is important
to understand the ``sahara.service.sessions`` package and the usage of
keystone ``Session`` and auth plugin objects(for example, ``Token`` or
``Password``). Sahara is migrating all clients to use this authentication
methodology, where available. For more information on using sessions with
keystone, please see
http://docs.openstack.org/developer/python-keystoneclient/using-sessions.html