(PE-40784) Add support for PE 2023.8.2 and 2025.1.0 (#560)

Author: davidmalloncares

.github/workflows/test-add-compiler-matrix.yml

@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard, large, extra-large]
-        version: [2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2021.7.9, 2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
     steps:
       - name: Checkout Source

.github/workflows/test-add-compiler.yaml

@@ -14,7 +14,7 @@ on:
       version:
         description: PE version to install
         required: true
-        default: 2023.8.1
+        default: 2023.8.2
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true

.github/workflows/test-add-replica-matrix.yaml

@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard, standard-with-dr, large, extra-large]
-        version: [2023.8.1, 2025.0.0]
+        version: [2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
     steps:
       - name: Checkout Source

.github/workflows/test-add-replica.yaml

@@ -14,7 +14,7 @@ on:
       version:
         description: PE version to install
         required: true
-        default: 2023.8.1
+        default: 2023.8.2
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true

.github/workflows/test-backup-restore.yaml

@@ -24,14 +24,14 @@ on:
       version:
         description: PE version to install
         required: true
-        default: 2025.0.0
+        default: 2025.1.0
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true
         default: 'false'
 jobs:
   backup-restore-test:
-    name: "Backup, break and restore cluster: PE ${{ github.event.inputs.version || '2025.0.0' }}\
+    name: "Backup, break and restore cluster: PE ${{ github.event.inputs.version || '2025.1.0' }}\
       \ ${{ github.event.inputs.architecture || 'extra-large' }} on ${{ github.event.inputs.image || 'almalinux-cloud/almalinux-8' }}"
     runs-on: ubuntu-20.04
     env:

.github/workflows/test-failover.yaml

@@ -14,7 +14,7 @@ on:
       version_to_upgrade:
         description: PE version to upgrade to
         required: false
-        default: 2023.8.1
+        default: 2023.8.2
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true

.github/workflows/test-fips-install-matrix.yaml

@@ -37,7 +37,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard-with-dr, large, extra-large-with-dr]
-        version: [2019.8.12, 2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2019.8.12, 2021.7.9, 2023.8.2, 2025.1.0]
         image: [rhel-8]
         fips: [enable]
     steps:

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

@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard-with-dr, large, extra-large-with-dr]
-        version: [2019.8.12, 2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2019.8.12, 2021.7.9, 2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
     steps:
       - name: Checkout Source

.github/workflows/test-install-rhel-9.yaml

@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard-with-dr, large, extra-large-with-dr]
-        version: [2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2021.7.9, 2023.8.2, 2025.1.0]
         image: [rhel-9]
     steps:
       - name: Checkout Source

.github/workflows/test-install.yaml

@@ -14,7 +14,7 @@ on:
       version:
         description: PE version to install
         required: true
-        default: 2023.8.1
+        default: 2023.8.2
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true

.github/workflows/test-legacy-compilers.yaml

@@ -99,7 +99,7 @@ jobs:
             --modulepath spec/fixtures/modules \
             architecture=large-with-dr \
             console_password=${{ secrets.CONSOLE_PASSWORD }} \
-            version=2025.0.0
+            version=2025.1.0
       - name: Wait as long as the file ${HOME}/pause file is present
         if: ${{ always() && github.event.inputs.ssh-debugging == 'true' }}
         run: |

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

@@ -152,7 +152,7 @@ jobs:
           compiler=$(yq '.groups[].targets[] | select(.vars.role == "compiler") | .name' spec/fixtures/litmus_inventory.yaml | head -n 1)
           legacy_compiler=$(yq '.groups[].targets[] | select(.vars.role == "compiler") | .name' spec/fixtures/litmus_inventory.yaml | sed -n 2p)
           replica=$(yq '.groups[].targets[] | select(.vars.role == "replica") | .name' spec/fixtures/litmus_inventory.yaml)
-          echo -n '{ "primary_host": "'$primary'", "replica_host": "'$replica'", "compiler_hosts": ["'$compiler'", "'$legacy_compiler'"], "version": "2025.0.0"}' > upgrade_params.json
+          echo -n '{ "primary_host": "'$primary'", "replica_host": "'$replica'", "compiler_hosts": ["'$compiler'", "'$legacy_compiler'"], "version": "2025.1.0"}' > upgrade_params.json
       - name: Upgrade PE with legacy compilers
         run: |
           echo ::group::upgrade_params.json

.github/workflows/test-migration.yaml

@@ -43,7 +43,7 @@ jobs:
             # - extra-large
             # - large-with-dr
             # - extra-large-with-dr
-        version: [2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2021.7.9, 2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
         include:
           - architecture: standard

.github/workflows/test-replace-failed-postgresql.yaml

@@ -37,7 +37,7 @@ jobs:
       matrix:
         architecture: [extra-large-with-dr-and-spare-replica]
         install_architecture: [extra-large-with-dr]
-        version: [2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2021.7.9, 2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
     steps:
       - name: Checkout Source

.github/workflows/test-upgrade-latest-dev.yaml

@@ -23,7 +23,7 @@ on:
         type: string
         required: true
         description: The initial version of PE to install before upgrade
-        default: 2023.8.1
+        default: 2023.8.2
       ssh-debugging:
         description: Boolean; whether or not to pause for ssh debugging
         required: true

.github/workflows/test-upgrade-latest-xlarge-dev-nightly.yaml

@@ -16,7 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [extra-large-with-dr]
-        version: [2023.8.1]
+        version: [2023.8.2]
         image: [almalinux-cloud/almalinux-8]
     steps:
       - name: Checkout Source

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

@@ -37,25 +37,27 @@ jobs:
       fail-fast: false
       matrix:
         architecture: [standard, extra-large-with-dr]
-        version: [2019.8.12, 2021.7.9, 2023.8.1]
-        version_to_upgrade: [2021.7.9, 2023.8.1, 2025.0.0]
+        version: [2019.8.12, 2021.7.9, 2023.8.2]
+        version_to_upgrade: [2021.7.9, 2023.8.2, 2025.1.0]
         image: [almalinux-cloud/almalinux-8]
         download_mode: [direct]
         exclude:
           - version: 2019.8.12
-            version_to_upgrade: 2023.8.1
+            version_to_upgrade: 2023.8.2
           - version: 2019.8.12
-            version_to_upgrade: 2025.0.0
+            version_to_upgrade: 2025.1.0
           - version: 2021.7.9
             version_to_upgrade: 2021.7.9
           - version: 2021.7.9
-            version_to_upgrade: 2025.0.0
-          - version: 2023.8.1
-            version_to_upgrade: 2023.8.1
-          - version: 2023.8.1
-            version_to_upgrade: 2025.0.0
+            version_to_upgrade: 2025.1.0
           - version: 2023.8.1
+            version_to_upgrade: 2023.8.2
+          - version: 2023.8.2
+            version_to_upgrade: 2025.1.0
+          - version: 2023.8.2
             version_to_upgrade: 2021.7.9
+          - version: 2025.0.0
+            version_to_upgrade: 2025.1.0
     steps:
       - name: Start SSH session
         if: ${{ github.event.inputs.ssh-debugging == 'true' }}

REFERENCE.md

@@ -108,7 +108,6 @@ Supported use cases:
 * [`peadm::backup_ca`](#peadm--backup_ca)
 * [`peadm::convert`](#peadm--convert): Convert an existing PE cluster to a PEAdm-managed cluster
 * [`peadm::install`](#peadm--install): Install a new PE cluster
-* [`peadm::migrate`](#peadm--migrate): Migrate a PE primary server to a new host
 * [`peadm::modify_certificate`](#peadm--modify_certificate): Modify the certificate of one or more targets
 * [`peadm::replace_failed_postgresql`](#peadm--replace_failed_postgresql): Replaces a failed PostgreSQL host
 * [`peadm::restore`](#peadm--restore): Restore puppet primary configuration
@@ -120,6 +119,7 @@ Supported use cases:
 #### Private Plans
 
 * `peadm::convert_compiler_to_legacy`
+* `peadm::migrate`: Migrate a PE primary server to a new host - Note: this plan is a work in progress and it
 * `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL
 * `peadm::modify_cert_extensions`
 * `peadm::subplans::component_install`: Install a new PEADM component
@@ -2206,7 +2206,7 @@ Data type: `Peadm::Pe_version`
 
 
 
-Default value: `'2023.8.1'`
+Default value: `'2023.8.2'`
 
 ##### <a name="-peadm--install--dns_alt_names"></a>`dns_alt_names`
 
@@ -2312,47 +2312,6 @@ Data type: `String`
 
 Default value: `'1y'`
 
-### <a name="peadm--migrate"></a>`peadm::migrate`
-
-Migrate a PE primary server to a new host
-
-#### Parameters
-
-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`
-
-Data type: `Peadm::SingleTargetSpec`
-
-The existing PE primary server that will be migrated from
-
-##### <a name="-peadm--migrate--new_primary_host"></a>`new_primary_host`
-
-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[Peadm::SingleTargetSpec]`
-
-
-
-Default value: `undef`
-
 ### <a name="peadm--modify_certificate"></a>`peadm::modify_certificate`
 
 Certificates can be modified by adding extensions, removing extensions, or

functions/assert_supported_pe_version.pp

@@ -6,7 +6,7 @@ function peadm::assert_supported_pe_version (
   Boolean $permit_unsafe_versions = false,
 ) >> Struct[{ 'supported' => Boolean }] {
   $oldest = '2019.7'
-  $newest = '2025.0'
+  $newest = '2025.1'
   $supported = ($version =~ SemVerRange(">= ${oldest} <= ${newest}"))
 
   if $permit_unsafe_versions {

plans/install.pp

@@ -46,7 +46,7 @@
 
   # Common Configuration
   String                            $console_password,
-  Peadm::Pe_version                 $version                          = '2023.8.1',
+  Peadm::Pe_version                 $version                          = '2023.8.2',
   Optional[Stdlib::HTTPSUrl]        $pe_installer_source              = undef,
   Optional[Array[String]]           $dns_alt_names                    = undef,
   Optional[String]                  $compiler_pool_address            = undef,

plans/migrate.pp

@@ -1,4 +1,6 @@
-# @summary Migrate a PE primary server to a new host
+# @api private
+# @summary Migrate a PE primary server to a new host - Note: this plan is a work in progress and it 
+# is not recommended to be used until it is fully implemented and supported
 #
 # @param old_primary_host
 #   The existing PE primary server that will be migrated from
@@ -13,6 +15,7 @@
   Optional[String] $upgrade_version = undef,
   Optional[Peadm::SingleTargetSpec] $replica_host = undef,
 ) {
+  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()
 
   $backup_file = run_plan('peadm::backup', $old_primary_host, {

spec/functions/assert_supported_pe_version_spec.rb

@@ -19,7 +19,7 @@
     end
 
     it 'accepts the newest supported version' do
-      is_expected.to run.with_params('2025.0.0').and_return({ 'supported' => true })
+      is_expected.to run.with_params('2025.1.0').and_return({ 'supported' => true })
     end
 
     it 'accepts a version in the middle' do

spec/plans/subplans/install_spec.rb

@@ -87,11 +87,11 @@
     expect(run_plan('peadm::subplans::install', params)).to be_ok
   end
 
-  it 'installs 2023.8.1 with legacy compilers' do
+  it 'installs 2023.8.2 with legacy compilers' do
     params = {
       'primary_host' => 'primary',
       'console_password' => 'puppetLabs123!',
-      'version' => '2023.8.1',
+      'version' => '2023.8.2',
       'legacy_compilers' => ['compiler1', 'compiler2'],
     }
     expect(run_plan('peadm::subplans::install', params)).to be_ok