summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* 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
* | Merge "Fixe example code in Using Sessions page"Jenkins2015-05-281-2/+3
|\ \ | |/ |/|
| * Fixe example code in Using Sessions pageDhritiShikhar2015-05-271-2/+3
| | | | | | | | | | | | | | | | | | | | * Changes the auth_url to use /v3 * Adds the user_domain_id argument Co-Authored-By: Rodrigo Duarte Sousa <rodrigods@lsd.ufcg.edu.br> Closes-bug: 1428309 Change-Id: I8471d9fbbd4d14cbb60395f90e8e61b9ed9f7d3b
* | Removes temporary fix for doc generationDavid Stanek2015-05-071-10/+0
|/ | | | | | | | | 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
* Crosslink to other sites that are owned by KeystoneDave Chen2015-03-141-0/+9
| | | | | | | | | | 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
* Merge "Workflow documentation is now in infra-manual"Jenkins2015-02-101-1/+1
|\
| * Workflow documentation is now in infra-manualJeremy Stanley2015-02-051-1/+1
| | | | | | | | | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f
* | Merge "Fix up types within API documentation"Jenkins2015-01-181-0/+6
|\ \
| * | Fix up types within API documentationJamie Lennox2014-12-161-0/+6
| |/ | | | | | | | | | | | | | | Correct the type signature of some API documentation. Add inter-sphinx mapping to documentation to provide links to external docs. Correct some phrases and errors. Change-Id: Id4a71a9901e5adc695afed656e3bc84e4e54e67a
* | Add generic auth plugin documentationJamie Lennox2015-01-141-0/+28
| | | | | | | | | | | | | | Add some documentation regarding the existence of generic plugins. Those that can be used against the v2 or v3 APIs. Change-Id: Ie52f0653e20cbc9338481f874aaefa4cdee97116
* | Merge "Document the auth plugins that are loadable by name"Jenkins2014-12-311-0/+16
|\ \
| * | Document the auth plugins that are loadable by nameJamie Lennox2014-12-171-0/+16
| |/ | | | | | | | | | | | | | | | | | | | | These are the plugins that will be available for use by auth_token middleware and other services as they adopt sessions. There needs to be a good way to document the config parameters that each plugin exposes, because these are not necessarily the same as what are available via __init__. Change-Id: I4ad8ea89381be7571c8a30a6fcd9162c259eb581
* | Merge "Document session usage first"Jenkins2014-12-161-24/+30
|\ \ | |/ |/|
| * Document session usage firstBrant Knudson2014-10-121-24/+30
| | | | | | | | | | | | | | Since we'd prefer developers to use the session method when constructing the Client instance, document it first. Change-Id: I8998a9962fd541bafae32b3443d7d4767da74257
* | Merge "Rename the client API docs"Jenkins2014-12-022-6/+6
|\ \
| * | Rename the client API docsBrant Knudson2014-10-122-7/+7
| |/ | | | | | | | | | | | | | | | | | | Since developers want to use the APIs, the docs should be more enticing and say that it describes how to use the APIs. Also, called it "V3 Client API" since this reads better than "Client V3 API" and it matches the order in the module path. Change-Id: I79dd6f6891bf48b477b35157256a0219426d171c
* | Merge "Warn that keystone CLI is pending deprecation"Jenkins2014-12-021-3/+11
|\ \
View Lorry Controller Status