openstack/puppet-swift
Code Issues Proposed changes

Deprecate incomplete config_file_path

Browse Source 
Customizing this parameter now results in incomplete result because
swift_<type>_config does not allow customizing the target file path.
Let's deprecate the parameter instead of leaving this incomplete
interface.

Change-Id: Ie3fe8a34bcccaa993aedd8b6bef15ad3d237604c
This commit is contained in:
Takashi Kajinami
2023-11-26 20:59:07 +09:00
parent 0f7f6bdee8
commit bb656e5ee8
2 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
manifests/storage/server.pp
View File

@@ -145,11 +145,6 @@
# good for seeing errors if true # good for seeing errors if true
# Defaults to true. # Defaults to true.
# #
# [*config_file_path*]
# (optional) The configuration file name.
# Starting at the path "/etc/swift/"
# Defaults to "${type}-server.conf"
#
# [*statsd_enabled*] # [*statsd_enabled*]
# (optional) Should statsd configuration items be writen out to config files # (optional) Should statsd configuration items be writen out to config files
# Defaults to false. # Defaults to false.
@@ -224,6 +219,13 @@
# (optional) Time in seconds to wait between sharder cycles. # (optional) Time in seconds to wait between sharder cycles.
# Default to $facts['os_service_default']. # Default to $facts['os_service_default'].
# #
# DEPRECATED PARAMETERS
#
# [*config_file_path*]
# (optional) The configuration file name.
# Starting at the path "/etc/swift/"
# Defaults to undef
#
define swift::storage::server( define swift::storage::server(
Swift::StorageServerType $type, Swift::StorageServerType $type,
$storage_local_net_ip, $storage_local_net_ip,
@@ -258,7 +260,6 @@ define swift::storage::server(
$log_udp_port = undef, $log_udp_port = undef,
$log_requests = true, $log_requests = true,
# this parameters needs to be specified after type and name # this parameters needs to be specified after type and name
$config_file_path = "${type}-server.conf",
Boolean $statsd_enabled = false, Boolean $statsd_enabled = false,
$log_statsd_host = 'localhost', $log_statsd_host = 'localhost',
$log_statsd_port = $facts['os_service_default'], $log_statsd_port = $facts['os_service_default'],
@@ -278,11 +279,17 @@ define swift::storage::server(
$container_sharder_auto_shard = $facts['os_service_default'], $container_sharder_auto_shard = $facts['os_service_default'],
$container_sharder_concurrency = $facts['os_service_default'], $container_sharder_concurrency = $facts['os_service_default'],
$container_sharder_interval = $facts['os_service_default'], $container_sharder_interval = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$config_file_path = undef,
){ ){
include swift::deps include swift::deps
include swift::params include swift::params
if $config_file_path != undef {
warning('The config_file_path parameter is deprecated and has no effect')
}
$user_real = pick($user, $::swift::params::user) $user_real = pick($user, $::swift::params::user)
# Fail if ${type-server} isn't included in the pipeline # Fail if ${type-server} isn't included in the pipeline
@@ -334,7 +341,7 @@ define swift::storage::server(
$rsync_module = $facts['os_service_default'] $rsync_module = $facts['os_service_default']
} }
$config_file_full_path = "/etc/swift/${config_file_path}" $config_file_full_path = "/etc/swift/${type}-server.conf"
$required_middlewares = split( $required_middlewares = split(
inline_template( inline_template(
@@ -503,7 +510,6 @@ define swift::storage::server(
$log_statsd_opts, $log_statsd_opts,
$type_opts, $type_opts,
), { ), {
#'path' => $config_file_full_path,
'require' => File[$config_file_full_path] 'require' => File[$config_file_full_path]
}) })
} }

5
releasenotes/notes/deprecate-config_file_path-a0ae640ddfe329f9.yaml Normal file
View File

@@ -0,0 +1,5 @@
---
deprecations:
- |
The ``swift::storage::server::config_file_path`` parameter has been
deprecated and has no effect.