summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge "remove unicode from code"Zuul2022-04-222-3/+3
|\
| * remove unicode from codezhangtongjian2022-04-192-3/+3
| | | | | | | | Change-Id: I2d2d025b0d8bda2ffc7be4d30489728c05f53c8e
* | Fix doc error to unblock the gateRadomir Dopieralski2021-10-141-0/+1
|/ | | | | | /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 newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-202-7/+8
| | | | | | | | | | | | | | | | | | | | | 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
* Fix docs publishingAndreas Jaeger2020-04-154-7/+15
| | | | | | | | | | | | 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
* Cleanup py27 supportussuri-em4.0.0Andreas Jaeger2020-04-041-2/+0
| | | | | | | | | | | | | 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
* [ussuri][goal] Drop python 2.7 support and testingVishakha Agarwal2020-01-221-2/+1
| | | | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in ussuri cycle. python-keystoneclient is ready with python 3 and ok to drop the python 2.7 support. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: Ib6b6f7ca394dfa78cd5c8aeac0941dd625efef3b
* Generate pdf documentationVishakha Agarwal2019-09-041-4/+15
| | | | | | | | | This patch adds a new tox job/command for building the pdf version of documentation. tox -epdf-docs Change-Id: I0c0ef99190ea2a834bfdb47eb443b88a93bc802c
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-08-012-17/+1
| | | | | | | | | | | | | | 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
* Blacklist bandit 1.6.0 & cap sphinx for 2.7Vishakha Agarwal2019-07-041-1/+2
| | | | | | | | | | | | The latest version of bandit has broken directory exclusion, so multiple test files are getting flagged. This change blocks version 1.6.0 while this issue is fixed for 1.6.1. This change also caps sphinx at <2.0.0 for python version 2.7. This also updates the keyring version. Change-Id: I69a86ef21791698e4dd749fe5640fcdc7df1b0fc
* Merge "Add Response class to return request-id to caller"Zuul2018-10-191-0/+25
|\
| * Add Response class to return request-id to callerDavid Stanek2018-03-261-0/+25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
|/ | | | Change-Id: I50a3011c302fb5568da8f57e2f5c354d1afb3a94
* Updated from global requirementsOpenStack Proposal Bot2018-02-171-1/+1
| | | | Change-Id: I881fca9b06f551fd26b37fdb43502a71da8ffec8
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | | | Change-Id: I748fadaececc4c5fe67ab6d671f13ce4ea964049 I44f2950a092bc03bdd0a9976242689a8f198b07a I5f4dccaef48902bb4a5e6eab304c76cc5dbb258d
* Create doc/requirements.txtQinglinCheng2017-12-191-0/+10
| | | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html Refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html Change-Id: Iaa1530f19049883fc9fbce66f1fcc82ded559a07
* Update URLs in documents according to document migrationmelissaml2017-07-141-2/+2
| | | | Change-Id: Ie0a8594f2dd0554a07111207899e6134affc998e
* Merge "Bring back intersphinx reference to keystoneauth"Jenkins2017-07-061-1/+2
|\
| * Bring back intersphinx reference to keystoneauthBoris Bobrov2017-07-051-1/+2
| | | | | | | | | | Change-Id: I0b1d1a4abdf919dd403679565cde046a825898fa Depends-On: I2a4fc6a4782a5496b2ab4a8355ed2c3b6dac58fa
* | Merge "Switch from oslosphinx to openstackdocstheme"Jenkins2017-07-061-10/+8
|\ \
| * | Switch from oslosphinx to openstackdocsthemeVan Hung Pham2017-06-301-10/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge "Change locations of docs for intersphinx"Jenkins2017-07-051-2/+1
|\ \ \ | |/ / |/| / | |/
| * Change locations of docs for intersphinxBoris Bobrov2017-07-051-2/+1
| | | | | | | | | | | | | | | | | | | | | | 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
* | Fix html_last_updated_fmt for Python3Vu Cong Tuan2017-06-061-2/+1
|/ | | | | | | | | | | | | | 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
* Use https for *.openstack.org referencesEric Brown2017-02-052-6/+6
| | | | | | | 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
* Merge "Removes unnecessary utf-8 encoding"Jenkins2017-01-131-2/+0
|\
| * Removes unnecessary utf-8 encodingji-xuepeng2017-01-131-2/+0
| | | | | | | | Change-Id: Ide4cb14246394522e35929cf08978aaf5fa9eb59
* | Support domain-specific configuration managementHenry Nash2016-11-021-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | [doc] remove auth plugin docsSteve Martinelli2016-10-192-245/+0
|/ | | | | | | | | this is an out of date version that is posted on the keystoneauth docs [1] [1] http://docs.openstack.org/developer/keystoneauth/authentication-plugins.html Change-Id: Ia203bfbd5717c96380b599d1b5985377f6c979f7
* import warnings in doc/source/conf.pyCorey Bryant2016-05-311-0/+1
| | | | | Change-Id: If14c02e156f7fe6884ad8de4b80869b2d01de4d7 Closes-Bug: 1587625
* Fallback if Git repository is absentIvan Udovichenko2016-04-271-2/+6
| | | | | | | | | | | | 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
* Remove doc references to the keystone CLIBrant Knudson2016-03-111-3/+1
| | | | | | | 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
* remove CLI from keystoneclientSteve Martinelli2016-03-102-162/+1
| | | | | | | | | | | | | | | 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
* Merge "Update developer docs for keystoneauth session"Jenkins2016-03-013-17/+26
|\
| * Update developer docs for keystoneauth sessionBrant Knudson2016-02-283-17/+26
| | | | | | | | | | | | | | | | | | 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
* | Merge "Fix reference to ClientException"Jenkins2016-02-291-2/+1
|\ \
| * | Fix reference to ClientExceptionBrant Knudson2016-02-281-2/+1
| |/ | | | | | | | | | | keystoneclient doesn't use apiclient exceptions anymore. Change-Id: I7a5a732a9f3a2162d8c4b4083ee9a9c7d90e9e0d
* | Correct test running instructionsBrant Knudson2016-02-281-1/+1
|/ | | | | | To run the tests just do `tox`. Change-Id: Ibe61e63c1d7b3a1b1dd3186ae5930a67fdba9ed3
* Fix for the deprecated library functionYatin Kumbhare2016-01-051-2/+5
| | | | | | | | os.popen() is deprecated since version 2.6. Resolved with use of subprocess module. Change-Id: I53c21d6e8a9d23646c236ae33d652f1aefc20153 Closes-Bug: #1529836
* Map keystoneclient exceptions to keystoneauthJamie Lennox2015-11-191-0/+2
| | | | | | | | | | | | | 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
* Add missing end single quoteHidekazu Nakamura2015-11-111-1/+1
| | | | | | End single quote of is missing. This patch add it. Change-Id: Ibabde8922d97e1d30f7130574080f56ccb8d6be9
* Merge "Fix typo that says V3 token only works for v2"Jenkins2015-10-161-1/+1
|\
| * Fix typo that says V3 token only works for v2Steve Martinelli2015-10-151-1/+1
| | | | | | | | | | | | The V3 token plugin should work for v3 identity service Change-Id: Ic3c53dd94e1fe5d1ab69a02a7f7469735ee4c978
* | auto-generate release historySteve Martinelli2015-10-152-0/+9
|/ | | | | | | | 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
* Identity plugin thread safetyJamie Lennox2015-09-101-0/+7
| | | | | | | | | | | | | | | | 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
* Merge "Fixes modules index generated by Sphinx"Jenkins2015-07-131-1/+1
|\
| * Fixes modules index generated by SphinxDavid Stanek2015-07-081-1/+1
| | | | | | | | | | | | | | Sphinx was always using (k)eystoneclient for the prefix so the index wasn't very useful. Change-Id: I9f883e1005874b5f5019f9030b94174a2169ed77
* | Remove unused images from docsSteve Martinelli2015-06-282-101/+0
|/ | | | | | | | 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
* Merge "Fixed grammatical errors in the V2 Client API doc"1.5.0Jenkins2015-05-281-5/+5
|\
| * Fixed grammatical errors in the V2 Client API docMichael Simo2015-05-271-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
View Lorry Controller Status