From 42d74471dd1f6f4104a3be0218f007566342bedd Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Tue, 22 Dec 2020 23:26:52 +0900
Subject: [PATCH] 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
---
 manifests/proxy/s3api.pp                      | 19 +++++++++++++------
 ...precate-s3api-ensure-3d036cfc32340b16.yaml |  5 +++++
 2 files changed, 18 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-s3api-ensure-3d036cfc32340b16.yaml

diff --git a/manifests/proxy/s3api.pp b/manifests/proxy/s3api.pp
index d6622b05..9c7a6120 100644
--- a/manifests/proxy/s3api.pp
+++ b/manifests/proxy/s3api.pp
@@ -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;
   }
diff --git a/releasenotes/notes/deprecate-s3api-ensure-3d036cfc32340b16.yaml b/releasenotes/notes/deprecate-s3api-ensure-3d036cfc32340b16.yaml
new file mode 100644
index 00000000..9191d687
--- /dev/null
+++ b/releasenotes/notes/deprecate-s3api-ensure-3d036cfc32340b16.yaml
@@ -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.