From 646c5d35c00618dca5f0ff3283bdfb2c02070d8c Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Tue, 3 Jun 2025 00:37:26 +0900
Subject: [PATCH] Deprecate support for vlan_transparent and vlan_qinq

... because the actual options in neutron were deprecated during this
cycle.

Depends-on: https://review.opendev.org/951136
Change-Id: Ia84c061465f0f0d3e404d9714dc288459084a3db
---
 manifests/init.pp                             | 37 ++++++++++++-------
 ...parent-and-vlan_qinq-8864567b5d865ecf.yaml |  5 +++
 2 files changed, 28 insertions(+), 14 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-vlan_transparent-and-vlan_qinq-8864567b5d865ecf.yaml

diff --git a/manifests/init.pp b/manifests/init.pp
index ef5242434..5a984a0c9 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -271,16 +271,6 @@
 #   (optional) Maximum number of allowed address pairs per port
 #   Defaults to $facts['os_service_default'].
 #
-# [*vlan_transparent*]
-#   (optional) Allow plugins that support it to create VLAN transparent
-#   networks.
-#   Defaults to $facts['os_service_default'].
-#
-# [*vlan_qinq*]
-#   (optional) Allow plugins that support it to create VLAN transparent
-#   networks using 0x8a88 ethertype.
-#   Defaults to $facts['os_service_default'].
-#
 # DEPRECATED PARAMETERS
 #
 # [*rabbit_heartbeat_in_pthread*]
@@ -293,6 +283,16 @@
 #   will be run through a green thread.
 #   Defaults to undef
 #
+# [*vlan_transparent*]
+#   (optional) Allow plugins that support it to create VLAN transparent
+#   networks.
+#   Defaults to undef.
+#
+# [*vlan_qinq*]
+#   (optional) Allow plugins that support it to create VLAN transparent
+#   networks using 0x8a88 ethertype.
+#   Defaults to undef.
+#
 class neutron (
   $package_ensure                       = 'present',
   $bind_host                            = $facts['os_service_default'],
@@ -350,15 +350,24 @@ class neutron (
   $notification_topics                  = $facts['os_service_default'],
   $notification_retry                   = $facts['os_service_default'],
   $max_allowed_address_pair             = $facts['os_service_default'],
-  $vlan_transparent                     = $facts['os_service_default'],
-  $vlan_qinq                            = $facts['os_service_default'],
   # DEPRECATED PARAMETERS
   $rabbit_heartbeat_in_pthread          = undef,
+  $vlan_transparent                     = undef,
+  $vlan_qinq                            = undef,
 ) {
 
   include neutron::deps
   include neutron::params
 
+  if $vlan_transparent != undef {
+    warning("The vlan_transparent parameter has been deprecated and \
+will be removed in a future release")
+  }
+  if $vlan_qinq != undef {
+    warning("The vlan_qinq parameter has been deprecated and \
+will be removed in a future release")
+  }
+
   if ! is_service_default($use_ssl) and ($use_ssl) {
     if is_service_default($cert_file) {
       fail('The cert_file parameter is required when use_ssl is set to true')
@@ -394,8 +403,8 @@ class neutron (
     'DEFAULT/state_path':               value => $state_path;
     'DEFAULT/global_physnet_mtu':       value => $global_physnet_mtu;
     'DEFAULT/max_allowed_address_pair': value => $max_allowed_address_pair;
-    'DEFAULT/vlan_transparent':         value => $vlan_transparent;
-    'DEFAULT/vlan_qinq':                value => $vlan_qinq;
+    'DEFAULT/vlan_transparent':         value => pick($vlan_transparent, $facts['os_service_default']);
+    'DEFAULT/vlan_qinq':                value => pick($vlan_qinq, $facts['os_service_default']);
     'agent/root_helper':                value => $root_helper;
     'agent/root_helper_daemon':         value => $root_helper_daemon;
     'agent/report_interval':            value => $report_interval;
diff --git a/releasenotes/notes/deprecate-vlan_transparent-and-vlan_qinq-8864567b5d865ecf.yaml b/releasenotes/notes/deprecate-vlan_transparent-and-vlan_qinq-8864567b5d865ecf.yaml
new file mode 100644
index 000000000..1c4694dde
--- /dev/null
+++ b/releasenotes/notes/deprecate-vlan_transparent-and-vlan_qinq-8864567b5d865ecf.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``neutron::vlan_transparent`` parameter and the ``neutron::vlan_qinq``
+    parameter have been deprecated and will be removed in a future release.