openstack/openstacksdk
Code Issues Proposed changes
Files
ed5d3570f7fd14b9ba007fc37e10a2387dab7893
openstacksdk/doc/source/users/guides/connect_from_config.rst
Matthew Edmonds 6f2209e238 Clarify argparse connections 
The user guide shows that options passed to connection.from_config do
not have to be an argparse Namespace, contrary to the comments in
connection.from_config. This change corrects those comments and adds
a user guide example showing how argparse may be used.

Change-Id: I2a9e92cbf0aab16476001be772034e9698a24c9f
Closes-Bug: #1629331
2016-10-03 09:49:49 -04:00

2.4 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.

Note

To get your credentials Download the OpenStack RC file.

Create Connection From A File

Default Location

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

../../contributors/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 os_client_config.config.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.