From e41e9ae0819439152910fa32582c18bd51ff7a5e Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sun, 12 Nov 2023 21:48:32 +0900
Subject: [PATCH] Deprecate neutron::ensure_vpnaas_package

... because the parameter is duplicate of the neutron::services::vpnaas
class.

Change-Id: Ib3acfc8f22fe3be5ab8daf2186ce366522d07e10
---
 manifests/server.pp                            | 18 ++++++++++++------
 ...ensure_vpnaas_package-93ab950d9fdbc7a4.yaml |  5 +++++
 2 files changed, 17 insertions(+), 6 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-ensure_vpnaas_package-93ab950d9fdbc7a4.yaml

diff --git a/manifests/server.pp b/manifests/server.pp
index 5ceac9347..0543859af 100644
--- a/manifests/server.pp
+++ b/manifests/server.pp
@@ -178,11 +178,6 @@
 #   (Optional) Allow auto scheduling networks to DHCP agent
 #   Defaults to $facts['os_service_default'].
 #
-# [*ensure_vpnaas_package*]
-#   (Optional) Ensures installation of VPNaaS package before starting API service.
-#   Set to true to ensure installation of the package that is required to start neutron service if service_plugin is enabled.
-#   Defaults to false.
-#
 # [*ensure_dr_package*]
 #   (Optional) Ensures installation of Neutron Dynamic Routing package before starting API service.
 #   Set to true to ensure installation of the package that is required to start neutron service if bgp service_plugin is enabled.
@@ -235,6 +230,14 @@
 #   mechanism driver for Neutron.
 #   Defaults to $facts['os_service_default']
 #
+# DEPRECATED PARAMETERS
+#
+# [*ensure_vpnaas_package*]
+#   (Optional) Ensures installation of VPNaaS package before starting API
+#   service. Set to true to ensure installation of the package that is required
+#   to start neutron service if service_plugin is enabled.
+#   Defaults to false.
+#
 class neutron::server (
   $package_ensure                   = 'present',
   Boolean $enabled                  = true,
@@ -266,7 +269,6 @@ class neutron::server (
   $l3_ha_network_type               = $facts['os_service_default'],
   $l3_ha_network_physical_name      = $facts['os_service_default'],
   $network_auto_schedule            = $facts['os_service_default'],
-  Boolean $ensure_vpnaas_package    = false,
   Boolean $ensure_dr_package        = false,
   $vpnaas_agent_package             = false,
   $service_providers                = $facts['os_service_default'],
@@ -275,6 +277,8 @@ class neutron::server (
   $max_request_body_size            = $facts['os_service_default'],
   $ovs_integration_bridge           = $facts['os_service_default'],
   $igmp_snooping_enable             = $facts['os_service_default'],
+  # DEPRECATED PARAMETERS
+  Boolean $ensure_vpnaas_package    = false,
 ) inherits neutron::params {
 
   include neutron::deps
@@ -288,6 +292,8 @@ class neutron::server (
   }
 
   if $ensure_vpnaas_package {
+    warning("The ensure_vpnaas_package parameter has been deprecated. Use \
+the neutron::services::vpnaas class.")
     ensure_packages( 'neutron-vpnaas-agent', {
       'ensure' => $package_ensure,
       'name'   => $::neutron::params::vpnaas_agent_package,
diff --git a/releasenotes/notes/deprecate-ensure_vpnaas_package-93ab950d9fdbc7a4.yaml b/releasenotes/notes/deprecate-ensure_vpnaas_package-93ab950d9fdbc7a4.yaml
new file mode 100644
index 000000000..23fc53f43
--- /dev/null
+++ b/releasenotes/notes/deprecate-ensure_vpnaas_package-93ab950d9fdbc7a4.yaml
@@ -0,0 +1,5 @@
+---
+deprecations:
+  - |
+    The ``neutron::server::ensure_vpnaas_package`` parameter has been
+    deprecated, in favor of the new ``neutron::services::vpnaas`` class.