openstack/os-client-config
Code Issues Proposed changes
Unified config handling for client libraries and programs
28 Commits 1 Branch 86 Tags 4.1 MiB
Python 100%
cdb3e37ccd
Go to file
Jeremy Stanley cdb3e37ccd Workflow documentation is now in infra-manual 
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I97d11d3a24a374c9212cd29f49472e199b1c8bc0
2014-12-05 03:30:46 +00:00
doc/source Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
os_client_config Merge "Use yaml.safe_load instead of load." 2014-11-22 12:38:48 +00:00
.coveragerc Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
.gitignore Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
.gitreview Prep for move to stackforge 2014-09-22 09:01:40 -07:00
.mailmap Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
.testr.conf Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
HACKING.rst Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
LICENSE Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
MANIFEST.in Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
openstack-common.conf Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00
README.rst Add cache control settings 2014-10-10 15:25:53 -07:00
requirements.txt Remove babel and add pyyaml 2014-09-21 12:20:55 -07:00
setup.cfg Remove babel and add pyyaml 2014-09-21 12:20:55 -07:00
setup.py Port in config reading from shade 2014-09-21 12:17:09 -07:00
test-requirements.txt Remove babel and add pyyaml 2014-09-21 12:20:55 -07:00
tox.ini Initial Cookiecutter Commit. 2014-09-20 16:16:13 -07:00

README.rst

os-client-config

os-client-config is a library for collecting client configuration for using an OpenStack cloud in a consistent and comprehensive manner. It will find cloud config for as few as 1 cloud and as many as you want to put in a config file. It will read environment variables and config files, and it also contains some vendor specific default values so that you don't have to know extra info to use OpenStack

Environment Variables

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.

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: :

export OS_DATABASE_SERVICE_TYPE=rax:database

Config Files

os-client-config will look for a file called clouds.yaml in the following locations:

  • Current Directory
  • ~/.config/openstack
  • /etc/openstack

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.

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:

database_service_type: 'rax:database'

An example config file is probably helpful:

clouds:
  mordred:
    cloud: hp
    username: mordred@inaugust.com
    password: XXXXXXXXX
    project_id: mordred@inaugust.com
    region_name: region-b.geo-1
    dns_service_type: hpext:dns
  monty:
    auth_url: https://region-b.geo-1.identity.hpcloudsvc.com:35357/v2.0
    username: monty.taylor@hp.com
    password: XXXXXXXX
    project_id: monty.taylor@hp.com-default-tenant
    region_name: region-b.geo-1
    dns_service_type: hpext:dns
  infra:
    cloud: rackspace
    username: openstackci
    password: XXXXXXXX
    project_id: 610275
    region_name: DFW,ORD,IAD

You may note a few things. First, since auth_url settings are silly and embarrasingly ugly, known cloud vendors are included and may be referrenced by name. One of the benefits of that is that auth_url isn't the only thing the vendor defaults contain. For instance, since Rackspace lists rax:database as the service type for trove, os-client-config knows that so that you don't have to.

Also, region_name can be a list of regions. When you call get_all_clouds, you'll get a cloud config object for each cloud/region combo.

As seen with dns_service_type, any setting that makes sense to be per-service, like service_type or endpoint or api_version can be set by prefixing the setting with the default service type. That might strike you funny when setting service_type and it does me too - but that's just the world we live in.

Cache Settings

Accessing a cloud is often expensive, so it's quite common to want to do some client-side caching of those operations. To facilitate that, os-client-config understands a simple set of cache control settings.

cache:
  path: ~/.cache/openstack
  max_age: 300
clouds:
  mordred:
    cloud: hp
    username: mordred@inaugust.com
    password: XXXXXXXXX
    project_id: mordred@inaugust.com
    region_name: region-b.geo-1
    dns_service_type: hpext:dns

Usage

The simplest and least useful thing you can do is: :

python -m os_client_config.config

Which will print out whatever if finds for your config. If you want to use it from python, which is much more likely what you want to do, things like:

Get a named cloud. :

import os_client_config

cloud_config = os_client_config.OpenStackConfig().get_one_cloud(
    'hp', 'region-b.geo-1')
print(cloud_config.name, cloud_config.region, cloud_config.config)

Or, get all of the clouds. :: import os_client_config

cloud_config = os_client_config.OpenStackConfig().get_all_clouds() for cloud in cloud_config: print(cloud.name, cloud.region, cloud.config)