128 Commits

Author SHA1 Message Date
Zuul
238269c07f Merge "remove unicode from code" 2022-04-22 17:21:06 +00:00
zhangtongjian
07c7f94601 remove unicode from code
Change-Id: I2d2d025b0d8bda2ffc7be4d30489728c05f53c8e
2022-04-19 15:57:10 +08:00
Radomir Dopieralski
f6569e22fc Fix doc error to unblock the gate
/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
2021-10-14 13:38:45 +02:00
Andreas Jaeger
30199f4f94 Switch to newer openstackdocstheme and reno versions
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
2020-05-20 21:44:42 +02:00
Andreas Jaeger
a9d01eef93 Fix docs publishing
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
2020-04-15 11:53:00 +02:00
Andreas Jaeger
b58ebe2b7f Cleanup py27 support
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
2020-04-04 14:15:46 +02:00
Vishakha Agarwal
f27e6467e7 Generate pdf documentation
This patch adds a new tox job/command for building the pdf
version of documentation.

tox -epdf-docs

Change-Id: I0c0ef99190ea2a834bfdb47eb443b88a93bc802c
2019-09-04 11:09:34 +05:30
pengyuesheng
f7e75f43d8 Bump the openstackdocstheme extension to 1.20
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
2019-08-01 09:44:54 +08:00
David Stanek
b2e9caee38 Add Response class to return request-id to caller
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
2018-03-26 01:51:30 -07:00
melissaml
956ec88d0a Update URLs in documents according to document migration
Change-Id: Ie0a8594f2dd0554a07111207899e6134affc998e
2017-07-14 09:56:01 +08:00
Jenkins
efbe02e67c Merge "Bring back intersphinx reference to keystoneauth" 2017-07-06 06:40:57 +00:00
Jenkins
36bdcf6b2d Merge "Switch from oslosphinx to openstackdocstheme" 2017-07-06 04:06:54 +00:00
Jenkins
6172c763d4 Merge "Change locations of docs for intersphinx" 2017-07-05 11:48:11 +00:00
Boris Bobrov
eb70dba59d Bring back intersphinx reference to keystoneauth
Change-Id: I0b1d1a4abdf919dd403679565cde046a825898fa
Depends-On: I2a4fc6a4782a5496b2ab4a8355ed2c3b6dac58fa
2017-07-05 12:04:01 +03:00
Boris Bobrov
0a79acf82f Change locations of docs for intersphinx
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
2017-07-05 12:01:10 +03:00
Van Hung Pham
2ea1fcacfd Switch from oslosphinx to openstackdocstheme
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
2017-06-30 19:06:18 +07:00
Vu Cong Tuan
b456e923ae Fix html_last_updated_fmt for Python3
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
2017-06-06 08:42:35 +07:00
Eric Brown
689729fa35 Use https for *.openstack.org references
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
2017-02-05 20:46:32 -08:00
Jenkins
06d5bd63f9 Merge "Removes unnecessary utf-8 encoding" 2017-01-13 13:22:19 +00:00
ji-xuepeng
6632abf191 Removes unnecessary utf-8 encoding
Change-Id: Ide4cb14246394522e35929cf08978aaf5fa9eb59
2017-01-13 21:25:15 +08:00
Henry Nash
cb31a83888 Support domain-specific configuration management
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
2016-11-02 17:03:41 +00:00
Steve Martinelli
b79d4a4c5d [doc] remove auth plugin docs
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
2016-10-19 15:54:07 -04:00
Corey Bryant
9bc94cc048 import warnings in doc/source/conf.py
Change-Id: If14c02e156f7fe6884ad8de4b80869b2d01de4d7
Closes-Bug: 1587625
2016-05-31 15:48:31 -04:00
Ivan Udovichenko
641aa0f91e Fallback if Git repository is absent
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
2016-04-27 16:45:07 +03:00
Brant Knudson
c2d5fce3fc Remove doc references to the keystone CLI
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
2016-03-11 15:01:55 -06:00
Steve Martinelli
ef13bd8cf6 remove CLI from keystoneclient
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
2016-03-10 03:51:01 +00:00
Jenkins
be9b5856d4 Merge "Update developer docs for keystoneauth session" 2016-03-01 01:13:03 +00:00
Jenkins
263f2389af Merge "Fix reference to ClientException" 2016-02-29 21:06:43 +00:00
Brant Knudson
d285715852 Fix reference to ClientException
keystoneclient doesn't use apiclient exceptions anymore.

Change-Id: I7a5a732a9f3a2162d8c4b4083ee9a9c7d90e9e0d
2016-02-28 11:22:04 -06:00
Brant Knudson
eb70a26a60 Update developer docs for keystoneauth session
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
2016-02-28 17:17:33 +00:00
Brant Knudson
251f52b7b5 Correct test running instructions
To run the tests just do `tox`.

Change-Id: Ibe61e63c1d7b3a1b1dd3186ae5930a67fdba9ed3
2016-02-28 17:17:04 +00:00
Yatin Kumbhare
13ade585c6 Fix for the deprecated library function
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I53c21d6e8a9d23646c236ae33d652f1aefc20153
Closes-Bug: #1529836
2016-01-05 23:00:38 +05:30
Jamie Lennox
bdd44d3142 Map keystoneclient exceptions to keystoneauth
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
2015-11-19 13:35:18 +11:00
Hidekazu Nakamura
681fe93f6e Add missing end single quote
End single quote of is missing. This patch add it.

Change-Id: Ibabde8922d97e1d30f7130574080f56ccb8d6be9
2015-11-11 21:18:29 +09:00
Jenkins
8f2aaedfe3 Merge "Fix typo that says V3 token only works for v2" 2015-10-16 01:51:19 +00:00
Steve Martinelli
36e52d06ad Fix typo that says V3 token only works for v2
The V3 token plugin should work for v3 identity service

Change-Id: Ic3c53dd94e1fe5d1ab69a02a7f7469735ee4c978
2015-10-15 17:00:35 -04:00
Steve Martinelli
ebdbbeee54 auto-generate release history
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
2015-10-15 19:00:43 +00:00
Jamie Lennox
556c1a6633 Identity plugin thread safety
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
2015-09-10 10:18:36 +10:00
Jenkins
78194b170b Merge "Fixes modules index generated by Sphinx" 2015-07-13 22:57:47 +00:00
David Stanek
4034366b51 Fixes modules index generated by Sphinx
Sphinx was always using (k)eystoneclient for the prefix so the index
wasn't very useful.

Change-Id: I9f883e1005874b5f5019f9030b94174a2169ed77
2015-07-08 20:12:31 +00:00
Steve Martinelli
a951023f7c Remove unused images from docs
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
2015-06-28 05:49:46 +00:00
Jenkins
795b856717 Merge "Fixed grammatical errors in the V2 Client API doc" 2015-05-28 06:43:33 +00:00
Jenkins
b890217f4b Merge "Fixe example code in Using Sessions page" 2015-05-28 06:41:10 +00:00
Michael Simo
519282d883 Fixed grammatical errors in the V2 Client API doc
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
2015-05-27 16:46:32 +00:00
DhritiShikhar
416a3c1c4f Fixe example code in Using Sessions page
* 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
2015-05-27 13:34:44 -03:00
David Stanek
045e47938f Removes temporary fix for doc generation
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
2015-05-07 03:12:18 +00:00
Dave Chen
997a649d26 Crosslink to other sites that are owned by Keystone
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
2015-03-14 18:47:05 +08:00
Jenkins
8bb0439528 Merge "Workflow documentation is now in infra-manual" 2015-02-10 02:52:12 +00:00
Jeremy Stanley
93626a0a64 Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f
2015-02-05 17:56:32 +00:00
Jenkins
d006987639 Merge "Fix up types within API documentation" 2015-01-18 07:45:26 +00:00