From e2564755c2070d58f88215dde31236f14eae5c61 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Tue, 3 Apr 2018 16:54:58 +0800 Subject: [PATCH] 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: I34a4a90e23683f5938b3047c31899ffae1dadd73 Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316 Closes-Bug: #1759098 --- manifests/keystone/authtoken.pp | 19 ++++++++++++++++--- ...e_auth_uri_parameter-87162cb2efcf10b8.yaml | 4 ++++ .../barbican_keystone_authtoken_spec.rb | 6 +++--- 3 files changed, 23 insertions(+), 6 deletions(-) create mode 100644 releasenotes/notes/deprecate_auth_uri_parameter-87162cb2efcf10b8.yaml diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index d6a76798..fcb69151 100644 --- 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://localhost: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 barbican::keystone::authtoken( $password = $::os_service_default, $username = 'barbican', @@ -188,7 +194,7 @@ class barbican::keystone::authtoken( $insecure = $::os_service_default, $auth_section = $::os_service_default, $auth_type = 'password', - $auth_uri = 'http://localhost:5000', + $www_authenticate_uri = 'http://localhost:5000', $auth_version = $::os_service_default, $cache = $::os_service_default, $cafile = $::os_service_default, @@ -213,6 +219,8 @@ class barbican::keystone::authtoken( $manage_memcache_package = false, $region_name = $::os_service_default, $token_cache_time = $::os_service_default, + # DEPRECATED PARAMETERS + $auth_uri = undef, ) { include ::barbican::deps @@ -221,12 +229,17 @@ class barbican::keystone::authtoken( fail('Please set password for barbican 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 { 'barbican_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-87162cb2efcf10b8.yaml b/releasenotes/notes/deprecate_auth_uri_parameter-87162cb2efcf10b8.yaml new file mode 100644 index 00000000..86d56c01 --- /dev/null +++ b/releasenotes/notes/deprecate_auth_uri_parameter-87162cb2efcf10b8.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/barbican_keystone_authtoken_spec.rb b/spec/classes/barbican_keystone_authtoken_spec.rb index dc37c401..aeef5368 100644 --- a/spec/classes/barbican_keystone_authtoken_spec.rb +++ b/spec/classes/barbican_keystone_authtoken_spec.rb @@ -39,7 +39,7 @@ describe 'barbican::keystone::authtoken' do is_expected.to contain_barbican_config('keystone_authtoken/insecure').with_value('') is_expected.to contain_barbican_config('keystone_authtoken/auth_section').with_value('') is_expected.to contain_barbican_config('keystone_authtoken/auth_type').with_value('password') - is_expected.to contain_barbican_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_barbican_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000') is_expected.to contain_barbican_config('keystone_authtoken/auth_version').with_value('') is_expected.to contain_barbican_config('keystone_authtoken/cache').with_value('') is_expected.to contain_barbican_config('keystone_authtoken/cafile').with_value('') @@ -69,7 +69,7 @@ describe 'barbican::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 => 'http://:127.0.0.1:35357', @@ -107,7 +107,7 @@ describe 'barbican::keystone::authtoken' do end it 'configure keystone_authtoken' do - is_expected.to contain_barbican_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_barbican_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/') is_expected.to contain_barbican_config('keystone_authtoken/username').with_value(params[:username]) is_expected.to contain_barbican_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) is_expected.to contain_barbican_config('keystone_authtoken/auth_url').with_value(params[:auth_url])