summaryrefslogtreecommitdiff
path: root/README.rst
blob: fede1416e5f92608f5ca263904ef89aded3cffcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
================
os-client-config
================

.. image:: https://governance.openstack.org/tc/badges/os-client-config.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

.. warning::
  `os-client-config` has been superceded by `openstacksdk`_. While
  `os-client-config` will continue to exist, it is highly recommended that
  users transition to using `openstacksdk`_ directly.

`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

* If you have a config file, you will get the clouds listed in it
* If you have environment variables, you will get a cloud named `envvars`
* If you have neither, you will get a cloud named `defaults` with base defaults

Source
------

* Free software: Apache license
* Documentation: http://docs.openstack.org/os-client-config/latest
* Source: http://opendev.org/openstack/os-client-config
* Bugs: https://storyboard.openstack.org/#!/project/openstack/os-client-config
* Release Notes https://docs.openstack.org/releasenotes/os-client-config

.. _openstacksdk: http://docs.openstack.org/openstacksdk/latest