summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
|\
| * Session DocumentationJamie Lennox2014-06-132-0/+199
| | | | | | | | | | | | | | | | | | Include some client documentation for how to work with a Session object. This is generally high level with this expectation that a developer could take the concepts found here and determine more from the module documentation. Change-Id: I5e44c1029ce160cb2798cfb8a535aa9f3311799a
* | Link to docstrings in using-api-v3Brant Knudson2014-06-121-8/+10
|/ | | | | | | | The references to classes and modules were just the names and didn't link to the docstrings for the class or module. With this change, names are now links to the class or module. Change-Id: I9c7c03e8221ca71c7fddc0682abadc7a78d371db
* Add role assignments as concept in Client API V3 docsRodrigo Duarte Sousa2014-06-021-0/+1
| | | | | Change-Id: Ia04e51d98b5f00a28d94c24ed7665fcead3f6507 Closes-Bug: #1325739
* Update docs for auth_token middleware config optionsBrant Knudson2014-04-131-19/+119
| | | | | | | The documentation for the auth_token middleware config options was out of date. Change-Id: I8d03d77c58c714375e1e5174962991aa3adc61af
* Merge "Reference docstring for auth_token fields"Jenkins2014-03-311-33/+4
|\
| * Reference docstring for auth_token fieldsBrant Knudson2014-03-191-33/+4
| | | | | | | | | | | | | | | | | | The documented variables that the auth_token middleware sets for the request was out of date with the code. Rather than maintain the documentation for the fields in 2 places we'll now link to the auth_token module docs. Change-Id: Id4ca1843f749c1ed0b515c8860764add3ec4a3da
* | Remove releases.rst from keystone docsSteve Martinelli2014-03-252-34/+0
|/ | | | | | | | | The most recent update to releases.rst was made back in 2012, but it's references in the docs page. It is providing false (or at least, inaccurate) information. Suggest removing it since the server side doesn't have a release related file either. Change-Id: If2a71b55117c450afdade3cad697eba5a626263f
* Docs link to middlewarearchitectureBrant Knudson2014-03-181-0/+2
| | | | | | | There was no link to the middleware architecture from the main page so nobody would know that it's there. This adds the link. Change-Id: I2cd7a458b48d2c2889e4305e01bc013796a67c6e
* Fix doc build errorsBrant Knudson2014-03-131-1/+1
| | | | | | | | There were some parts that had invalid RST in their docstrings which caused warnings and errors to be generated. Related-Bug: #1278662 Change-Id: Ibb53e6f49b5fa100fa6ecfe47331f9a70729d03b
* Generate module docsBrant Knudson2014-03-133-1/+58
| | | | | | | | | The module docs were not being generated. Co-Authored-By: David Stanek <dstanek@dstanek.com> Change-Id: I26e1d9a3d407474eb6b016f3ada4c495b5043460 Closes-Bug: #1278662
* Merge "Remove reference to non-existent shell doc"Jenkins2014-03-091-2/+2
|\
| * Remove reference to non-existent shell docBrant Knudson2014-03-091-2/+2
| | | | | | | | | | | | | | There's no "shell.rst" document, so the index shouldn't reference it. Change-Id: I0d02b32349cfb6592b432700b4e04fda7fecbba8
* | Merge "Capitalize Client API title consistently"Jenkins2014-03-091-1/+1
|\ \
| * | Capitalize Client API title consistentlyBrant Knudson2014-02-281-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | The "client v2 API" and "Client v2 API" titles were inconsistenly capitalized. This makes the title capitalization consistent so the index page looks better. Change-Id: I85d033fd5d7f5204cd3d18e8c613dfd0c2a1cdd6
* | | Merge "Fix keystone command man page"Jenkins2014-03-091-2/+2
|\ \ \
| * | | Fix keystone command man pageBrant Knudson2014-02-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The overline/underline for the title was too short which generated an error. Change-Id: I2ba30ff9c819c425d5973c8cf5fd92d5642b5885
* | | | Merge "Add link to the v3 client api doc"Jenkins2014-03-091-3/+5
|\ \ \ \ | |_|/ / |/| | / | | |/ | |/|
| * | Add link to the v3 client api docBrant Knudson2014-02-161-3/+5
| |/ | | | | | | | | | | | | | | There was no link from the main page to the v3 client API doc so there's no easy way to get to it or to know that it's there. This adds the link. Change-Id: I3fd49eedcf7b79f6d810ed22cfcffba4ce47dece
* | Merge "Update middlewarearchitecture config options docs"Jenkins2014-02-201-9/+45
|\ \
| * | Update middlewarearchitecture config options docsBrant Knudson2014-02-021-9/+45
| |/ | | | | | | | | | | | | | | The configuration options documented in middlewarearchitecture.rst were incomplete. This change adds all the options defined in middleware.auth_token. Change-Id: I4a479bfa90e941f5094516cdb97cd58f91727f1c
* | Fix references to auth_token in middlewarearchitecture docBrant Knudson2014-02-161-16/+12
|/ | | | | | | | | | The middlewarearchitecture doc was still referring to keystone.middleware.auth_token, but the middleware was moved to keystoneclient. Also, corrected some other minor typos. Change-Id: I270ea2ccc739596e99a4a852bff3b5b7d1c85c82
* Merge "Adjust import items according to hacking import rule"Jenkins2014-01-301-0/+2
|\
| * Adjust import items according to hacking import ruleEric Guo2014-01-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adjust import items and add missing blank lines acording to http://docs.openstack.org/developer/hacking/#imports {{stdlib imports in human alphabetical order}} \n {{third-party lib imports in human alphabetical order}} \n {{project imports in human alphabetical order}} \n \n {{begin your code}} hacking project also enforce some checks for import group. Let make the change in keytoneclient Change-Id: Ic83bd5ee426905588f4a2d555851a9a01fc69f02
* | Fix typos in documents and commentsEric Guo2014-01-231-1/+1
|/ | | | | | | | | Fix typos detected by toolkit misspellings. * pip install misspellings * git ls-files | grep -v locale | misspellings -f - Change-Id: Ifbbc29537d9d129aad238de6c37718c4fbb8349b
* Merge "Documents keystone v3 API usage - part 1"Jenkins2014-01-111-0/+110
|\
| * Documents keystone v3 API usage - part 1Florent Flament2013-12-311-0/+110
| | | | | | | | | | | | | | | | | | | | docs/source/using-api.rst documents how to use the V2 API. This patch starts the equivalent documentation (using-api-v3.rst) about how to use Keystone v3 API. Introduction and Authentication sections have been written. Change-Id: I5a2d45d80ba712492717a75ac5901f5ca775daa4 Partial-Bug: #1260527
* | Merge "Rename using-api.rst to using-api-v2.rst"Jenkins2014-01-102-7/+7
|\ \
| * | Rename using-api.rst to using-api-v2.rstFlorent Flament2014-01-062-7/+7
| |/ | | | | | | | | | | | | | | | | | | | | Renaming file for consistency, since using-api-v3.rst is being written there: https://review.openstack.org/#/c/63408 Minor changes have been made to indicate that the file documents the keystone v2 API. Change-Id: I694b658a8b59d21615af5d88edc0f7b394ebbe7b Partial-Bug: #1260527
* | Rename tokenauth to authtoken in the docEmilien Macchi2013-12-061-2/+2
|/ | | | | Change-Id: Iedacd3ac76999570d5507953b9665948a3e3888f Signed-off-by: Emilien Macchi <emilien.macchi@enovance.com>
* Opt-out of service catalogguang-yee2013-11-211-0/+6
| | | | | | | | | | | | | | Introducing a config option 'include_service_catalog' to indicate whether service catalog is needed. If the 'include_service_catalog' option is set to False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. This option is backward compatible as it is default to True. DocImpact Fixed bug 1228317 Change-Id: Id8c410a7ae0443ac425d20cb9c6a24ee5bb2cb8d
* Replace OpenStack LLC with OpenStack Foundation0.4.1ZhiQiang Fan2013-10-171-1/+1
| | | | | | | | | | Some files still use trademark OpenStack LLC in header, which should be changed to OpenStack Foundation. NOTE: tools/install_venv.py is not touched, should sync with oslo Change-Id: I01d4f6b64cf1a152c4e190407799ce7d53de845f Fixes-Bug: #1214176
* Replace HttpConnection in auth_token with RequestsJamie Lennox2013-09-121-0/+4
| | | | | | | | | | | | | | Requests is becoming the standard way of doing http communication, it also vastly simplifies adding other authentication mechanisms. Use it in the auth_token middleware. This adds the ability to specify a CA file that will be used to verify a HTTPS connections or insecure to specifically ignore HTTPS validation. SecurityImpact DocImpact Partial-Bug: #1188189 Change-Id: Iae94329e7abd105bf95224d28f39f4b746b9eb70
* python3: Use from future import unicode_literalsChuck Short2013-08-301-7/+9
| | | | | | | | | | use "from future import unicode_literals" instead of u"" To the road to Python3, a possible next step would be to use the from __future__ import unicode_literals and remove the u'' prefixes, as it is not supported in Python3. Change-Id: Ic7afb3cf2d8dfad47b8a1626ab264f6d4f50d00e Signed-off-by: Chuck Short <chuck.short@canonical.com>
* Change memcache config entry name in Keystone to be consistent with Osloxingzhou2013-06-201-2/+2
| | | | | | | | | | | Currently, Keystone-Client is using 'memcache_servers' config option to store the memcache server info, while in OSLO project, it is using 'memcached_servers' to config the same option. It is better to change keystone-client's 'memcache_servers' to 'memcached_servers' to keep consistent between these two projects. Change-Id: I93ca0aa368f95a3ccf6de6984262057e61f75ffe Fixes: Bug 1172793
* Fix memcache encryption middlewareBryan D. Payne2013-06-191-17/+20
| | | | | | | | | | This fixes lp1175367 and lp1175368 by redesigning the memcache crypt middleware to not do dangerous things. It is forward compatible, but will invalidate any existing ephemeral encrypted or signed memcache entries. Change-Id: Ice8724949a48bfad3b8b7c41b5f50a18a9ad9f42 Signed-off-by: Bryan D. Payne <bdpayne@acm.org>
* Provide keystone CLI man page.Jakub Ruzicka2013-06-133-19/+78
| | | | | | | | | | | Resolves: bug 1185142 Implements blueprint: clients-man-pages Provide basic but hopefully useful man page. shell.rst was merged into and replaced by the man page in HTML docs. Change-Id: I0a90e4638cc7e4ed9c02c5abd7d84a4079e5f50d
* adding notes about dealing with exceptions in the clientJoe Heck2013-04-031-0/+4
| | | | Change-Id: I661b10414e0281bc695236bb32f985b0ef5b7600
* Cache tokens using memorycache from oslo.Vishvananda Ishaya2013-03-151-6/+7
| | | | | | | | | | | Verifying tokens accounts for a significant portion of the time taken by the various api servers. This uses the simple memory cache from oslo so that there is a simple default cache even if memcached is not deployed. Also cleans up the tests and removes unnecessary fakes. DocImpact Change-Id: I501c14f2f51da058cb574c32d49dd769e6f6ad86
* Allow configure auth_token http connect timeout.Chmouel Boudjnah2013-02-141-0/+2
| | | | | | - Fixes bug 939613. Change-Id: Ic8cfc36e02212eeb987e509893369c0a47d9209a
* Blueprint memcache-protection: enable memcache value encryption/integrity checkGuang Yee2013-01-153-0/+410
| | | | | | DocImpact Change-Id: I8b733256a3c2cdcf7c2ec5edac491ac4739aa847
* Replace refs to 'Keystone API' with 'Identity API'Dolph Mathews2012-10-244-14/+15
| | | | | | | Formally, OpenStack Keystone implements the OpenStack Identity API, and this is a client to the API, not to Keystone itself. Change-Id: If568866221a29ba041f0f2cd56dc81deeb9ebc00
View Lorry Controller Status