From 2d905626da10df10b25a39b2c170c7a679f7784b Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Thu, 14 Sep 2017 11:58:05 +0800 Subject: [PATCH] Deprecate revocation_cache_time option 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: Ib4030f83a9201155e5168c164d257a14b9da16e0 Closes-Bug: #1717144 --- manifests/keystone/authtoken.pp | 94 ++++++++++--------- ...cache_time_parameter-28379ba2e4a35d0c.yaml | 4 + spec/classes/trove_keystone_authtoken_spec.rb | 3 - 3 files changed, 54 insertions(+), 47 deletions(-) create mode 100644 releasenotes/notes/deprecate_revocation_cache_time_parameter-28379ba2e4a35d0c.yaml diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index 86fa4b96..8f496852 100644 --- a/manifests/keystone/authtoken.pp +++ b/manifests/keystone/authtoken.pp @@ -177,19 +177,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 trove::keystone::authtoken( $username = 'trove', $password = $::os_service_default, @@ -224,49 +226,53 @@ class trove::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, ) { if is_service_default($password) { fail('Please set password for trove service user') } + if $revocation_cache_time { + warning('revocation_cache_time parameter is deprecated, has no effect and will be removed in the future.') + } + keystone::resource::authtoken { 'trove_config': - username => $username, - password => $password, - project_name => $project_name, - auth_url => $auth_url, - auth_uri => $auth_uri, - auth_version => $auth_version, - auth_type => $auth_type, - auth_section => $auth_section, - user_domain_name => $user_domain_name, - project_domain_name => $project_domain_name, - insecure => $insecure, - cache => $cache, - cafile => $cafile, - certfile => $certfile, - check_revocations_for_cached => $check_revocations_for_cached, - delay_auth_decision => $delay_auth_decision, - enforce_token_bind => $enforce_token_bind, - hash_algorithms => $hash_algorithms, - http_connect_timeout => $http_connect_timeout, - http_request_max_retries => $http_request_max_retries, - include_service_catalog => $include_service_catalog, - keyfile => $keyfile, - memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, - memcache_pool_dead_retry => $memcache_pool_dead_retry, - memcache_pool_maxsize => $memcache_pool_maxsize, - memcache_pool_socket_timeout => $memcache_pool_socket_timeout, - memcache_secret_key => $memcache_secret_key, - memcache_security_strategy => $memcache_security_strategy, - memcache_use_advanced_pool => $memcache_use_advanced_pool, - memcache_pool_unused_timeout => $memcache_pool_unused_timeout, - 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, - } + username => $username, + password => $password, + project_name => $project_name, + auth_url => $auth_url, + auth_uri => $auth_uri, + auth_version => $auth_version, + auth_type => $auth_type, + auth_section => $auth_section, + user_domain_name => $user_domain_name, + project_domain_name => $project_domain_name, + insecure => $insecure, + cache => $cache, + cafile => $cafile, + certfile => $certfile, + check_revocations_for_cached => $check_revocations_for_cached, + delay_auth_decision => $delay_auth_decision, + enforce_token_bind => $enforce_token_bind, + hash_algorithms => $hash_algorithms, + http_connect_timeout => $http_connect_timeout, + http_request_max_retries => $http_request_max_retries, + include_service_catalog => $include_service_catalog, + keyfile => $keyfile, + memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, + memcache_pool_dead_retry => $memcache_pool_dead_retry, + memcache_pool_maxsize => $memcache_pool_maxsize, + memcache_pool_socket_timeout => $memcache_pool_socket_timeout, + memcache_secret_key => $memcache_secret_key, + memcache_security_strategy => $memcache_security_strategy, + memcache_use_advanced_pool => $memcache_use_advanced_pool, + memcache_pool_unused_timeout => $memcache_pool_unused_timeout, + memcached_servers => $memcached_servers, + manage_memcache_package => $manage_memcache_package, + region_name => $region_name, + token_cache_time => $token_cache_time, + } } diff --git a/releasenotes/notes/deprecate_revocation_cache_time_parameter-28379ba2e4a35d0c.yaml b/releasenotes/notes/deprecate_revocation_cache_time_parameter-28379ba2e4a35d0c.yaml new file mode 100644 index 00000000..438a9136 --- /dev/null +++ b/releasenotes/notes/deprecate_revocation_cache_time_parameter-28379ba2e4a35d0c.yaml @@ -0,0 +1,4 @@ +--- +deprecations: + - revocation_cache_time option is now deprecated for removal, the + parameter has no effect. diff --git a/spec/classes/trove_keystone_authtoken_spec.rb b/spec/classes/trove_keystone_authtoken_spec.rb index f0f649ac..59d1397b 100644 --- a/spec/classes/trove_keystone_authtoken_spec.rb +++ b/spec/classes/trove_keystone_authtoken_spec.rb @@ -43,7 +43,6 @@ describe 'trove::keystone::authtoken' do is_expected.to contain_trove_config('keystone_authtoken/memcache_use_advanced_pool').with_value('') is_expected.to contain_trove_config('keystone_authtoken/memcached_servers').with_value('') is_expected.to contain_trove_config('keystone_authtoken/region_name').with_value('') - is_expected.to contain_trove_config('keystone_authtoken/revocation_cache_time').with_value('') is_expected.to contain_trove_config('keystone_authtoken/token_cache_time').with_value('') end end @@ -84,7 +83,6 @@ describe 'trove::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 @@ -122,7 +120,6 @@ describe 'trove::keystone::authtoken' do is_expected.to contain_trove_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool]) 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/token_cache_time').with_value(params[:token_cache_time]) end