Improve Connection docs for use with Keystone v3

Bug #1715628 reported by Brian Curtin
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack SDK
Confirmed
High
Brian Curtin

Bug Description

There are two separate but related improvements that should be made here:

1. Code examples, such as in doc/source/users/guides/connect.rst or in README.rst that shows up in PyPI, should be using Keystone v3. A lot of people get tripped up trying to auth to v3 without arguments like project_domain_id.

2. The Connection API docs should better explain that the arguments it takes are passed off to KSA and then link directly to said arguments. For example, password auth seems to be the most commonly used, and the true source of those arguments are at https://docs.openstack.org/keystoneauth/latest/api/keystoneauth1.identity.v3.html#keystoneauth1.identity.v3.PasswordMethod —we should find a good way to link straight to that and the other auth methods.

Changed in python-openstacksdk:
status: New → Confirmed
importance: Undecided → High
assignee: nobody → Brian Curtin (brian.curtin)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.