summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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-073-58/+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
* Merge "Don't autodoc the test suite"Jenkins2015-04-021-1/+3
|\
| * Don't autodoc the test suiteJamie Lennox2015-03-091-1/+3
| | | | | | | | | | | | | | | | Don't build API documentation for the keystoneclient tests. These are not public functions, pollute the existing docs, and extend the time required to build docs. Change-Id: I1206a808272d19b342d26f5117aedafb476d0994
* | 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
|\ \
| * | Warn that keystone CLI is pending deprecationBrant Knudson2014-10-121-3/+11
| |/ | | | | | | | | | | | | | | | | The keystone CLI is pending deprecation so warn about it in the developer docs. DocImpact Change-Id: Ibca9d4cd8d31a62ee1ec7f24671c8f0f01ca9f7f
* | Merge "Remove middleware architecture doc"Jenkins2014-12-022-429/+0
|\ \
| * | Remove middleware architecture docBrant Knudson2014-11-192-429/+0
| | | | | | | | | | | | | | | | | | | | | | | | The auth_token middleware was moved to the keystonemiddleware repo and the middleware architecture doc was copied there. The copy in the client repo can be removed. Change-Id: Ic7b7f970a08746dd4f5d61dd5144c1dae168ad6d
* | | Merge "Correct typos in man page"Jenkins2014-11-241-2/+2
|\ \ \ | |/ / |/| |
| * | Correct typos in man pageBrant Knudson2014-10-151-2/+2
| |/ | | | | | | | | | | A couple of typos in the keystone man page are corrected. Change-Id: I5931c1f128c5199c87317740abe1ee76b2c18489
* | Merge "Reorder index links"Jenkins2014-11-181-4/+2
|\ \
| * | Reorder index linksBrant Knudson2014-10-101-4/+2
| |/ | | | | | | | | | | | | The V3 Client link should come before the V2 Client link if that's what we want developers to use. Change-Id: I34a232d21862999a6f1a7acf5382ff752a7e3590
* | Merge "Correct typos in using-sessions"Jenkins2014-10-272-6/+6
|\ \
| * | Correct typos in using-sessionsBrant Knudson2014-10-122-6/+6
| |/ | | | | | | | | | | Fixed typos in using-sessions. Change-Id: Id931bfdb8eb8bf214ca538673e727c6bf1e06280
* | Doc cleanup, make concepts linksBrant Knudson2014-10-121-11/+12
|/ | | | | | | Rather than just mention the concepts, make each reference a link to the concept's representation in the API. Change-Id: I4dadca0395784eb43e5bbb3cfd65c56c8f56ed38
* Stop using intersphinxAndreas Jaeger2014-09-131-5/+0
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Remove intersphinx mappingsJamie Lennox2014-08-071-4/+1
| | | | | | | | | | | | None of our documentation references any external sphinx documents so we don't need the intersphinx mappings. This started as a rename from the old glance.openstack.org site to the newer docs.openstack.org/developer/glance however they may as well be removed if not used. Closes-Bug: #1353817 Change-Id: I638c4eeab7d01ec2f26a0d9d532f0006f4f75e72
* Merge "Add docs for how to create an OAuth auth instance"Jenkins2014-08-051-0/+20
|\
| * Add docs for how to create an OAuth auth instanceSteve Martinelli2014-08-041-0/+20
| | | | | | | | | | | | | | | | Similar to the other authentication methods that were documented, like password and token, this patch will add a brief description on how to authenticate with the oauth1 plugin. Change-Id: I1b7cceb116d337be71576139601f34ca17563a50
* | Merge "Add an example of using v3 client with sessions"Jenkins2014-07-301-0/+20
|\ \
| * | Add an example of using v3 client with sessionsSteve Martinelli2014-07-241-0/+20
| |/ | | | | | | | | | | | | | | | | Added a bit more information to the 'using-api-v3' section, about using sessions instead of passing in arguments. This overlaps with what is documented in 'using-sessions' but I think it's still handy as most folks will likely go here first. Change-Id: I352bda49e01362d3a5da9a79ceb34748552ef9ec
* | Use oslosphinx to generate doc themeSteve Martinelli2014-07-2412-1230/+5
|/ | | | | | | Since oslosphinx is out, let's use it instead of hosting our own themes and static files. Change-Id: I5b507d35c90d0c0411d7751935b0e53328ca9311
* Document authentication pluginsJamie Lennox2014-07-022-0/+174
| | | | | | | | Explain the plugins that are provided and some information on how to write new ones. This will obviously need to be expanded as more features are added. Change-Id: Ie67e93f2ed994c3702ac66e388cf216609dd44ff
* Correcting using-api-v2.rstMichael McCune2014-06-261-1/+1
| | | | | | | | Changes * removed extraneous word from Introduction section Closes-Bug: #1334915 Change-Id: I201ddb70a4d91e0d615e322abc43848993dee573
* Merge "Session Documentation"Jenkins2014-06-142-0/+199
|\
View Lorry Controller Status