openstack/puppet-neutron
Code Issues Proposed changes

Deprecate metadata_memory_cache_ttl

Browse Source 
The [DEFAULT] cache_url option, which is set according to this
parameter, was already removed from neutron[1].

[1] 2e9364028b49abff28ca26836a31463c196ca6ae

Change-Id: I8e13dea10748f9af07fd20248cdf5d9d18b14ba5
This commit is contained in:
Takashi Kajinami 2024-03-16 17:15:29 +09:00
parent 9fe6a8db90
commit 53d7c4ffaa
3 changed files with 22 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
manifests/agents/metadata.pp
View File

@ -48,12 +48,6 @@
# (optional) Number of backlog requests to configure the metadata server socket with.
# Defaults to $facts['os_service_default']
#
# [*metadata_memory_cache_ttl*]
# (optional) Specifies time in seconds a metadata cache entry is valid in
# memory caching backend.
# Set to 0 will cause cache entries to never expire.
# Set to $facts['os_service_default'] or false to disable cache.
#
# [*metadata_insecure*]
# (optional) Allow to perform insecure SSL (https) requests to nova metadata.
# Defaults to $facts['os_service_default']
@ -73,6 +67,13 @@
# in the metadata config.
# Defaults to false.
#
# DEPRECATED PRAMETERS
#
# [*metadata_memory_cache_ttl*]
# (optional) Specifies time in seconds a metadata cache entry is valid in
# memory caching backend.
# Defaults to undef
#
class neutron::agents::metadata (
$shared_secret,
$package_ensure = 'present',
@ -85,18 +86,23 @@ class neutron::agents::metadata (
$metadata_protocol = $facts['os_service_default'],
$metadata_workers = $facts['os_workers'],
$metadata_backlog = $facts['os_service_default'],
$metadata_memory_cache_ttl = $facts['os_service_default'],
$metadata_insecure = $facts['os_service_default'],
$nova_client_cert = $facts['os_service_default'],
$nova_client_priv_key = $facts['os_service_default'],
$report_interval = $facts['os_service_default'],
$rpc_response_max_timeout = $facts['os_service_default'],
Boolean $purge_config = false,
# DEPRECATED PARAMETERS
$metadata_memory_cache_ttl = undef,
) {
include neutron::deps
include neutron::params
if metadata_memory_cache_ttl {
warning('The metadata_memotry_cache_ttl parameter is deprecated and has no effect.')
}
resources { 'neutron_metadata_agent_config':
purge => $purge_config,
}
@ -117,14 +123,9 @@ class neutron::agents::metadata (
'DEFAULT/rpc_response_max_timeout': value => $rpc_response_max_timeout;
}
if ! is_service_default ($metadata_memory_cache_ttl) and ($metadata_memory_cache_ttl) {
neutron_metadata_agent_config {
'DEFAULT/cache_url': value => "memory://?default_ttl=${metadata_memory_cache_ttl}";
}
} else {
neutron_metadata_agent_config {
'DEFAULT/cache_url': ensure => absent;
}
# TODO(tkajinam): Remove this after 2024.1 release
neutron_metadata_agent_config {
'DEFAULT/cache_url': ensure => absent;
}
if $::neutron::params::metadata_agent_package {

6
releasenotes/notes/deprecate-metadata_memory_cache_ttl-f439946eac8a4c0e.yaml Normal file
View File

@ -0,0 +1,6 @@
---
deprecations:
- |
The ``neutron::agents::metadata::metadata_memory_cache_ttl`` parameter has
been deprecated and has no effect now. It will be removed in a future
release.

1
spec/classes/neutron_agents_metadata_spec.rb
View File

@ -57,7 +57,6 @@ describe 'neutron::agents::metadata' do
should contain_neutron_metadata_agent_config('DEFAULT/metadata_backlog').with(:value => '<SERVICE DEFAULT>')
should contain_neutron_metadata_agent_config('DEFAULT/nova_metadata_insecure').with(:value => '<SERVICE DEFAULT>')
should contain_neutron_metadata_agent_config('DEFAULT/metadata_proxy_shared_secret').with(:value => params[:shared_secret]).with_secret(true)
should contain_neutron_metadata_agent_config('DEFAULT/cache_url').with(:ensure => 'absent')
should contain_neutron_metadata_agent_config('agent/report_interval').with(:value => '<SERVICE DEFAULT>')
should contain_neutron_metadata_agent_config('DEFAULT/rpc_response_max_timeout').with(:value => '<SERVICE DEFAULT>')
end