watcher/doc/source
Taylor Peoples 9a6811ae6b Create OpenStackClients convenience class
The OpenStackClients class provides a convenient way to create and
cache client instances.  The idea behind this code comes from Magnum
[0].

The OpenStackClients class will act as the manager of other project's
clients, providing an easy way to fetch instances of said clients. This
will allow the clients to be cached.

An instance of OpenStackClients is created for every call that comes
into the decision engine and the applier, using the request context to
pass needed (domain id) parameters to get a Keystone session.  This
instance should be shared as much as possible to avoid additional
unneccessary connections to the other services.

This class will also allow for the version of each client to be
configurable via the watcher.conf file.

The method by which a Keystone session is also changed to use the
keystoneauth1.loading library.  In order to avoid DuplicateOptErrors
with the keystone_authtoken group used for the keystonemiddleware in the
API code, a new conf group named "watcher_clients_auth" is created.  A
typical configuration using a password authentication scheme will look
like:
  [watcher_clients_auth]
  auth_type = password
  auth_url = http://<server-ip>:<port>
  username = <username>
  password = <password>
  project_domain_id = default
  user_domain_id = default

[0]: https://github.com/openstack/magnum/blob/master/magnum/common/clients.py

DocImpact
Change-Id: Iab9d0b304099686da2e9e2b19e8b1de4332ff378
Implements: blueprint external-api-versioning
Closes-Bug: #1530790
Closes-Bug: #1539670
Closes-Bug: #1522774
2016-02-03 02:27:26 +01:00
..
deploy Create OpenStackClients convenience class 2016-02-03 02:27:26 +01:00
dev Merge "Added doc8" 2016-01-25 15:18:34 +00:00
image_src Update the user-guide to explain the main steps 2016-01-22 09:16:47 +01:00
images Update the user-guide to explain the main steps 2016-01-22 09:16:47 +01:00
man Added doc8 2016-01-22 15:56:47 +01:00
webapi Fix Warnings generated while building of HTML docu 2016-01-20 00:58:09 +01:00
architecture.rst Add diagrams to the architecture doc page 2016-01-20 07:23:03 +01:00
conf.py Fix HTML warnings on HTML doc 2016-01-25 11:23:28 +01:00
glossary.rst Fix HTML warnings on HTML doc 2016-01-25 11:23:28 +01:00
index.rst Re-organize the Wacher documentation Home Page 2016-01-22 14:19:41 +01:00