Deprecate auth_uri option

Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: I699fbb64d0e345f74751431e362620ce6c15ec88
Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316
Closes-Bug: #1759098

diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp
index bcd9c2b5aed434fc31b1ae42038dc9b98253726c..8aefccfbdbdec87c391e408352acb4a9aff554da 100644 (file)
--- a/manifests/keystone/authtoken.pp
+++ b/manifests/keystone/authtoken.pp
@@ -42,7 +42,7 @@
 #   (Optional) Authentication type to load
 #   Defaults to 'password'
 #
-# [*auth_uri*]
+# [*www_authenticate_uri*]
 #   (Optional) Complete public Identity API endpoint.
 #   Defaults to 'http://127.0.0.1:5000/'.
 #
@@ -178,6 +178,12 @@
 #   (in seconds). Set to -1 to disable caching completely. Integer value
 #   Defaults to $::os_service_default.
 #
+# DEPRECATED PARAMETERS
+#
+# [*auth_uri*]
+#   (Optional) Complete public Identity API endpoint.
+#   Defaults to undef
+#
 class ceilometer::keystone::authtoken(
   $username                       = 'ceilometer',
   $password                       = $::os_service_default,
@@ -188,7 +194,7 @@ class ceilometer::keystone::authtoken(
   $insecure                       = $::os_service_default,
   $auth_section                   = $::os_service_default,
   $auth_type                      = 'password',
-  $auth_uri                       = 'http://127.0.0.1:5000/',
+  $www_authenticate_uri           = 'http://127.0.0.1:5000/',
   $auth_version                   = $::os_service_default,
   $cache                          = $::os_service_default,
   $cafile                         = $::os_service_default,
@@ -213,6 +219,8 @@ class ceilometer::keystone::authtoken(
   $manage_memcache_package        = false,
   $region_name                    = $::os_service_default,
   $token_cache_time               = $::os_service_default,
+  # DEPRECATED PARAMETERS
+  $auth_uri                       = undef,
 ) {
 
   include ::ceilometer::deps
@@ -221,12 +229,17 @@ class ceilometer::keystone::authtoken(
     fail('Please set password for ceilometer service user')
   }
 
+  if $auth_uri {
+    warning('The auth_uri parameter is deprecated. Please use www_authenticate_uri instead.')
+  }
+  $www_authenticate_uri_real = pick($auth_uri, $www_authenticate_uri)
+
   keystone::resource::authtoken { 'ceilometer_config':
     username                       => $username,
     password                       => $password,
     project_name                   => $project_name,
     auth_url                       => $auth_url,
-    auth_uri                       => $auth_uri,
+    www_authenticate_uri           => $www_authenticate_uri_real,
     auth_version                   => $auth_version,
     auth_type                      => $auth_type,
     auth_section                   => $auth_section,

diff --git a/releasenotes/notes/deprecate_auth_uri_parameter-b847a5927a050526.yaml b/releasenotes/notes/deprecate_auth_uri_parameter-b847a5927a050526.yaml
new file mode 100644 (file)
index 0000000..86d56c0
--- /dev/null
+++ b/releasenotes/notes/deprecate_auth_uri_parameter-b847a5927a050526.yaml
@@ -0,0 +1,4 @@
+---
+deprecations:
+  - auth_uri is deprecated and will be removed in a future release.
+    Please use www_authenticate_uri instead.

diff --git a/spec/classes/ceilometer_keystone_authtoken_spec.rb b/spec/classes/ceilometer_keystone_authtoken_spec.rb
index b47ce5ce859dc70b944a86a1726b705647b6321f..5b4a6f6c5ce1fba9dbef2d438451d679475c8d5d 100644 (file)
--- a/spec/classes/ceilometer_keystone_authtoken_spec.rb
+++ b/spec/classes/ceilometer_keystone_authtoken_spec.rb
@@ -20,7 +20,7 @@ describe 'ceilometer::keystone::authtoken' do
         is_expected.to contain_ceilometer_config('keystone_authtoken/insecure').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_ceilometer_config('keystone_authtoken/auth_section').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_ceilometer_config('keystone_authtoken/auth_type').with_value('password')
-        is_expected.to contain_ceilometer_config('keystone_authtoken/auth_uri').with_value('http://127.0.0.1:5000/')
+        is_expected.to contain_ceilometer_config('keystone_authtoken/www_authenticate_uri').with_value('http://127.0.0.1:5000/')
         is_expected.to contain_ceilometer_config('keystone_authtoken/auth_version').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_ceilometer_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_ceilometer_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>')
@@ -50,7 +50,7 @@ describe 'ceilometer::keystone::authtoken' do
     context 'when overriding parameters' do
       before do
         params.merge!({
-          :auth_uri                             => 'https://10.0.0.1:9999/',
+          :www_authenticate_uri                 => 'https://10.0.0.1:9999/',
           :username                             => 'myuser',
           :password                             => 'mypasswd',
           :auth_url                             => 'https://127.0.0.1:35357',
@@ -88,7 +88,7 @@ describe 'ceilometer::keystone::authtoken' do
       end
 
       it 'configure keystone_authtoken' do
-        is_expected.to contain_ceilometer_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/')
+        is_expected.to contain_ceilometer_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/')
         is_expected.to contain_ceilometer_config('keystone_authtoken/username').with_value(params[:username])
         is_expected.to contain_ceilometer_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true)
         is_expected.to contain_ceilometer_config('keystone_authtoken/auth_url').with_value(params[:auth_url])