diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index 77dbe187..19f0294e 100644 --- a/manifests/keystone/authtoken.pp +++ b/manifests/keystone/authtoken.pp @@ -172,19 +172,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 sahara::keystone::authtoken( $username = 'sahara', $password = $::os_service_default, @@ -219,17 +221,22 @@ class sahara::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, ) { -#NOTE(emilien): Use pick to keep backward compatibility -$username_real = pick($::sahara::admin_user,$username) -$password_real = pick($::sahara::admin_password,$password) -$project_name_real = pick($::sahara::admin_tenant_name,$project_name) -$memcached_servers_real = pick($::sahara::memcached_servers,$memcached_servers) -$auth_uri_real = pick($::sahara::auth_uri,$auth_uri) -$auth_url_real = pick($::sahara::identity_uri,$auth_url) + #NOTE(emilien): Use pick to keep backward compatibility + $username_real = pick($::sahara::admin_user,$username) + $password_real = pick($::sahara::admin_password,$password) + $project_name_real = pick($::sahara::admin_tenant_name,$project_name) + $memcached_servers_real = pick($::sahara::memcached_servers,$memcached_servers) + $auth_uri_real = pick($::sahara::auth_uri,$auth_uri) + $auth_url_real = pick($::sahara::identity_uri,$auth_url) + + if $revocation_cache_time { + warning('revocation_cache_time parameter is deprecated, has no effect and will be removed in the future.') + } keystone::resource::authtoken { 'sahara_config': username => $username_real, @@ -265,7 +272,6 @@ $auth_url_real = pick($::sahara::identity_uri,$auth_url) memcached_servers => $memcached_servers_real, manage_memcache_package => $manage_memcache_package, region_name => $region_name, - revocation_cache_time => $revocation_cache_time, token_cache_time => $token_cache_time, } } diff --git a/releasenotes/notes/deprecate_revocation_cache_time_parameter-7e6e3ab6bfc3e3c9.yaml b/releasenotes/notes/deprecate_revocation_cache_time_parameter-7e6e3ab6bfc3e3c9.yaml new file mode 100644 index 00000000..438a9136 --- /dev/null +++ b/releasenotes/notes/deprecate_revocation_cache_time_parameter-7e6e3ab6bfc3e3c9.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/sahara_keystone_authtoken_spec.rb b/spec/classes/sahara_keystone_authtoken_spec.rb index 15e10f89..ba657549 100644 --- a/spec/classes/sahara_keystone_authtoken_spec.rb +++ b/spec/classes/sahara_keystone_authtoken_spec.rb @@ -43,7 +43,6 @@ describe 'sahara::keystone::authtoken' do is_expected.to contain_sahara_config('keystone_authtoken/memcache_use_advanced_pool').with_value('') is_expected.to contain_sahara_config('keystone_authtoken/memcached_servers').with_value('') is_expected.to contain_sahara_config('keystone_authtoken/region_name').with_value('') - is_expected.to contain_sahara_config('keystone_authtoken/revocation_cache_time').with_value('') is_expected.to contain_sahara_config('keystone_authtoken/token_cache_time').with_value('') end end @@ -86,7 +85,6 @@ describe 'sahara::keystone::authtoken' do ['memcached01:11211','memcached02:11211'], :manage_memcache_package => true, :region_name => 'region2', - :revocation_cache_time => '11', :token_cache_time => '301', }) end @@ -124,7 +122,6 @@ describe 'sahara::keystone::authtoken' do is_expected.to contain_sahara_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool]) is_expected.to contain_sahara_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211') is_expected.to contain_sahara_config('keystone_authtoken/region_name').with_value(params[:region_name]) - is_expected.to contain_sahara_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time]) is_expected.to contain_sahara_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time]) end