openstack/puppet-nova
Code Issues Proposed changes

Deprecate support for [api] use_forwarded_for

Browse Source 
... because the parameter was already deprecated.

Change-Id: I95b7730c507bf290b084acd229f72d348b83da38
Related-Bug: #1967686
Depends-on: https://review.opendev.org/836253
This commit is contained in:
Takashi Kajinami
2022-05-03 16:54:24 +09:00
parent 8761795c43
commit a57b4eb2c9
2 changed files with 17 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
manifests/api.pp
View File

@@ -36,11 +36,6 @@
# (optional) A list of apis to enable # (optional) A list of apis to enable
# Defaults to ['osapi_compute', 'metadata'] # Defaults to ['osapi_compute', 'metadata']
# #
# [*use_forwarded_for*]
# (optional) Treat X-Forwarded-For as the canonical remote address. Only
# enable this if you have a sanitizing proxy.
# Defaults to $::os_service_default
#
# [*osapi_compute_workers*] # [*osapi_compute_workers*]
# (optional) Number of workers for OpenStack API service # (optional) Number of workers for OpenStack API service
# Defaults to $::os_workers # Defaults to $::os_workers
@@ -190,6 +185,11 @@
# Require validate set at True. # Require validate set at True.
# Defaults to undef # Defaults to undef
# #
# [*use_forwarded_for*]
# (optional) Treat X-Forwarded-For as the canonical remote address. Only
# enable this if you have a sanitizing proxy.
# Defaults to undef
#
class nova::api( class nova::api(
$enabled = true, $enabled = true,
$manage_service = true, $manage_service = true,
@@ -200,7 +200,6 @@ class nova::api(
$metadata_listen = $::os_service_default, $metadata_listen = $::os_service_default,
$metadata_listen_port = $::os_service_default, $metadata_listen_port = $::os_service_default,
$enabled_apis = ['osapi_compute', 'metadata'], $enabled_apis = ['osapi_compute', 'metadata'],
$use_forwarded_for = $::os_service_default,
$osapi_compute_workers = $::os_workers, $osapi_compute_workers = $::os_workers,
$metadata_workers = $::os_workers, $metadata_workers = $::os_workers,
$sync_db = true, $sync_db = true,
@@ -231,6 +230,7 @@ class nova::api(
$ratelimits_factory = undef, $ratelimits_factory = undef,
$validate = undef, $validate = undef,
$validation_options = undef, $validation_options = undef,
$use_forwarded_for = undef,
) inherits nova::params { ) inherits nova::params {
include nova::deps include nova::deps
@@ -259,6 +259,10 @@ class nova::api(
warning('The nova::api::validation_options parameter has been deprecated and has no effect') warning('The nova::api::validation_options parameter has been deprecated and has no effect')
} }
if $use_forwarded_for != undef {
warning('The use_forwarded_for parameter has been deprecated.')
}
if $instance_name_template { if $instance_name_template {
$instance_name_template_real = $instance_name_template $instance_name_template_real = $instance_name_template
} else { } else {
@@ -353,7 +357,7 @@ as a standalone service, or httpd for being run by a httpd server")
'DEFAULT/osapi_compute_workers': value => $osapi_compute_workers; 'DEFAULT/osapi_compute_workers': value => $osapi_compute_workers;
'DEFAULT/enable_network_quota': value => $enable_network_quota; 'DEFAULT/enable_network_quota': value => $enable_network_quota;
'DEFAULT/password_length': value => $password_length; 'DEFAULT/password_length': value => $password_length;
'api/use_forwarded_for': value => $use_forwarded_for; 'api/use_forwarded_for': value => pick($use_forwarded_for, $::os_service_default);
'api/max_limit': value => $max_limit; 'api/max_limit': value => $max_limit;
'api/compute_link_prefix': value => $compute_link_prefix; 'api/compute_link_prefix': value => $compute_link_prefix;
'api/glance_link_prefix': value => $glance_link_prefix; 'api/glance_link_prefix': value => $glance_link_prefix;

6
releasenotes/notes/deprecate-use_forwarded_for-d6b8f36bb949c051.yaml Normal file
View File

@@ -0,0 +1,6 @@
---
deprecations:
- |
The ``nova::api::use_forwarded_for`` parameter has been deprecated and will
be removed in a future release, because the corresponding
``[api] use_forwarded_for`` parameter in nova has been deprecated.