output parameters used in plans upgrade, install and migrate to aid in debugging. hosts, pe version,

include logs as allowed in 'basic functionality'

expect the out message

PE-40508) Add infra-assistant to add_database plan (#580)

Co-authored-by: Neil Anderson <[email protected]>
Co-authored-by: ragingra <[email protected]>

add XL with and without DR to test migration and migrate plans (#581)

Author: B00885424

.fixtures.yml

@@ -1,21 +1,23 @@
 ---
 fixtures:
   forge_modules:
-    ruby_task_helper: "puppetlabs/ruby_task_helper"
-    service: "puppetlabs/service"
-    package: "puppetlabs/package"
-    reboot: "puppetlabs/reboot"
-    inifile: "puppetlabs/inifile"
+    ruby_task_helper: puppetlabs/ruby_task_helper
+    service: puppetlabs/service
+    package: puppetlabs/package
+    reboot: puppetlabs/reboot
+    inifile: puppetlabs/inifile
   repositories:
-    facts: "https://github.com/puppetlabs/puppetlabs-facts.git"
-    puppet_agent: "https://github.com/puppetlabs/puppetlabs-puppet_agent.git"
-    provision: "https://github.com/puppetlabs/provision.git"
-    stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
-    apply_helpers: "https://github.com/puppetlabs/puppetlabs-apply_helpers"
-    bolt_shim: "https://github.com/puppetlabs/puppetlabs-bolt_shim"
-    format: "https://github.com/voxpupuli/puppet-format"
-    container_inventory: "https://gitlab.com/nwops/bolt-container_inventory.git"
-    node_manager: "https://github.com/puppetlabs/puppetlabs-node_manager.git"
+    facts: https://github.com/puppetlabs/puppetlabs-facts.git
+    puppet_agent: https://github.com/puppetlabs/puppetlabs-puppet_agent.git
+    provision:
+      repo: https://github.com/puppetlabs/provision.git
+      ref: v3.0.1
+    stdlib: https://github.com/puppetlabs/puppetlabs-stdlib.git
+    apply_helpers: https://github.com/puppetlabs/puppetlabs-apply_helpers
+    bolt_shim: https://github.com/puppetlabs/puppetlabs-bolt_shim
+    format: https://github.com/voxpupuli/puppet-format
+    container_inventory: https://gitlab.com/nwops/bolt-container_inventory.git
+    node_manager: https://github.com/puppetlabs/puppetlabs-node_manager.git
   symlinks:
-    "peadm": "#{source_dir}"
-    "peadm_spec": "#{source_dir}/spec/acceptance/peadm_spec"
+    peadm: '#{source_dir}'
+    peadm_spec: '#{source_dir}/spec/acceptance/peadm_spec'

.github/workflows/test-migration.yaml

@@ -40,9 +40,9 @@ jobs:
           - standard
           - standard-with-dr
           - large
-            # - extra-large
+          - extra-large
           - large-with-dr
-            # - extra-large-with-dr
+          - extra-large-with-dr
         version: [2021.7.9, 2023.8.2, 2025.2.0]
         image: [almalinux-cloud/almalinux-8]
         include:
@@ -54,6 +54,20 @@ jobs:
             version: 2023.8.0
             image: almalinux-cloud/almalinux-8
             new_pe_version: 2025.2.0
+          - architecture: extra-large
+            version: 2023.8.0
+            image: almalinux-cloud/almalinux-8
+            new_pe_version: 2025.2.0
+         # excluding the following combinations as due to their long running nature they always fail due to 
+         # the test nodes in GCP that litmus provisions becoming unreachable after a time. If we address PE-40902
+         # to change how we provision test nodes in CI then we will hopefully be able to include these
+        exclude:
+          - architecture: extra-large-with-dr
+            version: 2023.8.2
+            image: almalinux-cloud/almalinux-8
+          - architecture: extra-large-with-dr
+            version: 2025.2.0
+            image: almalinux-cloud/almalinux-8
     steps:
       - name: Checkout Source
         uses: actions/checkout@v4

.github/workflows/test-upgrade-matrix.yaml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        architecture: [standard, extra-large-with-dr]
+        architecture: [standard, extra-large]  # removing xl-with dr until PE-40902 is addressed
         version: [2019.8.12, 2021.7.9, 2023.8.2]
         version_to_upgrade: [2021.7.9, 2023.8.2, 2025.2.0]
         image: [almalinux-cloud/almalinux-8]

REFERENCE.md

@@ -32,7 +32,9 @@
 * [`peadm::generate_pe_conf`](#peadm--generate_pe_conf): Generate a pe.conf file in JSON format
 * [`peadm::get_pe_conf`](#peadm--get_pe_conf)
 * [`peadm::get_targets`](#peadm--get_targets): Accept undef or a SingleTargetSpec, and return an Array[Target, 1, 0]. This differs from get_target() in that:   - It returns an Array[Target
+* [`peadm::log_plan_parameters`](#peadm--log_plan_parameters)
 * [`peadm::migration_opts_default`](#peadm--migration_opts_default)
+* [`peadm::module_version`](#peadm--module_version)
 * [`peadm::node_manager_yaml_location`](#peadm--node_manager_yaml_location)
 * [`peadm::oid`](#peadm--oid)
 * [`peadm::pe_db_names`](#peadm--pe_db_names)
@@ -786,6 +788,24 @@ Data type: `Optional[Integer[1,1]]`
 
 
 
+### <a name="peadm--log_plan_parameters"></a>`peadm::log_plan_parameters`
+
+Type: Puppet Language
+
+The peadm::log_plan_parameters function.
+
+#### `peadm::log_plan_parameters(Hash $params)`
+
+The peadm::log_plan_parameters function.
+
+Returns: `Any`
+
+##### `params`
+
+Data type: `Hash`
+
+
+
 ### <a name="peadm--migration_opts_default"></a>`peadm::migration_opts_default`
 
 Type: Puppet Language
@@ -798,6 +818,18 @@ The peadm::migration_opts_default function.
 
 Returns: `Any`
 
+### <a name="peadm--module_version"></a>`peadm::module_version`
+
+Type: Ruby 4.x API
+
+The peadm::module_version function.
+
+#### `peadm::module_version()`
+
+The peadm::module_version function.
+
+Returns: `Any`
+
 ### <a name="peadm--node_manager_yaml_location"></a>`peadm::node_manager_yaml_location`
 
 Type: Ruby 4.x API
@@ -1804,6 +1836,7 @@ The following parameters are available in the `peadm::add_database` plan:
 * [`primary_host`](#-peadm--add_database--primary_host)
 * [`mode`](#-peadm--add_database--mode)
 * [`begin_at_step`](#-peadm--add_database--begin_at_step)
+* [`is_migration`](#-peadm--add_database--is_migration)
 
 ##### <a name="-peadm--add_database--targets"></a>`targets`
 
@@ -1843,6 +1876,14 @@ Optional[Enum[
 
 Default value: `undef`
 
+##### <a name="-peadm--add_database--is_migration"></a>`is_migration`
+
+Data type: `Optional[Boolean]`
+
+
+
+Default value: `false`
+
 ### <a name="peadm--add_replica"></a>`peadm::add_replica`
 
 Add or replace a replica host.

plans/util/log_plans_params.pp renamed to functions/log_plan_parameters.pp

@@ -1,4 +1,5 @@
 function peadm::log_plan_parameters(Hash $params) {
+  out::message("PEADM Module version: ${peadm::module_version()}")
   $params.each |$key, $value| {
     out::message("Parameter '${key}': [${value}]")
   }

functions/pe_db_names.pp

@@ -9,10 +9,20 @@ function peadm::pe_db_names (
     'pe-rbac',
   ]
 
+  $pe_2025_3_or_later = SemVerRange('>= 2025.3.0')
   $pe_2025_or_later = SemVerRange('>= 2025.0.0')
   $pe_2023_8_or_later = SemVerRange('>= 2023.8.0')
 
   case $pe_ver {
+    # The infra-assistant was added in 2025.3.0
+    $pe_2025_3_or_later: {
+      $original_db_names + [
+        'pe-hac',
+        'pe-patching',
+        'pe-infra-assistant',
+      ]
+    }
+
     # The patching service was added in 2025.0.0
     $pe_2025_or_later: {
       $original_db_names + [

lib/puppet/functions/peadm/module_version.rb

@@ -0,0 +1,9 @@
+Puppet::Functions.create_function(:'peadm::module_version', Puppet::Functions::InternalFunction) do
+  dispatch :module_version do
+    scope_param
+  end
+
+  def module_version(scope)
+    scope.compiler.environment.module('peadm').version
+  end
+end

plans/add_database.pp

@@ -9,6 +9,7 @@
       'update-db-settings',
       'cleanup-db',
   'finalize']] $begin_at_step = undef,
+  Optional[Boolean] $is_migration = false,
 ) {
   $primary_target = peadm::get_targets($primary_host, 1)
   $postgresql_target = peadm::get_targets($targets, 1)
@@ -22,8 +23,9 @@
 
   $compilers = $peadm_config['params']['compilers']
 
-  # Bail if this is trying to be ran against Standard
-  if $compilers.empty {
+  # Bail if this is trying to be ran against Standard. We need to allow this plan to progress for a migration 
+  # though as initially the installation will not have compilers added
+  if $compilers.empty and !$is_migration {
     fail_plan('Plan peadm::add_database is only applicable for L and XL deployments')
   }
 
@@ -59,11 +61,15 @@
 
   if $operating_mode == 'init' {
     # If no other PSQL node then match primary group letter
-    $avail_group_letter = peadm::flatten_compact($roles['server'].map |$k,$v| {
+    $calculated_group_letter = peadm::flatten_compact($roles['server'].map |$k,$v| {
         if $v == $primary_host {
           $k
         }
     })[0]
+    $avail_group_letter = $calculated_group_letter ? {
+      undef   => $is_migration ? { true => 'A', default => undef },
+      default => $calculated_group_letter,
+    }
     # Assume PuppetDB backend hosted on Primary if in init mode
     $source_db_host = $primary_host
   } else {

plans/install.pp

@@ -75,18 +75,39 @@
   Boolean                    $permit_unsafe_versions = false,
   String                     $token_lifetime         = '1y',
 ) {
+  # Log parameters for debugging 
+  peadm::log_plan_params({
+    'primary_host' => $primary_host,
+    'replica_host' => $replica_host,
+    'compiler_hosts' => $compiler_hosts,
+    'legacy_compilers' => $legacy_compilers,
+    'primary_postgresql_host' => $primary_postgresql_host,
+    'replica_postgresql_host' => $replica_postgresql_host,
+    'version' => $version,
+  })
+
   peadm::assert_supported_bolt_version()
 
   peadm::assert_supported_pe_version($version, $permit_unsafe_versions)
 
-  # Log parameters for debugging
-  peadm::log_plan_parameters({
-    'targets' => $targets,
+<<<<<<< HEAD
+  # Log parameters for debugging 
+  peadm::log_plan_params({
     'primary_host' => $primary_host,
-    'mode' => $mode,
-    'begin_at_step' => $begin_at_step,
+    'replica_host' => $replica_host,
+    'compiler_hosts' => $compiler_hosts,
+    'legacy_compilers' => $legacy_compilers,
+    'primary_postgresql_host' => $primary_postgresql_host,
+    'replica_postgresql_host' => $replica_postgresql_host,
+    'version' => $version,
   })
 
+  peadm::assert_supported_bolt_version()
+
+  peadm::assert_supported_pe_version($version, $permit_unsafe_versions)
+
+=======
+>>>>>>> 431141a (move declaration)
   $install_result = run_plan('peadm::subplans::install',
     # Standard
     primary_host                   => $primary_host,

plans/migrate.pp

@@ -8,13 +8,31 @@
 #   The new server that will become the PE primary server
 # @param upgrade_version
 #   Optional version to upgrade to after migration is complete
-#
+# @param replica_host
+#   Optional new replica server to be added to the cluster
+# @param primary_postgresql_host
+#   Optional new primary PostgreSQL server to be added to the cluster
+# @param replica_postgresql_host
+#   Optional new replica PostgreSQL server to be added to the cluster
 plan peadm::migrate (
   Peadm::SingleTargetSpec $old_primary_host,
   Peadm::SingleTargetSpec $new_primary_host,
   Optional[String] $upgrade_version = undef,
   Optional[Peadm::SingleTargetSpec] $replica_host = undef,
+  Optional[Peadm::SingleTargetSpec] $primary_postgresql_host = undef,
+  Optional[Peadm::SingleTargetSpec] $replica_postgresql_host = undef,
 ) {
+  # Log parameters for debugging 
+  peadm::log_plan_parameters({
+    'new_primary_host' => $new_primary_host,
+    'replica_host' => $replica_host,
+    'compiler_hosts' => $compiler_hosts,
+    'legacy_compilers' => $legacy_compilers,
+    'primary_postgresql_host' => $primary_postgresql_host,
+    'replica_postgresql_host' => $replica_postgresql_host,
+    'upgrade_version' => $upgrade_version,
+  })
+
   # pre-migration checks
   out::message('This plan is a work in progress and it is not recommended to be used until it is fully implemented and supported')
   peadm::assert_supported_bolt_version()
@@ -25,7 +43,9 @@
 
   $new_hosts = peadm::flatten_compact([
       $new_primary_host,
-      $replica_host ? { undef => [], default => [$replica_host] }
+      $replica_host ? { undef => [], default => [$replica_host] },
+      $primary_postgresql_host ? { undef => [], default => [$primary_postgresql_host] },
+      $replica_postgresql_host ? { undef => [], default => [$replica_postgresql_host] },
   ].flatten)
   $all_hosts = peadm::flatten_compact([
       $old_primary_host,
@@ -118,10 +138,27 @@
     out::message('No nodes to purge from old configuration')
   }
 
+  # provision a postgresql host if one is provided
+  if $primary_postgresql_host {
+    run_plan('peadm::add_database', targets => $primary_postgresql_host,
+      primary_host => $new_primary_host,
+      is_migration => true,
+    )
+    # provision a replica postgresql host if one is provided
+    if $replica_postgresql_host {
+      run_plan('peadm::add_database', targets => $replica_postgresql_host,
+        primary_host => $new_primary_host,
+        is_migration => true,
+      )
+    }
+  }
+
+  # provision a replica if one is provided
   if $replica_host {
     run_plan('peadm::add_replica', {
         primary_host => $new_primary_host,
         replica_host => $replica_host,
+        replica_postgresql_host => $replica_postgresql_host,
     })
   }
 
@@ -134,6 +171,8 @@
         version                     => $upgrade_version,
         download_mode               => 'direct',
         replica_host                => $replica_host,
+        primary_postgresql_host     => $primary_postgresql_host,
+        replica_postgresql_host     => $replica_postgresql_host,
     })
   }
 }