openstack/puppet-magnum
Code Issues Proposed changes

Deprecate revocation_cache_time option

Browse Source 
The revocation_cache_time is deprecated for removel because of PKI
token format is no longer supported.
Update warning message and add a release note.

Change-Id: I6edd1bbad778c2a9b44be9bcfc65c978b5e35132
Closes-Bug: #1717144
This commit is contained in:
ZhongShengping 2017-09-14 11:38:55 +08:00
parent 3081f9d6f4
commit 4fb1dec3df
3 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
manifests/keystone/authtoken.pp
View File

@ -168,19 +168,21 @@
# (Optional) The region in which the identity server can be found.
# Defaults to $::os_service_default.
#
# [*revocation_cache_time*]
# (Optional) Determines the frequency at which the list of revoked tokens is
# retrieved from the Identity service (in seconds). A high number of
# revocation events combined with a low cache duration may significantly
# reduce performance. Only valid for PKI tokens. Integer value
# Defaults to $::os_service_default.
#
# [*token_cache_time*]
# (Optional) In order to prevent excessive effort spent validating tokens,
# the middleware caches previously-seen tokens for a configurable duration
# (in seconds). Set to -1 to disable caching completely. Integer value
# Defaults to $::os_service_default.
#
# DEPRECATED PARAMETERS
#
# [*revocation_cache_time*]
# (Optional) Determines the frequency at which the list of revoked tokens is
# retrieved from the Identity service (in seconds). A high number of
# revocation events combined with a low cache duration may significantly
# reduce performance. Only valid for PKI tokens. Integer value
# Defaults to undef
#
class magnum::keystone::authtoken(
$password,
$username = 'magnum',
@ -215,12 +217,17 @@ class magnum::keystone::authtoken(
$memcached_servers = $::os_service_default,
$manage_memcache_package = false,
$region_name = $::os_service_default,
$revocation_cache_time = $::os_service_default,
$token_cache_time = $::os_service_default,
# DEPRECATED PARAMETERS
$revocation_cache_time = undef,
) {
include ::magnum::deps
if $revocation_cache_time {
warning('revocation_cache_time parameter is deprecated, has no effect and will be removed in the future.')
}
keystone::resource::authtoken { 'magnum_config':
username => $username,
password => $password,
@ -255,7 +262,6 @@ class magnum::keystone::authtoken(
memcached_servers => $memcached_servers,
manage_memcache_package => $manage_memcache_package,
region_name => $region_name,
revocation_cache_time => $revocation_cache_time,
token_cache_time => $token_cache_time,
}

4
releasenotes/notes/deprecate_revocation_cache_time_parameter-255ee73006a4dbf4.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- revocation_cache_time option is now deprecated for removal, the
parameter has no effect.

3
spec/classes/magnum_keystone_authtoken_spec.rb
View File

@ -50,7 +50,6 @@ describe 'magnum::keystone::authtoken' do
is_expected.to contain_magnum_config('keystone_authtoken/memcache_use_advanced_pool').with_value('<SERVICE DEFAULT>')
is_expected.to contain_magnum_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_magnum_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_magnum_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_magnum_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -91,7 +90,6 @@ describe 'magnum::keystone::authtoken' do
:memcached_servers => ['memcached01:11211','memcached02:11211'],
:manage_memcache_package => true,
:region_name => 'region2',
:revocation_cache_time => '11',
:token_cache_time => '301',
})
end
@ -132,7 +130,6 @@ describe 'magnum::keystone::authtoken' do
is_expected.to contain_magnum_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool])
is_expected.to contain_magnum_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_magnum_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_magnum_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_magnum_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end