Deprecate ineffective swift::proxy::s3api::ensure

The swift::proxy::s3api::ensure parameter is currently unused. Let's
just deprecate the parameter because it is useless.

Change-Id: I57463d8d6c6756793d397371648ce692dd2c2d09
This commit is contained in:
Takashi Kajinami 2020-12-22 23:26:52 +09:00
parent f5c4b00ae5
commit 42d74471dd
2 changed files with 18 additions and 6 deletions

View File

@ -5,10 +5,6 @@
#
# == Parameters
#
# [*ensure*]
# Enable or not s3api middleware
# Defaults to 'present'
#
# [*auth_pipeline_check*]
# Enable pipeline order check
# Defaults to 'false'
@ -17,16 +13,27 @@
# Max upload per num
# Default to 1000.
#
# DEPRECATED PARAMETERS
#
# [*ensure*]
# Enable or not s3api middleware
# Defaults to undef
#
class swift::proxy::s3api(
$ensure = 'present',
$auth_pipeline_check = false,
$max_upload_part_num = 1000,
# DEPRECATED PARAMETERS
$ensure = undef,
) {
include swift::deps
if $ensure != undef {
warning('The ensure parameter has been deprecated and has no effect')
}
swift_proxy_config {
'filter:s3api/use': value => 'egg:swift#s3api';
'filter:s3api/use': value => 'egg:swift#s3api';
'filter:s3api/auth_pipeline_check': value => $auth_pipeline_check;
'filter:s3api/max_upload_part_num': value => $max_upload_part_num;
}

View File

@ -0,0 +1,5 @@
---
deprecations:
- |
The ``swift::proxy::s3api`` parameter has been deprecated, since this
parameter has had no effect. It will be removed in a future release.