summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMonty Taylor <mordred@inaugust.com>2015-04-11 08:27:05 -0400
committerMonty Taylor <mordred@inaugust.com>2015-04-11 13:36:55 -0400
commit7e682d3bf097a006ec43c16ecc96664bf4b29294 (patch)
treeff93d4fc77133d58c2a30a2a092bc8c5293d1f5c /README.rst
parent2ac9258563a969283472fbde053850eccbc2fbf2 (diff)
downloados-client-config-7e682d3bf097a006ec43c16ecc96664bf4b29294.tar.gz
Put env vars into their own cloud config
The semantics around mixing environment variables and config file values are confusing at best and no reasonable usecase has been expressed as to why doing so is desirable. Move the logic around environment variable processing to always provide an "envvars" cloud if any envvars are set. The cloud will only exist in the presence of OS_ env vars. get_one_cloud() will default to returning the envvars cloud if it exists. Change-Id: I6c3a54997c3278feedfdf93cc4d1e74b6235700a Closes-Bug: #1439927
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 4c67acf..18bf81d 100644
--- a/README.rst
+++ b/README.rst
@@ -16,14 +16,13 @@ os-client-config honors all of the normal `OS_*` variables. It does not
provide backwards compatibility to service-specific variables such as
`NOVA_USERNAME`.
-If you have environment variables and no config files, os-client-config
-will produce a cloud config object named "openstack" containing your
-values from the environment.
+If you have OpenStack environment variables seet and no config files,
+os-client-config will produce a cloud config object named "envvars" containing
+your values from the environment.
Service specific settings, like the nova service type, are set with the
default service type as a prefix. For instance, to set a special service_type
-for trove (because you're using Rackspace) set:
-::
+for trove set::
export OS_DATABASE_SERVICE_TYPE=rax:database
@@ -40,7 +39,7 @@ locations:
The first file found wins.
The keys are all of the keys you'd expect from `OS_*` - except lower case
-and without the OS prefix. So, username is set with `username`.
+and without the OS prefix. So, region name is set with `region_name`.
Service specific settings, like the nova service type, are set with the
default service type as a prefix. For instance, to set a special service_type
@@ -119,6 +118,10 @@ behaviors:
* `cache.max_age` and nothing else gets you memory cache.
* Otherwise, `cache.class` and `cache.arguments` are passed in
+`os-client-config` does not actually cache anything itself, but it collects
+and presents the cache information so that your various applications that
+are connecting to OpenStack can share a cache should you desire.
+
::
cache: