From ec6a33fb52f9270db8cf77d980b02d3ab9857d89 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Tue, 3 Apr 2018 16:55:03 +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: I034f67b503bb1f579c18bc3b61208984e577d6ba Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316 Closes-Bug: #1759098 --- manifests/keystone/authtoken.pp | 20 +++++++++++++++---- ...e_auth_uri_parameter-8df63f76c70b0cba.yaml | 4 ++++ spec/classes/mistral_init_spec.rb | 2 +- .../mistral_keystone_authtoken_spec.rb | 6 +++--- 4 files changed, 24 insertions(+), 8 deletions(-) create mode 100644 releasenotes/notes/deprecate_auth_uri_parameter-8df63f76c70b0cba.yaml diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index 518f5d5..33e6b3c 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 mistral::keystone::authtoken( $username = 'mistral', $password = $::os_service_default, @@ -188,7 +194,7 @@ class mistral::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 mistral::keystone::authtoken( $manage_memcache_package = false, $region_name = $::os_service_default, $token_cache_time = $::os_service_default, + # DEPRECATED PARAMETERS + $auth_uri = undef, ) { include ::mistral::deps @@ -221,19 +229,23 @@ class mistral::keystone::authtoken( fail('Please set password for mistral service user') } + if $auth_uri { + warning('The auth_uri parameter is deprecated. Please use www_authenticate_uri instead.') + } + #NOTE(emilien): Use pick to keep backward compatibility $username_real = pick($::mistral::keystone_user,$username) $password_real = pick($::mistral::keystone_password,$password) $project_name_real = pick($::mistral::keystone_tenant,$project_name) $auth_url_real = pick($::mistral::identity_uri,$auth_url) - $auth_uri_real = pick($::mistral::auth_uri,$auth_uri) + $www_authenticate_uri_real = pick($::mistral::auth_uri,$auth_uri,$www_authenticate_uri) keystone::resource::authtoken { 'mistral_config': username => $username_real, password => $password_real, project_name => $project_name_real, auth_url => $auth_url_real, - auth_uri => $auth_uri_real, + 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-8df63f76c70b0cba.yaml b/releasenotes/notes/deprecate_auth_uri_parameter-8df63f76c70b0cba.yaml new file mode 100644 index 0000000..86d56c0 --- /dev/null +++ b/releasenotes/notes/deprecate_auth_uri_parameter-8df63f76c70b0cba.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/mistral_init_spec.rb b/spec/classes/mistral_init_spec.rb index 39f2269..aa616a2 100644 --- a/spec/classes/mistral_init_spec.rb +++ b/spec/classes/mistral_init_spec.rb @@ -53,7 +53,7 @@ describe 'mistral' do is_expected.to contain_mistral_config('oslo_messaging_rabbit/kombu_failover_strategy').with(:value => '') is_expected.to contain_mistral_config('coordination/backend_url').with(:value => '') is_expected.to contain_mistral_config('coordination/heartbeat_interval').with(:value => '') - is_expected.to contain_mistral_config('keystone_authtoken/auth_uri').with( + is_expected.to contain_mistral_config('keystone_authtoken/www_authenticate_uri').with( :value => 'http://localhost:5000' ) is_expected.to contain_mistral_config('keystone_authtoken/auth_url').with( diff --git a/spec/classes/mistral_keystone_authtoken_spec.rb b/spec/classes/mistral_keystone_authtoken_spec.rb index e26be8a..b43b472 100644 --- a/spec/classes/mistral_keystone_authtoken_spec.rb +++ b/spec/classes/mistral_keystone_authtoken_spec.rb @@ -20,7 +20,7 @@ describe 'mistral::keystone::authtoken' do is_expected.to contain_mistral_config('keystone_authtoken/insecure').with_value('') is_expected.to contain_mistral_config('keystone_authtoken/auth_section').with_value('') is_expected.to contain_mistral_config('keystone_authtoken/auth_type').with_value('password') - is_expected.to contain_mistral_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_mistral_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000') is_expected.to contain_mistral_config('keystone_authtoken/auth_version').with_value('') is_expected.to contain_mistral_config('keystone_authtoken/cache').with_value('') is_expected.to contain_mistral_config('keystone_authtoken/cafile').with_value('') @@ -50,7 +50,7 @@ describe 'mistral::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', @@ -88,7 +88,7 @@ describe 'mistral::keystone::authtoken' do end it 'configure keystone_authtoken' do - is_expected.to contain_mistral_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_mistral_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/') is_expected.to contain_mistral_config('keystone_authtoken/username').with_value(params[:username]) is_expected.to contain_mistral_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) is_expected.to contain_mistral_config('keystone_authtoken/auth_url').with_value(params[:auth_url])