(PE-40372) Add optional replica host to migration plan

This commit extends the migration plan to support and utilise an
optional new replica host parameter.

Author: petergmurphy

REFERENCE.md

@@ -2322,6 +2322,8 @@ The following parameters are available in the `peadm::migrate` plan:
 
 * [`old_primary_host`](#-peadm--migrate--old_primary_host)
 * [`new_primary_host`](#-peadm--migrate--new_primary_host)
+* [`upgrade_version`](#-peadm--migrate--upgrade_version)
+* [`replica_host`](#-peadm--migrate--replica_host)
 
 ##### <a name="-peadm--migrate--old_primary_host"></a>`old_primary_host`
 
@@ -2335,6 +2337,22 @@ Data type: `Peadm::SingleTargetSpec`
 
 The new server that will become the PE primary server
 
+##### <a name="-peadm--migrate--upgrade_version"></a>`upgrade_version`
+
+Data type: `Optional[String]`
+
+Optional version to upgrade to after migration is complete
+
+Default value: `undef`
+
+##### <a name="-peadm--migrate--replica_host"></a>`replica_host`
+
+Data type: `Optional[SingleTargetSpec]`
+
+
+
+Default value: `undef`
+
 ### <a name="peadm--modify_certificate"></a>`peadm::modify_certificate`
 
 Certificates can be modified by adding extensions, removing extensions, or

plans/migrate.pp

@@ -11,6 +11,7 @@
   Peadm::SingleTargetSpec $old_primary_host,
   Peadm::SingleTargetSpec $new_primary_host,
   Optional[String] $upgrade_version = undef,
+  Optional[SingleTargetSpec] $replica_host = undef,
 ) {
   peadm::assert_supported_bolt_version()
 
@@ -36,6 +37,7 @@
       code_manager_auto_configure => true,
       download_mode               => 'direct',
       version                     => $old_pe_conf['pe_version'],
+      replica_host                => $replica_host,
   })
 
   run_plan('peadm::restore', {
@@ -48,7 +50,8 @@
     run_plan('peadm::upgrade', {
         primary_host                => $new_primary_host,
         version                     => $upgrade_version,
-        download_mode              => 'direct',
+        download_mode               => 'direct',
+        replica_host                => $replica_host,
     })
   }
 }