Merge "deprecate templated guestagent config"

manifests/taskmanager.pp

@@ -71,10 +71,6 @@
 #   (optional) Trove guest agent configuration file.
 #   Defaults to '/etc/trove/trove-guestagent.conf'.
 #
-# [*use_guestagent_template*]
-#   (optional) Use template to provision trove guest agent configuration file.
-#   Defaults to true.
-#
 # [*default_neutron_networks*]
 #   (optional) The network that trove will attach by default.
 #   Defaults to undef.
@@ -83,6 +79,12 @@
 #   (optional) Message queue name the Taskmanager will listen to.
 #   Defaults to 'taskmanager'.
 #
+# DEPRECATED OPTIONS
+#
+# [*use_guestagent_template*]
+#   (optional) Use template to provision trove guest agent configuration file.
+#   Defaults to true.
+#
 class trove::taskmanager(
   $enabled                  = true,
   $manage_service           = true,
@@ -96,9 +98,10 @@ class trove::taskmanager(
   $heat_url                 = false,
   $ensure_package           = 'present',
   $guestagent_config_file   = '/etc/trove/trove-guestagent.conf',
-  $use_guestagent_template  = true,
   $default_neutron_networks = undef,
   $taskmanager_queue        = 'taskmanager',
+  #DEPRECATED OPTIONS
+  $use_guestagent_template  = true,
 ) inherits trove {
 
   include ::trove::deps
@@ -249,6 +252,7 @@ class trove::taskmanager(
 
   if $guestagent_config_file {
     if $use_guestagent_template {
+      warning('The tempated guestagent file is deprecated and will be removed in Ocata. Please configure options directly with the trove::guestagent class using hiera.')
       file { $guestagent_config_file:
         content => template('trove/trove-guestagent.conf.erb'),
         require => Anchor['trove::install::end'],

releasenotes/notes/deprecate_templated_guestagent_conf-96e92af47e01fe35.yaml

@@ -0,0 +1,7 @@
+---
+deprecations:
+  - Deprecate the templated version of guestagent.conf
+    The templated copy of guestagent.conf is outdated and
+    has been difficult to keep updated with correct defaults.
+    Therefore we deprecate this file. Values will still be
+    configured as before, but by the guestagent class.