Deprecate heat_clients_keystone_uri

The heat_clients_keystone_uri parameter sets the
[clients_keystone]/auth_uri option which does not
exist anymore, see [1].

[1] https://docs.openstack.org/heat/latest/configuration/sample_config.html

Change-Id: I8cf34475aa0868da800bc5f37d20341f755b38a2

manifests/init.pp

@@ -264,10 +264,6 @@
 #   (optional) Heat url in format like http://0.0.0.0:8004/v1/%(tenant_id)s.
 #   Defaults to $::os_service_default.
 #
-# [*heat_clients_keystone_uri*]
-#   (optional) Heat clients auth url in format like http://127.0.0.1:5000/.
-#   Defaults to $::os_service_default.
-#
 # [*heat_clients_endpoint_type*]
 #   (optional) Type of endpoint in Identity service catalog to use for
 #   communication with the OpenStack service.
@@ -292,6 +288,12 @@
 #     take for evaluation.
 #   Defaults to $::os_service_default.
 #
+## DEPRECATED PARAMS
+#
+# [*heat_clients_keystone_uri*]
+#   (optional) Heat clients auth url in format like http://127.0.0.1:5000/.
+#   Defaults to undef.
+#
 class heat(
   $package_ensure                     = 'present',
   $debug                              = undef,
@@ -351,12 +353,13 @@ class heat(
   $notification_topics                = $::os_service_default,
   $enable_proxy_headers_parsing       = $::os_service_default,
   $heat_clients_url                   = $::os_service_default,
-  $heat_clients_keystone_uri          = $::os_service_default,
   $heat_clients_endpoint_type         = $::os_service_default,
   $purge_config                       = false,
   $auth_strategy                      = 'keystone',
   $yaql_memory_quota                  = $::os_service_default,
   $yaql_limit_iterators               = $::os_service_default,
+  ## DEPRECATED PARAMS
+  $heat_clients_keystone_uri          = undef,
 ) {
 
   include ::heat::logging
@@ -364,6 +367,10 @@ class heat(
   include ::heat::deps
   include ::heat::params
 
+  if $heat_clients_keystone_uri {
+    warning('heat_clients_keystone_ur is deprecated, has no effect and will be removed in the future')
+  }
+
   if $auth_strategy == 'keystone' {
     include ::heat::keystone::authtoken
   }
@@ -418,12 +425,6 @@ class heat(
   $keystone_password = $::heat::keystone::authtoken::password
   $keystone_project_domain_name = $::heat::keystone::authtoken::project_domain_name
   $keystone_user_domain_name = $::heat::keystone::authtoken::user_domain_name
-  if (defined($heat_clients_keystone_uri)) {
-    $heat_clients_keystone_uri_real = $heat_clients_keystone_uri
-  } else {
-    $heat_clients_keystone_uri_real = $www_authenticate_uri
-  }
-
 
   heat_config {
     'trustee/auth_type':           value => 'password';
@@ -432,7 +433,6 @@ class heat(
     'trustee/password':            value => $keystone_password, secret => true;
     'trustee/project_domain_name': value => $keystone_project_domain_name;
     'trustee/user_domain_name':    value => $keystone_user_domain_name;
-    'clients_keystone/auth_uri':   value => $heat_clients_keystone_uri_real;
     'clients_heat/url':            value => $heat_clients_url;
     'clients/endpoint_type':       value => $heat_clients_endpoint_type;
   }

releasenotes/notes/deprecate-client-keystone-auth-uri-4490508fd0673959.yaml

@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The heat::heat_clients_keystone_uri parameter is deprecated, has no effect
+    and will be removed in a future release.

spec/classes/heat_init_spec.rb

@@ -120,10 +120,6 @@ describe 'heat' do
       is_expected.to contain_heat_config('trustee/password').with_secret( true )
     end
 
-    it 'configures auth_uri for clients_keystone' do
-      is_expected.to contain_heat_config('clients_keystone/auth_uri').with_value( 'http://127.0.0.1:5000/' )
-    end
-
     it 'configures endpoint_type for clients' do
       is_expected.to contain_heat_config('clients/endpoint_type').with_value( '<SERVICE DEFAULT>' )
     end
@@ -427,11 +423,6 @@ describe 'heat' do
     end
   end
 
-  shared_examples_for "with custom heat_clients_keystone_uri" do
-      before { params.merge!( :heat_clients_keystone_uri => 'https://domain1/' ) }
-      it { is_expected.to contain_heat_config('clients_keystone/auth_uri').with_value('https://domain1/') }
-  end
-
   on_supported_os({
     :supported_os   => OSDefaults.get_supported_os
   }).each do |os,facts|