openstack/deb-python-openstacksdk
Code Issues Proposed changes
Files
15ec17a6450f47a44176345b7ea3a4175481c5c5
deb-python-openstacksdk/doc/source/users/guides/connect.rst
Everett Toews 7e98020b83 The Compute User Guide 
The beginning of the compute user guide.

This also begins the simplification of the examples, makes them
more specific, and adds testing.

Change-Id: Ic4bac2fe30601c196b03ce73b2dd04a916231f33
Partial-Bug: #1487269
Partial-Bug: #1419012
Partial-Bug: #1466180
2015-10-01 21:50:49 -05:00

1.8 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, a file, or environment variables. If this is your first time using the SDK, we recommend simply using the class itself as illustrated below.

Note

To get your credentials Download the OpenStack RC file.

Create Connection

To create a connection you need a ~openstack.profile.Profile and a ~openstack.connection.Connection.

../examples/connect.py

The ~openstack.profile.Profile sets your preferences for each service. You will pass it the region of the OpenStack cloud that this connection will use.

The ~openstack.connection.Connection is a context for a connection to an OpenStack cloud. You will primarily use it to set the ~openstack.profile.Profile and authentication information with the auth_args parameter. You can also set the user_agent to something that describes your application (e.g. my-web-app/1.3.4).

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 the class itself, you can connect using a file or environment variables. See the connect_from_config user guide.