From cf1d74e55dbe749b3e37ba31a31cf0a30296ed7c Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 3 Jan 2025 10:38:29 +0900
Subject: [PATCH] Remove support for templated catalog driver

The templated catalog driver was deprecated in keystone during 2024.1
cycle[1] and is being removed.

Support for the driver by this module was deprecated during the same
cycle[2] so can be removed now.

[1] 307296af5e170ca6b0d44fd5ec85a39bd6b5e572
[2] 29a32c74a62dcc3ae5b050538bfe97f056231d8a

Change-Id: I3c1d4683ffeacee3e137f4ced1852572e964b9bd
---
 manifests/init.pp                             | 23 +++++--------------
 ...atalog-template-file-6f783fa27eee4412.yaml |  4 ++++
 spec/classes/keystone_init_spec.rb            |  3 ---
 3 files changed, 10 insertions(+), 20 deletions(-)
 create mode 100644 releasenotes/notes/remove-catalog-template-file-6f783fa27eee4412.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 18f943221..12f6eb6ae 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -362,12 +362,6 @@
 #   (Optional) Whether to use durable queues in AMQP.
 #   Defaults to $facts['os_service_default'].
 #
-# DEPRECATED PARAMETERS
-#
-# [*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
@@ -442,21 +436,12 @@ class keystone(
   $max_request_body_size                          = $facts['os_service_default'],
   Boolean $purge_config                           = false,
   $amqp_durable_queues                            = $facts['os_service_default'],
-  # DEPRECATED PARAMETERS
-  $catalog_template_file                          = undef,
 ) inherits keystone::params {
 
   include keystone::deps
   include keystone::logging
   include keystone::policy
 
-  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') {
@@ -516,8 +501,12 @@ class keystone(
   }
 
   keystone_config {
-    'catalog/driver':        value => $catalog_driver;
-    'catalog/template_file': value => $catalog_template_file_real;
+    'catalog/driver': value => $catalog_driver;
+  }
+
+  # TODO(tkajinam): Remove this after 2025.1 release
+  keystone_config {
+    'catalog/template_file': ensure => absent;
   }
 
   keystone_config {
diff --git a/releasenotes/notes/remove-catalog-template-file-6f783fa27eee4412.yaml b/releasenotes/notes/remove-catalog-template-file-6f783fa27eee4412.yaml
new file mode 100644
index 000000000..e96e9b16d
--- /dev/null
+++ b/releasenotes/notes/remove-catalog-template-file-6f783fa27eee4412.yaml
@@ -0,0 +1,4 @@
+---
+upgrade:
+  - |
+    The ``keystone::catalog_template_file`` parameter has been removed.
diff --git a/spec/classes/keystone_init_spec.rb b/spec/classes/keystone_init_spec.rb
index aaf4f9ca2..8eea220fe 100644
--- a/spec/classes/keystone_init_spec.rb
+++ b/spec/classes/keystone_init_spec.rb
@@ -47,7 +47,6 @@ describe 'keystone' do
         )
 
         is_expected.to contain_keystone_config('catalog/driver').with_value('<SERVICE DEFAULT>')
-        is_expected.to contain_keystone_config('catalog/template_file').with_value('/etc/keystone/default_catalog.templates')
         is_expected.to contain_keystone_config('DEFAULT/max_token_size').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_keystone_config('DEFAULT/list_limit').with_value('<SERVICE DEFAULT>')
         is_expected.to contain_keystone_config('DEFAULT/notification_format').with_value('<SERVICE DEFAULT>')
@@ -155,7 +154,6 @@ describe 'keystone' do
           :enable_proxy_headers_parsing => true,
           :max_request_body_size        => 114688,
           :catalog_driver               => 'templated',
-          :catalog_template_file        => '/some/template_file',
           :max_token_size               => 255,
           :list_limit                   => 10000,
           :notification_format          => 'basic',
@@ -185,7 +183,6 @@ describe 'keystone' do
         )
 
         is_expected.to contain_keystone_config('catalog/driver').with_value('templated')
-        is_expected.to contain_keystone_config('catalog/template_file').with_value('/some/template_file')
         is_expected.to contain_keystone_config('DEFAULT/max_token_size').with_value(255)
         is_expected.to contain_keystone_config('DEFAULT/list_limit').with_value(10000)
         is_expected.to contain_keystone_config('DEFAULT/notification_format').with_value('basic')