summaryrefslogtreecommitdiff
path: root/releasenotes
diff options
context:
space:
mode:
authorColleen Murphy <colleen@gazlene.net>2017-09-29 16:16:29 +0200
committerColleen Murphy <colleen.murphy@suse.com>2017-10-11 14:00:49 +0200
commit409b482253dec248ed828e92e52b09d4c02e51dd (patch)
tree928f25bae37d42a10b4cf9a2a9ccfab60ff9da2f /releasenotes
parent04735348de7e81e8190849fd676b04377a2a4e8c (diff)
downloadkeystonemiddleware-409b482253dec248ed828e92e52b09d4c02e51dd.tar.gz
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
Diffstat (limited to 'releasenotes')
-rw-r--r--releasenotes/notes/rename-auth-uri-d223d883f5898aee.yaml9
1 files changed, 9 insertions, 0 deletions
diff --git a/releasenotes/notes/rename-auth-uri-d223d883f5898aee.yaml b/releasenotes/notes/rename-auth-uri-d223d883f5898aee.yaml
new file mode 100644
index 0000000..1c3e3fa
--- /dev/null
+++ b/releasenotes/notes/rename-auth-uri-d223d883f5898aee.yaml
@@ -0,0 +1,9 @@
+---
+deprecations:
+ - |
+ The auth_uri parameter of keystone_authtoken is deprecated in favor of
+ www_authenticate_uri. The auth_uri option was often confused with the
+ auth_url parameter of the keystoneauth plugin, which was also effectively
+ always required. The parameter refers to the WWW-Authenticate header that is
+ returned when the user needs to be redirected to the Identity service for
+ authentication.