openstack/openstacksdk
Code Issues Proposed changes
Files
ea26149db97a820b51cf9c49dc0d0c6ef0d6f702
openstacksdk/doc/source/user/guides/connect_from_config.rst
Monty Taylor 40d425c595 Merge user and users sections of the docs 
The openstack doc standard location is 'user', so go with that.
Incorporate pages from the shade and occ docs into the appropriate
places in the user index file.

This still leaves user/logging and user/guide/logging which need to be
rationalized. That will come in the next commit, as it also needs to
actually rationalize the logging helper functions.

Remove the Makefile, as it's not used by things.

Change-Id: I26f36370ef9651f4bcaa7dee3b903309463d9592
2018-01-15 19:19:50 -06:00

2.2 KiB
Raw Blame History

Connect From Config

In order to work with an OpenStack cloud you first need to create a ~openstack.connection.Connection to it using your credentials. A ~openstack.connection.Connection can be created in 3 ways, using the class itself (see connect), a file, or environment variables as illustrated below. The SDK uses os-client-config to handle the configuration.

Create Connection From A File

Default Location

To create a connection from a file you need a YAML file to contain the configuration.

../../contributor/clouds.yaml

To use a configuration file called clouds.yaml in one of the default locations:

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

call :py~openstack.connection.from_config. The from_config function takes three optional arguments:

  • cloud_name allows you to specify a cloud from your clouds.yaml file.
  • cloud_config allows you to pass in an existing openstack.config.loader.OpenStackConfig` object.
  • options allows you to specify a namespace object with options to be added to the cloud config.

../examples/connect.py

../examples/connect.py

../examples/connect.py

Note

To enable logging, set debug=True in the options object.

User Defined Location

To use a configuration file in a user defined location set the environment variable OS_CLIENT_CONFIG_FILE to the absolute path of a file.:

export OS_CLIENT_CONFIG_FILE=/path/to/my/config/my-clouds.yaml

and call :py~openstack.connection.from_config with the cloud_name of the cloud configuration to use, .

Next

Now that you can create a connection, continue with the user_guides for an OpenStack service.