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: Ifaad2dffab360df2790dac8d9ad8c9a87f719f6b
Closes-Bug: #1652700
changes/13/415313/1
ZhongShengping 6 years ago
parent 59e6152fcb
commit e6a6df773b
  1. 18
      manifests/api/authtoken.pp
  2. 18
      manifests/glare/authtoken.pp
  3. 18
      manifests/registry/authtoken.pp
  4. 4
      releasenotes/notes/deprecate_signing_dir_parameter-813569a35f3661e9.yaml
  5. 3
      spec/classes/glance_api_authtoken_spec.rb
  6. 3
      spec/classes/glance_glare_authtoken_spec.rb
  7. 3
      spec/classes/glance_registry_authtoken_spec.rb

@ -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 glance::api::authtoken(
$username = 'glance',
$password = $::os_service_default,
@ -219,8 +221,9 @@ class glance::api::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 ::glance::deps
@ -229,6 +232,10 @@ class glance::api::authtoken(
fail('Please set password for Glance 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 { 'glance_api_config':
username => $username,
password => $password,
@ -263,7 +270,6 @@ class glance::api::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,
}
}

@ -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 glance::glare::authtoken(
$username = 'glance',
$password = $::os_service_default,
@ -219,14 +221,19 @@ class glance::glare::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) and $::glance::glare::keystone_password == undef {
fail('Please set password for Glance 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 { 'glance_glare_config':
username => $username,
password => $password,
@ -261,7 +268,6 @@ class glance::glare::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,
}
}

@ -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 glance::registry::authtoken(
$username = 'glance',
$password = $::os_service_default,
@ -219,8 +221,9 @@ class glance::registry::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 ::glance::deps
@ -229,6 +232,10 @@ class glance::registry::authtoken(
fail('Please set password for Glance 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 { 'glance_registry_config':
username => $username,
password => $password,
@ -263,7 +270,6 @@ class glance::registry::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,
}
}

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

@ -44,7 +44,6 @@ describe 'glance::api::authtoken' do
is_expected.to contain_glance_api_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_api_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_api_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_api_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_api_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -85,7 +84,6 @@ describe 'glance::api::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 'glance::api::authtoken' do
is_expected.to contain_glance_api_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_glance_api_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_glance_api_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_glance_api_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
is_expected.to contain_glance_api_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end
end

@ -44,7 +44,6 @@ describe 'glance::glare::authtoken' do
is_expected.to contain_glance_glare_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_glare_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_glare_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_glare_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_glare_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -85,7 +84,6 @@ describe 'glance::glare::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 'glance::glare::authtoken' do
is_expected.to contain_glance_glare_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_glance_glare_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_glance_glare_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_glance_glare_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
is_expected.to contain_glance_glare_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end
end

@ -44,7 +44,6 @@ describe 'glance::registry::authtoken' do
is_expected.to contain_glance_registry_config('keystone_authtoken/memcached_servers').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_registry_config('keystone_authtoken/region_name').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_registry_config('keystone_authtoken/revocation_cache_time').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_registry_config('keystone_authtoken/signing_dir').with_value('<SERVICE DEFAULT>')
is_expected.to contain_glance_registry_config('keystone_authtoken/token_cache_time').with_value('<SERVICE DEFAULT>')
end
end
@ -85,7 +84,6 @@ describe 'glance::registry::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 'glance::registry::authtoken' do
is_expected.to contain_glance_registry_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211')
is_expected.to contain_glance_registry_config('keystone_authtoken/region_name').with_value(params[:region_name])
is_expected.to contain_glance_registry_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time])
is_expected.to contain_glance_registry_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir])
is_expected.to contain_glance_registry_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time])
end
end

Loading…
Cancel
Save