openstack/openstacksdk
Code Issues Proposed changes
openstacksdk/doc/source/users/guides/connect.rst
Everett Toews 6b2cec41d1 A better create server example 
It's much more straight-forward for users to read a create server
example that does everything necessary to create the server
within the body of a single method. In this better example the user
doesn't have to refer to other examples to learn how to create a
server.

Change-Id: Iad7eef7946e93deb735fddcfbe39bbc8b56f507b
2015-11-02 16:17:44 -06:00

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