bb8b4bf5a5
While we should not start using this for cloning things in the gate yet, the opendev.org links provide for a nicer browsing experience already even though the service is in beta. Go ahead and swap our browsing links. While in there, remove some masakari references to github links to the source code. Masakari now publishes api docs to developer.openstack.org so there is no need to point people to source code for api docs. Change-Id: I14afa3476f9832ef433ec744e888348fc9a359e3
33 lines
1.1 KiB
ReStructuredText
33 lines
1.1 KiB
ReStructuredText
Connect
|
|
=======
|
|
|
|
In order to work with an OpenStack cloud you first need to create a
|
|
:class:`~openstack.connection.Connection` to it using your credentials. A
|
|
:class:`~openstack.connection.Connection` can be
|
|
created in 3 ways, using the class itself, :ref:`config-clouds-yaml`, or
|
|
:ref:`config-environment-variables`. It is recommended to always use
|
|
:ref:`config-clouds-yaml` as the same config can be used across tools and
|
|
languages.
|
|
|
|
Create Connection
|
|
-----------------
|
|
|
|
To create a :class:`~openstack.connection.Connection` instance, use the
|
|
:func:`~openstack.connect` factory function.
|
|
|
|
.. literalinclude:: ../examples/connect.py
|
|
:pyobject: create_connection
|
|
|
|
Full example at `connect.py <https://opendev.org/openstack/openstacksdk/src/branch/master/examples/connect.py>`_
|
|
|
|
.. note:: To enable logging, see the :doc:`logging` user guide.
|
|
|
|
Next
|
|
----
|
|
Now that you can create a connection, continue with the :ref:`user_guides`
|
|
to work with an OpenStack service.
|
|
|
|
.. TODO(shade) Update the text here and consolidate with the old
|
|
os-client-config docs so that we have a single and consistent explanation
|
|
of the envvars cloud, etc.
|