From dfd67c27a3b77b42d03fd2c7323c2447e1fada52 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Tue, 3 Apr 2018 12:57:24 +0800 Subject: [PATCH] Deprecate auth_uri parameter 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: I092efd9c530b3108a88c4f6f364f7b4adbaf6a80 Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316 Closes-Bug: #1759098 --- lib/puppet/provider/neutron.rb | 4 ++-- manifests/keystone/authtoken.pp | 19 ++++++++++++++++--- ...e_auth_uri_parameter-81afb74d42ee6f83.yaml | 4 ++++ .../neutron_keystone_authtoken_spec.rb | 6 +++--- spec/unit/provider/neutron_spec.rb | 16 ++++++++-------- 5 files changed, 33 insertions(+), 16 deletions(-) create mode 100644 releasenotes/notes/deprecate_auth_uri_parameter-81afb74d42ee6f83.yaml diff --git a/lib/puppet/provider/neutron.rb b/lib/puppet/provider/neutron.rb index 3120ae589..f4b812768 100644 --- a/lib/puppet/provider/neutron.rb +++ b/lib/puppet/provider/neutron.rb @@ -75,7 +75,7 @@ class Puppet::Provider::Neutron < Puppet::Provider::Openstack def self.get_neutron_credentials #needed keys for authentication - auth_keys = ['auth_uri', 'project_name', 'username', 'password'] + auth_keys = ['www_authenticate_uri', 'project_name', 'username', 'password'] conf = neutron_conf if conf and conf['keystone_authtoken'] and auth_keys.all?{|k| !conf['keystone_authtoken'][k].nil?} @@ -104,7 +104,7 @@ class Puppet::Provider::Neutron < Puppet::Provider::Openstack def self.get_auth_endpoint q = neutron_credentials - "#{q['auth_uri']}" + "#{q['www_authenticate_uri']}" end def self.auth_endpoint diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index 93ac3c9fe..dbfcdaa3d 100644 --- a/manifests/keystone/authtoken.pp +++ b/manifests/keystone/authtoken.pp @@ -42,7 +42,7 @@ # (Optional) Authentication type to load # Defaults to $::os_service_default # -# [*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 neutron::keystone::authtoken( $username = 'neutron', $password = $::os_service_default, @@ -188,7 +194,7 @@ class neutron::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 neutron::keystone::authtoken( $manage_memcache_package = false, $region_name = $::os_service_default, $token_cache_time = $::os_service_default, + # DEPRECATED PARAMETERS + $auth_uri = undef, ) { include ::neutron::deps @@ -221,12 +229,17 @@ class neutron::keystone::authtoken( fail('Please set password for neutron 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 { 'neutron_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-81afb74d42ee6f83.yaml b/releasenotes/notes/deprecate_auth_uri_parameter-81afb74d42ee6f83.yaml new file mode 100644 index 000000000..86d56c01d --- /dev/null +++ b/releasenotes/notes/deprecate_auth_uri_parameter-81afb74d42ee6f83.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/neutron_keystone_authtoken_spec.rb b/spec/classes/neutron_keystone_authtoken_spec.rb index d6a631f75..bda5c7cbf 100644 --- a/spec/classes/neutron_keystone_authtoken_spec.rb +++ b/spec/classes/neutron_keystone_authtoken_spec.rb @@ -20,7 +20,7 @@ describe 'neutron::keystone::authtoken' do is_expected.to contain_neutron_config('keystone_authtoken/insecure').with_value('') is_expected.to contain_neutron_config('keystone_authtoken/auth_section').with_value('') is_expected.to contain_neutron_config('keystone_authtoken/auth_type').with_value('password') - is_expected.to contain_neutron_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_neutron_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000') is_expected.to contain_neutron_config('keystone_authtoken/auth_version').with_value('') is_expected.to contain_neutron_config('keystone_authtoken/cache').with_value('') is_expected.to contain_neutron_config('keystone_authtoken/cafile').with_value('') @@ -50,7 +50,7 @@ describe 'neutron::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 'neutron::keystone::authtoken' do end it 'configure keystone_authtoken' do - is_expected.to contain_neutron_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_neutron_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/') is_expected.to contain_neutron_config('keystone_authtoken/username').with_value(params[:username]) is_expected.to contain_neutron_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) is_expected.to contain_neutron_config('keystone_authtoken/auth_url').with_value(params[:auth_url]) diff --git a/spec/unit/provider/neutron_spec.rb b/spec/unit/provider/neutron_spec.rb index 0cf2e0064..514b22d19 100644 --- a/spec/unit/provider/neutron_spec.rb +++ b/spec/unit/provider/neutron_spec.rb @@ -11,12 +11,12 @@ describe Puppet::Provider::Neutron do let :credential_hash do { - 'project_name' => 'admin_tenant', - 'username' => 'admin', - 'password' => 'password', - 'auth_uri' => 'https://192.168.56.210:35357/v2.0/', - 'project_domain_name' => 'Default', - 'user_domain_name' => 'Default', + 'project_name' => 'admin_tenant', + 'username' => 'admin', + 'password' => 'password', + 'www_authenticate_uri' => 'https://192.168.56.210:35357/v2.0/', + 'project_domain_name' => 'Default', + 'user_domain_name' => 'Default', } end @@ -65,7 +65,7 @@ describe Puppet::Provider::Neutron do it 'should set auth credentials in the environment' do authenv = { - :OS_AUTH_URL => credential_hash['auth_uri'], + :OS_AUTH_URL => credential_hash['www_authenticate_uri'], :OS_USERNAME => credential_hash['username'], :OS_PROJECT_NAME => credential_hash['project_name'], :OS_PASSWORD => credential_hash['password'], @@ -79,7 +79,7 @@ describe Puppet::Provider::Neutron do it 'should set region in the environment if needed' do authenv = { - :OS_AUTH_URL => credential_hash['auth_uri'], + :OS_AUTH_URL => credential_hash['www_authenticate_uri'], :OS_USERNAME => credential_hash['username'], :OS_PROJECT_NAME => credential_hash['project_name'], :OS_PASSWORD => credential_hash['password'],