============
clouds2env
============
A tool to convert from an OpenStack ``clouds.yaml`` file to environment
variables. This can be useful when all you have is a ``clouds.yaml`` file but
you need to work with a legacy tool like *novaclient*.
Like *openstacksdk*, *clouds2env* will look in the following location for
``clouds.yaml`` files:
* ``.`` (the current directory)
* ``$HOME/.config/openstack``
* ``/etc/openstack``
The first file found wins.
You can also set the environment variable ``OS_CLIENT_CONFIG_FILE`` to an
absolute path of a file to look for and that location will be inserted at the
front of the file search list.
You can specify the cloud to generate environment variables for by setting the
``OS_CLOUD`` environment variable. Alternatively, you may provide the cloud
name as an argument to tool.
Usage
-----
.. code-block:: shell
$ clouds2env --help
usage: clouds2env [-h] [--set | --unset] [cloud]
A tool to convert from an OpenStack 'clouds.yaml' file to 'OS_'-prefixed
environment variables suitable for use with legacy tooling like novaclient.
positional arguments:
cloud the cloud to use
options:
-h, --help show this help message and exit
--set set environment variables (default)
--unset unset environment variables
Example
-------
.. code-block:: shell
$ export OS_CLOUD=devstack-admin
$ clouds2env
export OS_AUTH_URL=http://10.0.108.84/identity
export OS_PASSWORD=password
export OS_PROJECT_DOMAIN_ID=default
export OS_PROJECT_NAME=admin
export OS_USER_DOMAIN_ID=default
export OS_USERNAME=admin
export OS_IDENTITY_API_VERSION=3
export OS_REGION_NAME=RegionOne
export OS_VOLUME_API_VERSION=3
$ eval $(clouds2env)
MIT License
Copyright (c) 2022 Stephen Finucane <stephen@that.guru>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
