openstack
/
puppet-barbican
Code Issues Proposed changes

Deprecate signing_dir option 

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

Change-Id: Ibabd9a446078d38ec7c12a5a4a21a97d992881ff
Closes-Bug: #1652700
This commit is contained in:
ZhongShengping 2016-12-27 11:47:10 +08:00
parent c784b9488a
commit 34644420e1
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

@ -175,16 +175,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 barbican::keystone::authtoken(
$password = $::os_service_default,
$username = 'barbican',
@ -219,8 +221,9 @@ class barbican::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,
) {
include ::barbican::deps
@ -229,6 +232,10 @@ class barbican::keystone::authtoken(
fail('Please set password for barbican 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 { 'barbican_config':
username => $username,
password => $password,
@ -263,7 +270,6 @@ class barbican::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-87135a9713d2345f.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/barbican_keystone_authtoken_spec.rb
View File

@ -63,7 +63,6 @@ describe 'barbican::keystone::authtoken' do
is_expected.to contain_barbican_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_barbican_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_barbican_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_barbican_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
is_expected.to contain_barbican_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -104,7 +103,6 @@ describe 'barbican::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
@ -143,7 +141,6 @@ describe 'barbican::keystone::authtoken' do
is_expected.to contain_barbican_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_barbican_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_barbican_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_barbican_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
is_expected.to contain_barbican_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end
end