Commit Graph

89 Commits

Author SHA1 Message Date
Yusuke Niimi 53b4cb21ad External OAuth2.0 Authorization Server Support
Added the ability to authenticate using a system-scoped token and the
ability to authenticate using a cached token to the
external_oauth2_token filter.

Implements: blueprint enhance-oauth2-interoperability
Change-Id: I1fb4921faaafd5288d5909762ff5553e5e2475dc
2023-09-07 09:43:14 +00:00
sunyonggen de15a610e1 External OAuth2.0 Authorization Server Support
The external_oauth2_token filter has been added for accepting or denying
incoming requests containing OAuth 2.0 access tokens that are obtained
from an External Authentication Server.

Depends-On: https://review.opendev.org/c/openstack/keystoneauth/+/860614
Implements: blueprint enhance-oauth2-interoperability
Change-Id: I529c5b0c89933395b126e86651ef09368dd7e6b4
2023-08-30 13:30:32 +00:00
Hiromu Asahina 1c820f0c1c Add missing doc requirements
This updates the test-requirements to fix No module error in oslo_config.sphinxconfiggen when executing tox with doc env.

Change-Id: I4bfe30b3517f4a6c5c536afa150c66ef8522a2d0
2023-02-10 18:53:03 +00:00
Zuul 11ea4a8bd2 Merge "Use unittest.mock instead of third party mock" 2020-08-24 19:38:38 +00:00
Andreas Jaeger a9e9de2f21 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.

Remove the doc requirements from lower-constraints, they are not
needed during installation.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ic7c901ff19aa073b6e003ccb95aaf77886f20152
2020-05-21 13:43:00 +00:00
Sean McGinnis 215217ea8b
Use unittest.mock instead of third party mock
Now that we no longer support py27, we can use the standard library
unittest.mock module instead of the third party mock lib.

Change-Id: Idc319f3f8a3ddd57cba91e4cefc66dbb18d5cc22
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-04-18 11:53:42 -05:00
Tim Burke f88d07f953 Have middlewarearchitecture doc reference auth_type option
We literally say in (the rendered version of) the same doc:

 # Authentication type to load (string value)
 # Deprecated group/name - [keystone_authtoken]/auth_plugin
 #auth_type = <None>

Looks like auth_plugin has been deprecated for quite some time:
https://opendev.org/openstack/keystoneauth/commit/a56ed4218

Change-Id: I2dafa0cb28f017667497e0a6585d96a8cd090d5f
2020-03-20 06:47:52 +00:00
Vishakha Agarwal bf39733017 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

keystonemiddleware 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: Ia6f0e14efd19b0b98227258e7264b4850a197f4f
2020-01-07 09:31:56 -05:00
Vishakha Agarwal 381e81cfb2 Generate pdf documentation
Change-Id: I4bc8c036ce91795129970ab4f8c2536401c2a135
2019-09-27 17:43:03 +00:00
Gage Hugo 0a65b14207 Comment html_static_path entry in docs conf.py
Currently with sphinx 2.2.0 the docs job is throwing a warning
that the html_static_path entry does not exist. We treat warnings
as errors so this causes the job to fail.

This change comments the html_static_path entry in conf.py since
the path currently does not exist so it appears to be unused.

Change-Id: Ib2c74f4f37855cec250d09b23c45b5b7fde44c8d
2019-08-23 19:04:22 +00:00
Zuul 90c6872615 Merge "Bump the openstackdocstheme extension to 1.20" 2019-08-16 16:13:11 +00:00
pengyuesheng f7d8334829 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.

Change-Id: I161a3983e23b0ae50c232eb63ca78f8fd230e91e
2019-08-02 15:11:07 +08:00
pengyuesheng 3e4eda0e83 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: Ia166252623563438c42538320f6fbf7c74785520
2019-08-02 15:07:35 +08:00
Zuul 3e62d25dac Merge "Add a new option to choose the Identity endpoint" 2019-06-12 15:47:50 +00:00
Jens Harbott f6037a3d50 Add a new option to choose the Identity endpoint
Previously the admin Identity endpoint was hardcoded to be used. Now
that keystone has dropped v2 support, deploying an admin Identity
endpoint is no longer useful, so allow this to be changed by the
deployer. Keep the default as using the `admin` endpoint, but create
a deprecation message so that we can change the default in the future.

Partial-Bug: 1830002
Change-Id: I993a45ccb1109d67e65bf32d1e134cc9bec2d88e
2019-06-03 10:34:25 +00:00
Gage Hugo e93d078958 Blacklist bandit 1.6.0 & cap sphinx for 2.7
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.

Change-Id: I5d32d835886360522af21f735c74b2f85036f7f1
2019-05-20 11:26:34 -05:00
melissaml c4e81b3857 Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: Ibb6247bfb2cfe1c77f6841be2773cbff9475e0c6
2018-12-16 22:44:50 +08:00
Nguyen Van Duc 94058477c9 Replace port 35357 with 5000
With Keystone v3, the admin (35357) and public (5000) ports are
the same and use the same keystone code paths for authentication.

This patch set replace 35357 and only uses port 5000

Change-Id: I596e3a2b29b2954bf7caef6f9408d9b2b4e890ee
2018-07-20 13:57:04 +07:00
Kristi Nikolla 5fa536e6c5 Document endpoint interface and region behavior
After some debugging following [0] to figure out why ksm was
not connecting to the specified auth_url, found out that
ksm connects to the identity server on the 'admin' interface
[1] after authenticating with auth_url and fetching the catalog if
keystoneauth is being used. Otherwise it connects on identity_uri
and disregards the service catalog [2].  This behavior was not
documented.

[0]. http://eavesdrop.openstack.org/irclogs/%23openstack-keystone/%23openstack-keystone.2017-09-19.log.html#t2017-09-19T17:50:06
[1]. d1b7a1f092/keystonemiddleware/auth_token/__init__.py (L936-L938)
[2]. d1b7a1f092/keystonemiddleware/auth_token/_auth.py (L121-L130)

Change-Id: Ide40835de856012ac4dd71975beac9d32771f356
2018-07-05 15:13:29 +00:00
Zuul c5171adb2b Merge "Follow the new PTI for document build" 2018-06-06 22:13:59 +00:00
Zuul 64b5e9e882 Merge "Don't rely on pbr ChangeLog for docs" 2018-06-06 20:26:20 +00:00
melissaml a451b28c43 Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
Change-Id: Ia0a27229f09467980ff4af014001febb017bb36d
2018-06-06 15:22:22 +00:00
wangxiyuan 0b7d9ae9b4 Fix the title in index.rst
The titles in the index.rst can't be shown in the webpage.
This patch adds them back.

Change-Id: I56febf6cb137b7f6dbc05365d48159be36d18c13
2018-05-25 11:37:57 +08:00
Colleen Murphy bcdec1acfa Don't rely on pbr ChangeLog for docs
The ChangeLog file is generated when we run `python setup.py sdist`,
which doesn't naturally happen when we run `tox -edocs`, so on a fresh
clone the docs build will fail because it references the ChangeLog file
which isn't there. Since we don't rely on pbr any more for release notes
and we have a sophisticated release note management tool, point the docs
at the published release notes instead of the pbr ChangeLog.

Change-Id: I614091eae739154337795a8f120b68686ad0ed0a
2018-05-24 13:38:52 -07:00
OpenStack Proposal Bot fadab2fb2b Updated from global requirements
Change-Id: I71330bf5adcdd55a1a782189a29886f9189dddd0
2018-03-23 01:02:54 +00:00
OpenStack Proposal Bot e15e2d040b Updated from global requirements
Change-Id: Ia31fc31bd33e85622a15bc383cf1bb7af753de7e
2018-03-17 08:35:04 +00:00
OpenStack Proposal Bot 04cd4676cc Updated from global requirements
Change-Id: I29e02c0626456f34663c1d223a9512f083a21309
2018-01-24 00:57:26 +00:00
OpenStack Proposal Bot 316d1b4659 Updated from global requirements
Change-Id: Iafc586a8752d08e5b4ce1dd6599f674aad3e2943
2018-01-17 20:37:16 +00:00
OpenStack Proposal Bot 8b7ac8e3e4 Updated from global requirements
Change-Id: I6effa91e130eaf7ebdf30dd36e1c486e2f36df07
2018-01-16 04:09:47 +00:00
Colleen Murphy ba9c1a3bec Fix docs builds
With the new way of generating docs in the gate[1] our autodoc builds
are slightly broken. Put the required dependencies for doc building and
autodoc generation into doc/requirements.txt. We can also now remove
docs-related requirements from test-requirements.txt.

[1] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: Ifbd16fe364bb216821125c70bb7d3ab0ac1f10a3
2017-12-20 00:39:46 +01:00
Zuul 6be663a79d Merge "Rename auth_uri to www_authenticate_uri" 2017-10-20 17:34:52 +00:00
Colleen Murphy 409b482253 Rename auth_uri to www_authenticate_uri
The [keystone_authtoken]/auth_uri middleware parameter has been causing
extreme confusion amongst operators and developers ever since the
keystonemiddleware started accepting keystoneauth plugin parameters
including auth_url. The two parameters look identical and yet have
completely different meanings and are both required. This patch
deprecates auth_uri and renames it to www_authenticate_uri, which more
accurately describes the WWW-Authenticate header it is configuring and
is dissimilar to any other keystone_authtoken middleware parameter. This
also renames the internal variable names for consistency with the config
option.

Change-Id: I0cf11da3d395749df28077427689fdafc8a6b981
2017-10-11 14:00:49 +02:00
Jaewoo Park a8616e97e0 Update config docs to reflect non-deprecated methods
Changed the keystone_authtoken part of the config docs so that it
advertises the use of identity_uri over the deprecated auth_protocol,
auth_port, auth_host

Change-Id: Ia1351a83abed30f2680c2ce3a074028bd95158fb
Closes-Bug: 1679238
2017-09-11 11:03:11 -07:00
Jenkins cd598a4f83 Merge "Add doc8 rule and check doc/source files" 2017-08-27 17:48:16 +00:00
liuxiaoyang 31be1c5ad3 Add doc8 rule and check doc/source files
doc8 is a linter for documents and used in openstack-manuals.
It is better to enforce document linters for simple checking.
This change is to add doc8 in tox file and fix line too long
in some files.

The current rules are as bellow:
- invalid rst format - D000
- lines should not be longer than 79 characters - D001
  - RST exception: line with no whitespace except in the beginning
  - RST exception: lines with http or https urls
  - RST exception: literal blocks
  - RST exception: rst target directives
- no trailing whitespace - D002
- no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004
- no newline at end of file - D005

Change-Id: I01b11619b42eebf13cb17e1b4a2e8464a8ccc797
2017-08-26 20:18:57 +00:00
Colleen Murphy 51ca52823f Remove notice about system time
Keystone used to require that the memcached and keystone servers both
use UTC, but this was fixed[1]. Keeping the notice in the
keystonemiddleware documentation is confusing. This patch removes the
note.

[1] https://bugs.launchpad.net/keystone/+bug/1221087

Change-Id: Iae2dc43ea3f0270246acd3184b7bb0c5778dcc7c
2017-07-28 08:41:52 +02:00
Jenkins 198d3cdd46 Merge "Enable sphinx todo extension" 2017-07-24 15:26:05 +00:00
Hangdong Zhang 4a72cd6c3b Update URLs in documentation
Update URLs according to OpenStack document migration.

Change-Id: Icb4232fcce79bb1ea121489122e578e3109b5e90
2017-07-20 16:38:16 +08:00
Gage Hugo 15b9ad644d Enable sphinx todo extension
In a previous change [0] when warning-is-error was added, the
sphinx todo extension was causing errors with duplicate
registration. However with the recent changes between pbr and
sphinx, this extension no longer throws a duplicate error when
using warning-is-error and we can add it back in.

[0] https://review.openstack.org/#/c/439819/

Change-Id: Ib71f156eb179bdfe07479441334ea0efcc594924
2017-07-17 11:11:09 -05:00
Jenkins 1c12eb4131 Merge "Added "warning-is-error" sphinx check for docs" 2017-07-14 20:32:00 +00:00
Jenkins c697e793af Merge "Switch from oslosphinx to openstackdocstheme" 2017-07-07 16:56:15 +00:00
Boris Bobrov 5761091747 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.

Change-Id: I5b02d7fa40b5892ee0c66bba8dd642dde9a6637e
Depends-On: I7e170275fd422345505b7282b52899d08c7a4172
2017-07-05 12:27:19 +03:00
Van Hung Pham 27296d5858 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: I5150a456df75d61035a6f00366fa70bd4ec83457
2017-06-30 15:21:25 +07:00
lingyongxu 6a52a8456e 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.

Change-Id: I21ff7fe4da885d590303105c311aa9792fdaef2a
2017-06-09 18:04:43 +08:00
Gage Hugo 7e209b9767 Added "warning-is-error" sphinx check for docs
This change adds the "warning-is-error" setting
to setup.cfg in order to enforce strict doc validation which
will cause the build to fail if any warnings are thrown.

This also removes the redundant loading of the todo plugin
warning that shows up while running 'tox -e docs' with
'warning-is-error' enabled.

Change-Id: I33c110073feec7dd38ab75981d6f97c654852f37
2017-04-24 16:31:00 -05:00
Gage Hugo 126cad8dee Remove old comment referencing fixed bug
There was an old comment left regarding this bug:

https://bugs.launchpad.net/pbr/+bug/1260495

which was fixed over a year ago but left over.

This change removes the comment and related extension
and adds the referenced pbr setting.

Change-Id: Ib334c136835a9b5b43cabe13b9616cce45e578e0
2017-03-08 11:02:46 -06:00
Gage Hugo 67a29bde2d Fixed man_pages no value warning when making docs
When building keystonemiddleware docs, the following warning
is currently emitted:

WARNING: no "man_pages" config value found;
no manual pages will be written

This change comments out man_pages since it was only
specifying an empty list, and the warning no longer appears.

Change-Id: Ia650abc6cb3b3bcf36469cae9d8c20e83d0317a4
2017-02-08 15:53:37 -06:00
Eric Brown 96dac98364 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: I8521461203fe40e4576f4de7cfb500bd64027d6d
2017-02-05 20:36:42 -08:00
Jenkins 50ffbe3023 Merge "Removes unnecessary utf-8 coding" 2017-01-17 21:19:25 +00:00
Steve Martinelli 58da2fb0a2 fix broken links
as noted in [1] we had a few broken links, this should fix the
ones seen in the keystonemiddleware repo

[1] http://lists.openstack.org/pipermail/openstack-docs/2017-January/009464.html

Change-Id: I46a3e13ed78c4fca9a196089ceae994e41eff8bc
2017-01-13 00:20:11 -05:00