openstack/openstacksdk
Code Issues Proposed changes
openstacksdk/doc/source/user/guides/connect.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

1.3 KiB
Raw Blame History

Connect

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, config-clouds-yaml, or config-environment-variables. It is recommended to always use config-clouds-yaml as the same config can be used across tools and languages.

Create Connection

To create a ~openstack.connection.Connection instance, use the ~openstack.connect factory function.

../examples/connect.py

Full example at connect.py

Note

To enable logging, see the logging user guide.

Next

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

As an alternative to creating a ~openstack.connection.Connection using :ref:config-clouds-yaml, you can connect using config-environment-variables.