Deprecate support for NSX plugin

The NSX plugin repo looks unmaintained. No release was created since
Victoria and the repository does not have a few stable branches
(wallaby and xena). Master has not been updated for a while but only
a few stable branches are maintained. (eg. [1])

We asked project status in the mailing list[2] and I also tried to
directly reach out to the maintainer but we haven't heard any response.

Also, VMWare already announced that NSX-T 3.y will be the last release
series which supports KVM based OpenStack and they support only their
own OpenStack distribution (VIO)[3].

Based on the above items, we assume there would be no user interested
in using puppet-neutron to deploy RHEL/Ubuntu based OpenStack with
NSX-T integrated, and deprecate support for the plugin, so that we can
remove the unused implementation completely after the Zed release.

[1]
e5b7a2f680604244a800e329d9afbbaedc4097e9 was merged in xena but has
never been proposed or merged to master.

[2]
http://lists.openstack.org/pipermail/openstack-discuss/2022-May/028573.html

[3]
https://docs.vmware.com/en/VMware-NSX-T-Data-Center/3.2/rn/vmware-nsxt-data-center-32-release-notes/index.html#feature--api-deprecations-and-behavior-changes

Change-Id: I4cfd26bb39155f74008640094585a8328f8a7bca

lib/puppet/type/neutron_plugin_nsx.rb

@@ -3,7 +3,7 @@ Puppet::Type.newtype(:neutron_plugin_nsx) do
   ensurable
 
   newparam(:name, :namevar => true) do
-    desc 'Section/setting name to manage from vmware/nsx.ini'
+    desc 'Section/setting name to manage from vmware/nsx.ini (DEPRECATED)'
     newvalues(/\S+\/\S+/)
   end
 

manifests/config.pp

@@ -84,9 +84,6 @@
 # [*plugin_ml2_config*]
 #   (optional) Manage configuration of ml2_conf.ini
 #
-# [*plugin_nsx_config*]
-#   (optional) Manage configuration of plugins/vmware/nsx.ini
-#
 # DEPRECATED PARAMETERS
 #
 # [*plugin_nvp_config*]
@@ -95,6 +92,9 @@
 # [*plugin_linuxbridge_config*]
 #   (optional) Manage configuration of linuxbridge_conf.ini
 #
+# [*plugin_nsx_config*]
+#   (optional) Manage configuration of plugins/vmware/nsx.ini
+#
 #   NOTE: The configuration MUST NOT be already handled by this module
 #   or Puppet catalog compilation will fail with duplicate resources.
 #
@@ -120,10 +120,10 @@ class neutron::config (
   $plugin_opencontrail_config    = {},
   $plugin_nuage_config           = {},
   $plugin_ml2_config             = {},
-  $plugin_nsx_config             = {},
   # DEPRECATED PARAMETERS
   $plugin_nvp_config             = undef,
   $plugin_linuxbridge_config     = undef,
+  $plugin_nsx_config             = undef,
 ) {
 
   include neutron::deps
@@ -136,6 +136,13 @@ class neutron::config (
     warning('The plugin_linuxbridge_config parameter is deprecated and has no effect.')
   }
 
+  if $plugin_nsx_config != undef {
+    warning('The plugin_nsx_config parameter is deprecated.')
+    $plugin_nsx_config_real = $plugin_nsx_config
+  } else {
+    $plugin_nsx_config_real = {}
+  }
+
   validate_legacy(Hash, 'validate_hash', $server_config)
   validate_legacy(Hash, 'validate_hash', $api_paste_ini)
   validate_legacy(Hash, 'validate_hash', $ovs_agent_config)
@@ -157,7 +164,7 @@ class neutron::config (
   validate_legacy(Hash, 'validate_hash', $plugin_opencontrail_config)
   validate_legacy(Hash, 'validate_hash', $plugin_nuage_config)
   validate_legacy(Hash, 'validate_hash', $plugin_ml2_config)
-  validate_legacy(Hash, 'validate_hash', $plugin_nsx_config)
+  validate_legacy(Hash, 'validate_hash', $plugin_nsx_config_real)
 
   create_resources('neutron_config', $server_config)
   create_resources('neutron_api_paste_ini', $api_paste_ini)
@@ -180,5 +187,5 @@ class neutron::config (
   create_resources('neutron_plugin_opencontrail', $plugin_opencontrail_config)
   create_resources('neutron_plugin_nuage', $plugin_nuage_config)
   create_resources('neutron_plugin_ml2', $plugin_ml2_config)
-  create_resources('neutron_plugin_nsx', $plugin_nsx_config)
+  create_resources('neutron_plugin_nsx', $plugin_nsx_config_real)
 }

manifests/plugins/nsx.pp

@@ -1,4 +1,5 @@
 #
+# DEPRECATED !!
 # Configure the VMware NSX plugin for neutron.
 #
 # === Parameters
@@ -86,6 +87,8 @@ class neutron::plugins::nsx (
   include neutron::deps
   include neutron::params
 
+  warning('Support for NSX plugin has been deprecated and will be removed.')
+
   package { 'vmware-nsx':
     ensure => $package_ensure,
     name   => $::neutron::params::nsx_plugin_package,

releasenotes/notes/deprecate-nsx-039f4a3daaf6e56b.yaml

@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    Support for the NSX plugin has been deprecated and will be removed in
+    a future release.