openstack/puppet-vitrage
Code Issues Proposed changes

Deprecate auth_uri option

Browse Source 
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: I4494127d11456a237af33cc969bde2dae081ce9c
Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316
Depends-On: I1bb3489acf1f591eefbad91bdbb666b21a53238a
Closes-Bug: #1759098
This commit is contained in:
ZhongShengping 2018-04-03 16:55:04 +08:00
parent 67015c81b5
commit e6fc31d0ad
3 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
manifests/keystone/authtoken.pp
View File

@ -41,7 +41,7 @@
# (Optional) Authentication type to load # (Optional) Authentication type to load
# Defaults to 'password' # Defaults to 'password'
# #
# [*auth_uri*] # [*www_authenticate_uri*]
# (Optional) Complete public Identity API endpoint. # (Optional) Complete public Identity API endpoint.
# Defaults to 'http://localhost:5000'. # Defaults to 'http://localhost:5000'.
# #
@ -177,6 +177,12 @@
# (in seconds). Set to -1 to disable caching completely. Integer value # (in seconds). Set to -1 to disable caching completely. Integer value
# Defaults to $::os_service_default. # Defaults to $::os_service_default.
# #
# DEPRECATED PARAMETERS
#
# [*auth_uri*]
# (Optional) Complete public Identity API endpoint.
# Defaults to undef
#
class vitrage::keystone::authtoken( class vitrage::keystone::authtoken(
$password, $password,
$username = 'vitrage', $username = 'vitrage',
@ -187,7 +193,7 @@ class vitrage::keystone::authtoken(
$insecure = $::os_service_default, $insecure = $::os_service_default,
$auth_section = $::os_service_default, $auth_section = $::os_service_default,
$auth_type = 'password', $auth_type = 'password',
$auth_uri = 'http://localhost:5000', $www_authenticate_uri = 'http://localhost:5000',
$auth_version = $::os_service_default, $auth_version = $::os_service_default,
$cache = $::os_service_default, $cache = $::os_service_default,
$cafile = $::os_service_default, $cafile = $::os_service_default,
@ -212,16 +218,23 @@ class vitrage::keystone::authtoken(
$manage_memcache_package = false, $manage_memcache_package = false,
$region_name = $::os_service_default, $region_name = $::os_service_default,
$token_cache_time = $::os_service_default, $token_cache_time = $::os_service_default,
# DEPRECATED PARAMETERS
$auth_uri = undef,
) { ) {
include ::vitrage::deps include ::vitrage::deps
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 { 'vitrage_config': keystone::resource::authtoken { 'vitrage_config':
username => $username, username => $username,
password => $password, password => $password,
project_name => $project_name, project_name => $project_name,
auth_url => $auth_url, auth_url => $auth_url,
auth_uri => $auth_uri, www_authenticate_uri => $www_authenticate_uri_real,
auth_version => $auth_version, auth_version => $auth_version,
auth_type => $auth_type, auth_type => $auth_type,
auth_section => $auth_section, auth_section => $auth_section,

4
releasenotes/notes/deprecate_auth_uri_parameter-8c906f4509fae5fd.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- auth_uri is deprecated and will be removed in a future release.
Please use www_authenticate_uri instead.

6
spec/classes/vitrage_keystone_authtoken_spec.rb
View File

@ -25,7 +25,7 @@ describe 'vitrage::keystone::authtoken' do
is_expected.to contain_vitrage_config('keystone_authtoken/insecure').with_value('<SERVICE DEFAULT>') is_expected.to contain_vitrage_config('keystone_authtoken/insecure').with_value('<SERVICE DEFAULT>')
is_expected.to contain_vitrage_config('keystone_authtoken/auth_section').with_value('<SERVICE DEFAULT>') is_expected.to contain_vitrage_config('keystone_authtoken/auth_section').with_value('<SERVICE DEFAULT>')
is_expected.to contain_vitrage_config('keystone_authtoken/auth_type').with_value('password') is_expected.to contain_vitrage_config('keystone_authtoken/auth_type').with_value('password')
is_expected.to contain_vitrage_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') is_expected.to contain_vitrage_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000')
is_expected.to contain_vitrage_config('keystone_authtoken/auth_version').with_value('<SERVICE DEFAULT>') is_expected.to contain_vitrage_config('keystone_authtoken/auth_version').with_value('<SERVICE DEFAULT>')
is_expected.to contain_vitrage_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>') is_expected.to contain_vitrage_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>')
is_expected.to contain_vitrage_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>') is_expected.to contain_vitrage_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>')
@ -55,7 +55,7 @@ describe 'vitrage::keystone::authtoken' do
context 'when overriding parameters' do context 'when overriding parameters' do
before do before do
params.merge!({ params.merge!({
:auth_uri => 'https://10.0.0.1:9999/', :www_authenticate_uri => 'https://10.0.0.1:9999/',
:username => 'myuser', :username => 'myuser',
:password => 'mypasswd', :password => 'mypasswd',
:auth_url => 'https://127.0.0.1:35357', :auth_url => 'https://127.0.0.1:35357',
@ -93,7 +93,7 @@ describe 'vitrage::keystone::authtoken' do
end end
it 'configure keystone_authtoken' do it 'configure keystone_authtoken' do
is_expected.to contain_vitrage_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') is_expected.to contain_vitrage_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/')
is_expected.to contain_vitrage_config('keystone_authtoken/username').with_value(params[:username]) is_expected.to contain_vitrage_config('keystone_authtoken/username').with_value(params[:username])
is_expected.to contain_vitrage_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) is_expected.to contain_vitrage_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true)
is_expected.to contain_vitrage_config('keystone_authtoken/auth_url').with_value(params[:auth_url]) is_expected.to contain_vitrage_config('keystone_authtoken/auth_url').with_value(params[:auth_url])