summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2015-10-14 12:32:20 -0400
committerMonty Taylor <mordred@inaugust.com>2015-10-14 12:32:20 -0400
commitf6681a83192386fcf27479c820998691a43e8b79 (patch)
treecd3190f04f85f2257046164a5fca807fb6d01fb4
parent6113d037f6240666e3c958db6e83a242e7c8531d (diff)
downloados-client-config-f6681a83192386fcf27479c820998691a43e8b79.tar.gz
Fix documentation around regions
It turns out region_name is an important parameter - it's not just another kwarg that will get passed through. Change-Id: I5cca8d324a1dcd1355991df793fe29eedfa15dc0
-rw-r--r--README.rst2
-rw-r--r--os_client_config/config.py1
2 files changed, 2 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 7b737b9..b0466f7 100644
--- a/README.rst
+++ b/README.rst
@@ -247,7 +247,7 @@ Get a named cloud.
import os_client_config
cloud_config = os_client_config.OpenStackConfig().get_one_cloud(
- 'hp', 'region-b.geo-1')
+ 'hp', region_name='region-b.geo-1')
print(cloud_config.name, cloud_config.region, cloud_config.config)
Or, get all of the clouds.
diff --git a/os_client_config/config.py b/os_client_config/config.py
index 6d37835..bff2f5c 100644
--- a/os_client_config/config.py
+++ b/os_client_config/config.py
@@ -551,6 +551,7 @@ class OpenStackConfig(object):
An argparse Namespace object; allows direct passing in of
argparse options to be added to the cloud config. Values
of None and '' will be removed.
+ :param region_name: Name of the region of the cloud.
:param kwargs: Additional configuration options
:raises: keystoneauth1.exceptions.MissingRequiredOptions