From 9de23d4a92e95edc6da4aadc9c30ca2a084d3c40 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Sat, 20 Jan 2024 01:28:54 +0900
Subject: [PATCH] Deprecate support for [libvirt] live_mgiration_tunnelled

This option was deprecated in 23.0.0 release[1], in favor of the native
TLS support by QEMU.

[1] 14071dfb118a32b26c6ebc068c66558d37466a5a

Change-Id: Ie563aa627a9cff5601570e38d981976f1bbfeaed
---
 manifests/migration/libvirt.pp                | 33 +++++++++++--------
 ..._migration_tunnelled-b1faa98b2f905d9b.yaml |  6 ++++
 2 files changed, 26 insertions(+), 13 deletions(-)
 create mode 100644 releasenotes/notes/deprecate-live_migration_tunnelled-b1faa98b2f905d9b.yaml

diff --git a/manifests/migration/libvirt.pp b/manifests/migration/libvirt.pp
index 966611215..b3d11c4f0 100644
--- a/manifests/migration/libvirt.pp
+++ b/manifests/migration/libvirt.pp
@@ -31,17 +31,6 @@
 #   migration traffic.
 #   Defaults to $facts['os_service_default']
 #
-# [*live_migration_tunnelled*]
-#   (optional) Whether to use tunnelled migration, where migration data is
-#   transported over the libvirtd connection.
-#   If True, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the
-#   need to configure the network to allow direct hypervisor to hypervisor
-#   communication.
-#   If False, use the native transport.
-#   If not set, Nova will choose a sensible default based on, for example
-#   the availability of native encryption support in the hypervisor.
-#   Defaults to $facts['os_service_default']
-#
 # [*live_migration_with_native_tls*]
 #   (optional) This option will allow both migration stream (guest RAM plus
 #   device state) *and* disk stream to be transported over native TLS, i.e.
@@ -152,6 +141,19 @@
 #   libvirt daemon.
 #   Defaults to undef
 #
+# DEPRECATED PARAMETERS
+#
+# [*live_migration_tunnelled*]
+#   (optional) Whether to use tunnelled migration, where migration data is
+#   transported over the libvirtd connection.
+#   If True, we use the VIR_MIGRATE_TUNNELLED migration flag, avoiding the
+#   need to configure the network to allow direct hypervisor to hypervisor
+#   communication.
+#   If False, use the native transport.
+#   If not set, Nova will choose a sensible default based on, for example
+#   the availability of native encryption support in the hypervisor.
+#   Defaults to undef
+#
 class nova::migration::libvirt(
   Boolean $manage_service              = true,
   Enum['tcp', 'tls', 'ssh'] $transport = 'tcp',
@@ -159,7 +161,6 @@ class nova::migration::libvirt(
   $listen_address                      = $facts['os_service_default'],
   $migration_inbound_addr              = $facts['os_service_default'],
   $live_migration_inbound_addr         = $facts['os_service_default'],
-  $live_migration_tunnelled            = $facts['os_service_default'],
   $live_migration_with_native_tls      = $facts['os_service_default'],
   $live_migration_downtime             = $facts['os_service_default'],
   $live_migration_downtime_steps       = $facts['os_service_default'],
@@ -179,11 +180,17 @@ class nova::migration::libvirt(
   $crl_file                            = $facts['os_service_default'],
   $libvirt_version                     = $::nova::compute::libvirt::version::default,
   Optional[Boolean] $modular_libvirt   = undef,
+  # DEPRECATED PARAMETERS
+  $live_migration_tunnelled            = undef,
 ) inherits nova::compute::libvirt::version {
 
   include nova::deps
   include nova::params
 
+  if $live_migration_tunnelled != undef {
+    warning('The live_migration_tunnelled parameter has been deprecated.')
+  }
+
   $modular_libvirt_real = pick($modular_libvirt, $::nova::params::modular_libvirt)
 
   if $modular_libvirt_real and !$::nova::params::modular_libvirt_support {
@@ -220,7 +227,7 @@ class nova::migration::libvirt(
     nova_config {
       'libvirt/migration_inbound_addr':              value => $migration_inbound_addr;
       'libvirt/live_migration_uri':                  value => $live_migration_uri;
-      'libvirt/live_migration_tunnelled':            value => $live_migration_tunnelled;
+      'libvirt/live_migration_tunnelled':            value => pick($live_migration_tunnelled, $facts['os_service_default']);
       'libvirt/live_migration_with_native_tls':      value => $live_migration_with_native_tls;
       'libvirt/live_migration_downtime':             value => $live_migration_downtime;
       'libvirt/live_migration_downtime_steps':       value => $live_migration_downtime_steps;
diff --git a/releasenotes/notes/deprecate-live_migration_tunnelled-b1faa98b2f905d9b.yaml b/releasenotes/notes/deprecate-live_migration_tunnelled-b1faa98b2f905d9b.yaml
new file mode 100644
index 000000000..50ab5a8c7
--- /dev/null
+++ b/releasenotes/notes/deprecate-live_migration_tunnelled-b1faa98b2f905d9b.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    The ``live_migration_tunnelled`` parameter of
+    the ``nova::migration::libvirt`` class was deprecated, because the actual
+    parameter in nova was deprecated in 23.0.0 release.