From: spisarski Date: Wed, 26 Jul 2017 21:20:53 +0000 (-0600) Subject: Updated docs for the OSCreds class X-Git-Tag: opnfv-5.0.0~37 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F27%2F38227%2F1;p=snaps.git Updated docs for the OSCreds class JIRA: SNAPS-122 Change-Id: Id57f8830f7e87c513179de307130c76cb28f22a8 Signed-off-by: spisarski --- diff --git a/docs/how-to-use/LibraryUsage.rst b/docs/how-to-use/LibraryUsage.rst index 0a137ba..353891e 100644 --- a/docs/how-to-use/LibraryUsage.rst +++ b/docs/how-to-use/LibraryUsage.rst @@ -31,7 +31,7 @@ attributes are listed below: - project\_name (aka. tenant\_name) - identity\_api\_version (for obtaining Keystone authorization token. Versions 2.0 & v3 only validated.) -- image\_api\_version (Glance version 1 currently only validated) +- image\_api\_version (Glance version 1 & 2 only validated) - network\_api\_version (Neutron version 2 currently only validated) - compute\_api\_version (Nova version 2 currently only validated) - heat\_api\_version (Heat version 1 currently only validated) @@ -39,6 +39,7 @@ attributes are listed below: - project\_domain\_id (default='default') - interface (default='admin', used to specify the endpoint type for keystone: public, admin, internal) - cacert (default=False, expected values T|F to denote server certificate verification, else value contains the path to an HTTPS certificate) +- region_name (The region name default=None) - proxy\_settings - host (the HTTP proxy host) diff --git a/snaps/openstack/os_credentials.py b/snaps/openstack/os_credentials.py index 3054478..0cecfa5 100644 --- a/snaps/openstack/os_credentials.py +++ b/snaps/openstack/os_credentials.py @@ -42,8 +42,8 @@ class OSCreds: clients :param heat_api_version: The OpenStack's API version to use for Heat clients - :param user_domain_id: Used for v3 APIs - :param project_domain_id: Used for v3 APIs + :param user_domain_id: Used for v3 APIs (default='default') + :param project_domain_id: Used for v3 APIs (default='default') :param interface: Used to specify the endpoint type for keystone as public, admin, internal :param proxy_settings: instance of os_credentials.ProxySettings class