From 0877c62e924250ee0b9088d7eaf4c1d38892b8ac Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Fri, 24 Nov 2023 16:56:12 +0900
Subject: [PATCH] Deprecate support for Contrail Neutron plugin

Contrail Neutron plugin, aka Tungsten Fabric Neutron plugin, is not
aligned with the latest OpenStack release[1].

 - openstacksdk is pinned to <2.0.0 but 2.0.0 is now in global
   requirements

 - keystoneauth1 is pinned to <5.1.0 but 5.3.0 is now in global
   requirements

Because these mean that the plugin does not work with the latest
OpenStack, we expect no user is actually using it.

[1] https://github.com/tungstenfabric/tf-neutron-plugin

Change-Id: I9376c12e86a85f94742772d51811fc86f4f27d9b
---
 .../type/neutron_plugin_opencontrail.rb       |  2 +-
 manifests/config.pp                           | 21 ++++++++++++-------
 manifests/plugins/opencontrail.pp             |  3 +++
 ...cate-contrail-plugin-4c74ebcd02522deb.yaml |  5 +++++
 4 files changed, 23 insertions(+), 8 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-contrail-plugin-4c74ebcd02522deb.yaml

diff --git a/lib/puppet/type/neutron_plugin_opencontrail.rb b/lib/puppet/type/neutron_plugin_opencontrail.rb
index d8c1dcd3a..c684e278a 100644
--- a/lib/puppet/type/neutron_plugin_opencontrail.rb
+++ b/lib/puppet/type/neutron_plugin_opencontrail.rb
@@ -3,7 +3,7 @@ Puppet::Type.newtype(:neutron_plugin_opencontrail) do
   ensurable
 
   newparam(:name, :namevar => true) do
-    desc 'Section/setting name to manage from ContrailPlugin.ini'
+    desc 'Section/setting name to manage from ContrailPlugin.ini (DEPRECATED)'
     newvalues(/\S+\/\S+/)
   end
 
diff --git a/manifests/config.pp b/manifests/config.pp
index 338bcdf7b..dbf795869 100644
--- a/manifests/config.pp
+++ b/manifests/config.pp
@@ -75,9 +75,6 @@
 # [*bgp_dragent_config*]
 #   (optional) Manage configuration of bgp_dragent.ini
 #
-# [*plugin_opencontrail_config*]
-#   (optional) Manage configuration of plugins/opencontrail/ContrailPlugin.ini
-#
 # [*plugin_ml2_config*]
 #   (optional) Manage configuration of ml2_conf.ini
 #
@@ -89,6 +86,9 @@
 # [*plugin_nuage_config*]
 #   (optional) Manage configuration of plugins/nuage/plugin.ini
 #
+# [*plugin_opencontrail_config*]
+#   (optional) Manage configuration of plugins/opencontrail/ContrailPlugin.ini
+#
 #   NOTE: The configuration MUST NOT be already handled by this module
 #   or Puppet catalog compilation will fail with duplicate resources.
 #
@@ -111,11 +111,11 @@ class neutron::config (
   Hash $metering_agent_config         = {},
   Hash $vpnaas_agent_config           = {},
   Hash $bgp_dragent_config            = {},
-  Hash $plugin_opencontrail_config    = {},
   Hash $plugin_ml2_config             = {},
   # DEPRECATED PARAMETERS
-  Optional[Hash] $linuxbridge_agent_config = undef,
-  Optional[Hash] $plugin_nuage_config      = undef,
+  Optional[Hash] $linuxbridge_agent_config   = undef,
+  Optional[Hash] $plugin_nuage_config        = undef,
+  Optional[Hash] $plugin_opencontrail_config = undef,
 ) {
 
   include neutron::deps
@@ -131,6 +131,13 @@ class neutron::config (
     warning('The plugin_nuage_config parameter is deprecated and has no effect.')
   }
 
+  if $plugin_opencontrail_config != undef {
+    warning('The plugin_opencontrail_config parameter is deprecated.')
+    $plugin_opencontrail_config_real = $plugin_opencontrail_config
+  } else {
+    $plugin_opencontrail_config_real = {}
+  }
+
   create_resources('neutron_config', $server_config)
   create_resources('neutron_api_paste_ini', $api_paste_ini)
   create_resources('neutron_agent_ovs', $ovs_agent_config)
@@ -150,6 +157,6 @@ class neutron::config (
   create_resources('neutron_metering_agent_config', $metering_agent_config)
   create_resources('neutron_vpnaas_agent_config', $vpnaas_agent_config)
   create_resources('neutron_bgp_dragent_config', $bgp_dragent_config)
-  create_resources('neutron_plugin_opencontrail', $plugin_opencontrail_config)
+  create_resources('neutron_plugin_opencontrail', $plugin_opencontrail_config_real)
   create_resources('neutron_plugin_ml2', $plugin_ml2_config)
 }
diff --git a/manifests/plugins/opencontrail.pp b/manifests/plugins/opencontrail.pp
index b26710847..909f32453 100644
--- a/manifests/plugins/opencontrail.pp
+++ b/manifests/plugins/opencontrail.pp
@@ -1,3 +1,4 @@
+# DEPRECATED !!!
 # This class installs and configures Opencontrail Neutron Plugin.
 #
 # === Parameters
@@ -49,6 +50,8 @@ class neutron::plugins::opencontrail (
   include neutron::deps
   include neutron::params
 
+  warning('Support for contrail plugin has been deprecated.')
+
   $contrail_extensions_real = $contrail_extensions ? {
     Hash    => join(join_keys_to_values($contrail_extensions, ':'), ','),
     default => join(any2array($contrail_extensions), ','),
diff --git a/releasenotes/notes/deprecate-contrail-plugin-4c74ebcd02522deb.yaml b/releasenotes/notes/deprecate-contrail-plugin-4c74ebcd02522deb.yaml
new file mode 100644
index 000000000..ef17a1618
--- /dev/null
+++ b/releasenotes/notes/deprecate-contrail-plugin-4c74ebcd02522deb.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    Support for contrail plugin has been deprecated and will be removed in
+    a future release.