From 11875c34a92b68e3336b6342c5edf1163b2e8787 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <tkajinam@redhat.com>
Date: Mon, 4 May 2020 20:39:45 +0900
Subject: [PATCH] Replace deprecated drivers parameter by disabled_drivers

The [DEFAULT]drivers parameter was already deprecated in favor of the
new parameter, [DEFAULT]disabled_drivers [1].
This patch replaces the parameter in puppet-congress accordingly.

[1] 82a708abcf72892c0864c9beef1c412cf3b23194

Change-Id: I77bb6e64b6bae7811be73d4a1615764095dcf0cd
---
 manifests/init.pp                             | 26 +++++++++++++++----
 manifests/params.pp                           |  4 ---
 .../disabled_drivers-c15358e53443e819.yaml    |  9 +++++++
 3 files changed, 30 insertions(+), 9 deletions(-)
 create mode 100644 releasenotes/notes/disabled_drivers-c15358e53443e819.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index 4ebe8f9..c45d1cb 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -170,9 +170,9 @@
 #   (Optional) Password for message broker authentication
 #   Defaults to $::os_service_default
 #
-# [*drivers*]
-#   (optional) Comma delimited list of drivers for congress.
-#   Defaults to '$::congress::params::drivers'
+# [*disabled_drivers*]
+#   (optional) Comma delimited list of disabled_drivers for congress.
+#   Defaults to $::os_service_default
 #
 # [*sync_db*]
 #   (Optional) Run db sync on the node.
@@ -186,6 +186,12 @@
 #   (Optional) Ensure state for package.
 #   Defaults to present.
 #
+# DEPRECATED PARAMETERS
+#
+# [*drivers*]
+#   (optional) Comma delimited list of drivers for congress.
+#   Defaults to undef
+#
 # == Authors
 #
 #   Dan Radez <dradez@redhat.com>
@@ -230,10 +236,12 @@ class congress(
   $amqp_sasl_config_name              = $::os_service_default,
   $amqp_username                      = $::os_service_default,
   $amqp_password                      = $::os_service_default,
-  $drivers                            = $::congress::params::drivers,
+  $disabled_drivers                   = $::os_service_default,
   $sync_db                            = true,
   $package_name                       = $::congress::params::package_name,
   $package_ensure                     = 'present',
+  # DEPRECATED PARAMETERS
+  $drivers                            = undef
 ) inherits congress::params {
 
   include congress::deps
@@ -244,8 +252,16 @@ class congress(
     tag    => ['openstack', 'congress-package'],
   }
 
+  if $drivers != undef {
+    warning('The congress::drivers parameter is deprecated and will be removed \
+in a future release. Use congress::disabled_drivers instead.')
+    congress_config {
+      'DEFAULT/drivers' : value => join(any2array($drivers), ',');
+    }
+  }
+
   congress_config {
-    'DEFAULT/drivers' : value => join(any2array($drivers), ',');
+    'DEFAULT/disabled_drivers' : value => join(any2array($disabled_drivers), ',');
   }
 
   if $sync_db {
diff --git a/manifests/params.pp b/manifests/params.pp
index 9922ab9..3fda834 100644
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -6,10 +6,6 @@ class congress::params {
   include openstacklib::defaults
   $pyvers = $::openstacklib::defaults::pyvers
 
-  $drivers             = ['congress.datasources.neutronv2_driver.NeutronV2Driver,congress.datasources.glancev2_driver.GlanceV2Driver',
-                          'congress.datasources.nova_driver.NovaDriver',
-                          'congress.datasources.keystone_driver.KeystoneDriver',
-                          'congress.datasources.cinder_driver.CinderDriver']
   $client_package_name = "python${pyvers}-congressclient"
   $group               = 'congress'
 
diff --git a/releasenotes/notes/disabled_drivers-c15358e53443e819.yaml b/releasenotes/notes/disabled_drivers-c15358e53443e819.yaml
new file mode 100644
index 0000000..6fa5c3a
--- /dev/null
+++ b/releasenotes/notes/disabled_drivers-c15358e53443e819.yaml
@@ -0,0 +1,9 @@
+---
+features:
+  - |
+    The ``congress::disabled_drivers`` parameter is added to configure a list
+    of disabled drivers.
+deprecations:
+  - |
+    The ``congress::drivers`` parameter has been deprecated and will be removed
+    in a future release. Use ``congress::disabled_drivers`` instead.