openstack/puppet-trove
Code Issues Proposed changes

Deprecate signing_dir option

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

Change-Id: I91803e5f2c674e284657bbd40ea32b349a8f393f
Closes-Bug: #1652700
This commit is contained in:
ZhongShengping 2016-12-28 14:36:31 +08:00
parent 93e6abb334
commit 160d44ab51
3 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
manifests/keystone/authtoken.pp
View File

@ -180,16 +180,18 @@
# reduce performance. Only valid for PKI tokens. Integer value
# Defaults to $::os_service_default.
#
# [*signing_dir*]
# (Optional) Directory used to cache files related to PKI tokens.
# 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
#
# [*signing_dir*]
# (Optional) Directory used to cache files related to PKI tokens.
# Defaults to undef
#
class trove::keystone::authtoken(
$username = 'trove',
$password = $::os_service_default,
@ -224,14 +226,19 @@ class trove::keystone::authtoken(
$memcached_servers = $::os_service_default,
$region_name = $::os_service_default,
$revocation_cache_time = $::os_service_default,
$signing_dir = $::os_service_default,
$token_cache_time = $::os_service_default,
# DEPRECATED PARAMETERS
$signing_dir = undef,
) {
if is_service_default($password) {
fail('Please set password for trove service user')
}
if $signing_dir {
warning('signing_dir parameter is deprecated, has no effect and will be removed in the P release.')
}
keystone::resource::authtoken { 'trove_config':
username => $username,
password => $password,
@ -266,7 +273,6 @@ class trove::keystone::authtoken(
memcached_servers => $memcached_servers,
region_name => $region_name,
revocation_cache_time => $revocation_cache_time,
signing_dir => $signing_dir,
token_cache_time => $token_cache_time,
}
}

4
releasenotes/notes/deprecate_signing_dir_parameter-a5197a359e998f13.yaml Normal file
View File

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

3
spec/classes/trove_keystone_authtoken_spec.rb
View File

@ -44,7 +44,6 @@ describe 'trove::keystone::authtoken' do
is_expected.to contain_trove_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -85,7 +84,6 @@ describe 'trove::keystone::authtoken' do
:memcached_servers => ['memcached01:11211','memcached02:11211'],
:region_name => 'region2',
:revocation_cache_time => '11',
:signing_dir => '/var/cache',
:token_cache_time => '301',
})
end
@ -124,7 +122,6 @@ describe 'trove::keystone::authtoken' do
is_expected.to contain_trove_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_trove_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_trove_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_trove_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
is_expected.to contain_trove_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end
end