/home/zuul/src/opendev.org/openstack/python-keystoneclient/.tox/docs/lib/python3.8/site-packages/keystoneauth1/fixture/discovery.py:docstring of keystoneauth1.fixture.discovery.DiscoveryList:1:duplicate object description of keystoneauth1.fixture.discovery.DiscoveryList, other instance in api/keystoneclient.fixture, use :noindex: for one of them
Change-Id: Id2722a1b275be88af6d0337684f1eb012b7f4ce1
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_pdf_link to link to PDF file.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Depends-On: https://review.opendev.org/729744
Change-Id: I311a5daa382dfca07e618eb6cbb3f44bd0502b02
Use sphinx-build so that the output happens in the right place.
Remove ChangeLog, instead link to the release notes.
Use apidoc for API doc building.
Fix main index page display so that title has higher level,
use link to OpenDev.
Change-Id: Iaa8d7f2143d411be31ad10b546455f18015566f3
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete section from setup.cfg: Wheel is not needed for
python 3 only repo
- Update requirements, no need for python_version anymore
- Remove future import from doc/source/conf.py
Change-Id: Ibf594171cea8f81cc4139b29cbdce54f6d5107a7
This patch adds a new tox job/command for building the pdf
version of documentation.
tox -epdf-docs
Change-Id: I0c0ef99190ea2a834bfdb47eb443b88a93bc802c
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Depends-On:https://review.opendev.org/#/c/660609/
Change-Id: I83ee2a89ae0a8158ed955581b738cea6ca93707d
This change is required to return 'request_id' from client
to log request_id mappings of cross-project requests.
Instantiating class 'keystoneclient.v3.client.Client' using
'include_metadata=True' will cause manager response to return
a new 'Response' class instead of just the data. This 'Response'
class is going to have additional metadata properties available
like 'request_ids' and the original data will be available as
property 'data' to it.
This change is backward compatible since user has to set a new
parameter 'include_metadata=True' to client in order to get the
request_id returned.
Co-author: Dinesh Bhor <dinesh.bhor@nttdata.com>
Partially Implements: blueprint return-request-id-to-caller
Change-Id: Ibefaa484158ff08bfcacc1e2802d87fc26fd76a5
Due to latest change in docs the old urls don't work and cause gate
failures. Fix it to reflect the new locations.
Also temporarily drop reference to keystoneauth1 to prevent circular
dependency. This reference will be brought back after keystoneauth1
docs get fixed.
Change-Id: I7e170275fd422345505b7282b52899d08c7a4172
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: If3a8f6668d0a4e32bd8a20330d973249ce6a5b46
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
In addition, changing Popen to check_output because
check_output() will raise CalledProcessError if the called process
returns a non-zero return code.
It also makes the code look much better.
Change-Id: If01f08216b4b252bd31029913e83fe945bf76866
Closes-Bug:#1693670
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: Ia6cdaf7fabd1c355df002aa07b0695610dde9cd1
Provide support for the domain-specific configuration storage available
via the REST API.
Domain configs are JSON blobs and we have fine grained control on them
via the Identity API. This fine grained control is not defined yet in the
client, though - for now, we can manage everything like Python dictionaries
and use operations like "update" whenever we want to delete a specific group
or option. This approach is similar to what is done in the federation mapping
API to handle mapping rules.
Functional tests are also included, this is useful to check if the new
feature works in an integration environment.
Co-Auhtored-By: Henry Nash <henryn@linux.vnet.ibm.com>
Co-Authored-By: Rodrigo Duarte <rduartes@redhat.com>
Closes-Bug: 1433306
Partially Implements: blueprint domain-config-ext
Change-Id: Ie6795b8633fed38c58b79250c11c9a045b7f95a4
Documentation build fails during packaging if Git repository is absent.
We do not package .git directory and that is why it leads to fails during
documentation build.
With this change we are certain that it will not fail.
This change was originally proposed by Davanum Srinivas (dims):
https://review.openstack.org/287448/
Change-Id: I49dce2537ea26c168af9a67d398930042702762c
There were a couple of references to the keystone CLI which doesn't
exist anymore. This was causing warnings when building the docs.
Change-Id: I75714b73884e832e95a62db2b48edf2adc2a0361
the CLI has been deprecated for a long time, and many docs and
install guides recommend using OSC instead of `keystone`.
- removes CLI
- removes man page from docs
- removes CLI tests
- removes `bootstrap` from contrib
- removes entrypoint from setup.cfg
implements bp: remove-cli
Change-Id: Icbe15814bc4faf33f513f9654440068795eae807
The developer docs should tell developers to use keystoneauth1
sessions rather than keystoneclient sessions or passing
arguments to the Client constructors. keystoneclient sessions and
constructing Clients using non-sessions is deprecated.
Change-Id: Ica19b8d6fb2f5d1a9d0d22d4fe08abb266fd6a86
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I53c21d6e8a9d23646c236ae33d652f1aefc20153
Closes-Bug: #1529836
To allow people to use a keystoneauth session with keystoneclient we
need to make it so that any exceptions that keystoneclient catch are the
same as what keystoneauth might throw.
The only practical way to do this is to map the keystoneclient
exceptions onto the keystoneauth equivalents. This is fairly easy as all
these exceptions were extracted from keystoneclient initially.
Closes-Bug: #1515048
Change-Id: I3b74b0ba1e1f9dda937a2d90e2d75ff0b7597a9b
currently there is no release history for keystoneclient, though
sometimes the commits are lacking context, this automated approach
is far better than nothing.
Change-Id: Ibb865b4830cbe1e2e99688103d26f1378d2c32b1
A common case is for Nova (or other service) to create a service
authentication plugin from a configuration file and then have many
greenlet threads that want to reuse that authentication. If a token
expires then many threads all try and fetch a new token to use and can
step over each other.
I was hoping for a way to put a lock in so that all plugins were thread
safe however fixing it for identity plugins solves almost all real world
situations and anyone doing non-identity plugins will have to manage
threads themselves.
Change-Id: Ib6487de7de638abc69660c851bd048a8ec177109
Closes-Bug: #1493835
These images were used to show how auth_token worked, these images
are now shown on keystonemiddleware's docs, so lets remove them
from here.
Change-Id: I2e882d3580737ee091a5e05cf98b0d652f3fefcb
In the using-api-v2.rst document, various inconsistencies in spelling of
"openstackDemo", as well as the password under the "Creating Tenants" and
"Creating Users" sections.
Updated service names to adhere to the OpenStack service naming conventions.
Fixed capitalization of "Client" to "client".
Change-Id: Ib20782f5b05f7097158f606c6562f92126650b89
Closes-Bug: #1458015
A temporary fix was added to get around a bug in how pbr handles
its autodoc_tree_index_modules setting. Since this bug is fixed we no
longer need the work around.
Change-Id: Id8274ef5c244bf50a34702ed9b4e50d3b82d8028
Closes-Bug: #1260495
Add links to identity service and keystone middleware to
the landing page. This indicates to the user that the
three projects are related.
Change-Id: I37bb4cd866524bad69f90c53e6a58d58202fc263
Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com>
Partial-Bug: #1428321
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f