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: Ie9c4c339374af50f5d1a8b3dbf6bf632c5bf06ef
Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316
Closes-Bug: #1759098
This commit is contained in:
ZhongShengping 2018-04-03 16:54:59 +08:00
parent 8c891f34a9
commit 550af1d282
3 changed files with 23 additions and 6 deletions

View File

@ -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'.
#
@ -183,6 +183,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 designate::keystone::authtoken(
$username = 'designate',
$password = $::os_service_default,
@ -193,7 +199,7 @@ class designate::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,
@ -218,6 +224,8 @@ class designate::keystone::authtoken(
$manage_memcache_package = false,
$region_name = $::os_service_default,
$token_cache_time = $::os_service_default,
# DEPRECATED PARAMETERS
$auth_uri = undef,
) {
include ::designate::deps
@ -226,12 +234,17 @@ class designate::keystone::authtoken(
fail('Please set password for designate 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 { 'designate_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,

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.

View File

@ -20,7 +20,7 @@ describe 'designate::keystone::authtoken' do
is_expected.to contain_designate_config('keystone_authtoken/insecure').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('keystone_authtoken/auth_section').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('keystone_authtoken/auth_type').with_value('password')
is_expected.to contain_designate_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000')
is_expected.to contain_designate_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000')
is_expected.to contain_designate_config('keystone_authtoken/auth_version').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>')
is_expected.to contain_designate_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>')
@ -50,7 +50,7 @@ describe 'designate::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 'designate::keystone::authtoken' do
end
it 'configure keystone_authtoken' do
is_expected.to contain_designate_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/')
is_expected.to contain_designate_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/')
is_expected.to contain_designate_config('keystone_authtoken/username').with_value(params[:username])
is_expected.to contain_designate_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true)
is_expected.to contain_designate_config('keystone_authtoken/auth_url').with_value(params[:auth_url])