From 3fe4b7d3a0ae0c7f76471a5c230b71caa7f242ef Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Fri, 4 Mar 2022 03:02:42 +0900
Subject: [PATCH] Deprecate ineffective watcher_client_default_domain_name
 parameter

The parameter has never been implemented actually and has had no effect
since the module was initially created. Because the default_domain_name
parameter is not generally used in the other modules, this change
deprecates the parameter instead of implementing the logic to use it.

Change-Id: I16d87e403d7412831704c5d683599764bad3c882
---
 manifests/api.pp                               | 18 +++++++++++-------
 ...e-default_domain_name-b29df5955675de28.yaml |  5 +++++
 2 files changed, 16 insertions(+), 7 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-default_domain_name-b29df5955675de28.yaml

diff --git a/manifests/api.pp b/manifests/api.pp
index cd043ba..ccd445f 100644
--- a/manifests/api.pp
+++ b/manifests/api.pp
@@ -57,12 +57,6 @@
 #   API endpoint to represent SSL termination URL with 'public_endpoint' option.
 #   Defaults to $::os_service_default.
 #
-# [*watcher_client_default_domain_name*]
-#   (Optional)domain name to use with v3 API and v2 parameters. It will
-#   be used for both the user and project domain in v3 and ignored in v2
-#   authentication.
-#   Defaults to $::os_service_default
-#
 # [*watcher_client_project_name*]
 #   (Optional) Service project name.
 #   Defaults to 'services'
@@ -163,6 +157,12 @@
 #   (Optional) Public Identity API endpoint.
 #   Defaults to undef
 #
+# [*watcher_client_default_domain_name*]
+#   (Optional)domain name to use with v3 API and v2 parameters. It will
+#   be used for both the user and project domain in v3 and ignored in v2
+#   authentication.
+#   Defaults to undef
+#
 class watcher::api (
   $watcher_client_password,
   $watcher_client_username            = 'watcher',
@@ -175,7 +175,6 @@ class watcher::api (
   $bind_host                          = '0.0.0.0',
   $workers                            = $::os_workers,
   $enable_ssl_api                     = $::os_service_default,
-  $watcher_client_default_domain_name = $::os_service_default,
   $watcher_client_project_name        = 'services',
   $watcher_client_certfile            = $::os_service_default,
   $watcher_client_cafile              = $::os_service_default,
@@ -197,6 +196,7 @@ class watcher::api (
   $watcher_api_workers                = undef,
   $watcher_api_enable_ssl_api         = undef,
   $watcher_client_auth_uri            = undef,
+  $watcher_client_default_domain_name = undef,
 ) inherits watcher::params {
 
   include watcher::policy
@@ -305,4 +305,8 @@ as a standalone service, or httpd for being run by a httpd server")
     'watcher_clients_auth/auth_uri': ensure => absent;
   }
 
+  if $watcher_client_default_domain_name != undef {
+    warning('The watcher_client_default_domain_name parameter is deprecated and has no effect.')
+  }
+
 }
diff --git a/releasenotes/notes/deprecate-default_domain_name-b29df5955675de28.yaml b/releasenotes/notes/deprecate-default_domain_name-b29df5955675de28.yaml
new file mode 100644
index 0000000..76d1af9
--- /dev/null
+++ b/releasenotes/notes/deprecate-default_domain_name-b29df5955675de28.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``watcher::api::watcher_client_default_domain_name`` parameter has been
+    deprecated. The parameter has never been used actually.