From 29a32c74a62dcc3ae5b050538bfe97f056231d8a Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 15 Mar 2024 01:48:41 +0900
Subject: [PATCH] Deprecate support for [DEFAULT] catalog_template_file

The templated catalog driver has been deprecated in keystone, so we
should deprecate support for the driver options.

Change-Id: I5f3482397883e00d447eb08bed4c57821041826c
---
 manifests/init.pp                             | 19 +++++++++++++------
 ...atalog_template_file-5f8202e78af74aa3.yaml |  5 +++++
 2 files changed, 18 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-catalog_template_file-5f8202e78af74aa3.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index d0c3180b4..742fb97f2 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -12,10 +12,6 @@
 #   (Optional) Catalog driver used by Keystone to store endpoints and services.
 #   Defaults to $facts['os_service_default'].
 #
-# [*catalog_template_file*]
-#   (Optional) Path to the catalog used if 'templated' catalog driver is used.
-#   Defaults to '/etc/keystone/default_catalog.templates'
-#
 # [*token_provider*]
 #   (Optional) Format keystone uses for tokens.
 #   Defaults to 'fernet'
@@ -342,6 +338,10 @@
 #   accepts latest or specific versions.
 #   Defaults to present.
 #
+# [*catalog_template_file*]
+#   (Optional) Path to the catalog used if 'templated' catalog driver is used.
+#   Defaults to '/etc/keystone/default_catalog.templates'
+#
 # == Authors
 #
 #   Dan Bode dan@puppetlabs.com
@@ -353,7 +353,6 @@
 class keystone(
   $package_ensure                                 = 'present',
   $catalog_driver                                 = $facts['os_service_default'],
-  $catalog_template_file                          = '/etc/keystone/default_catalog.templates',
   $token_provider                                 = 'fernet',
   $token_expiration                               = 3600,
   $password_hash_algorithm                        = $facts['os_service_default'],
@@ -412,6 +411,7 @@ class keystone(
   $amqp_durable_queues                            = $facts['os_service_default'],
   # DEPRECATED PARAMETERS
   $client_package_ensure                          = undef,
+  $catalog_template_file                          = undef,
 ) inherits keystone::params {
 
   include keystone::deps
@@ -422,6 +422,13 @@ class keystone(
     warning('The client_package_ensure parameter is deprecated and has no effect.')
   }
 
+  if $catalog_template_file != undef {
+    warning('The catalog_template_file parameter is deprecated and will be removed in a future release')
+    $catalog_template_file_real = $catalog_template_file
+  } else {
+    $catalog_template_file_real = '/etc/keystone/default_catalog.templates'
+  }
+
   if $manage_policyrcd {
     # openstacklib policy_rcd only affects debian based systems.
     if ($facts['os']['name'] == 'Ubuntu') {
@@ -478,7 +485,7 @@ class keystone(
 
   keystone_config {
     'catalog/driver':        value => $catalog_driver;
-    'catalog/template_file': value => $catalog_template_file;
+    'catalog/template_file': value => $catalog_template_file_real;
   }
 
   keystone_config {
diff --git a/releasenotes/notes/deprecate-catalog_template_file-5f8202e78af74aa3.yaml b/releasenotes/notes/deprecate-catalog_template_file-5f8202e78af74aa3.yaml
new file mode 100644
index 000000000..fadd3ef96
--- /dev/null
+++ b/releasenotes/notes/deprecate-catalog_template_file-5f8202e78af74aa3.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``keystone::catalog_template_file`` parameter has been deprecated and
+    will be removed in a futrue release.