Release prep v3.7.0

puppetlabs · May 11, 2022 · 2db6d1e · 2db6d1e
1 parent f825c31
commit 2db6d1e
Showing 3 changed files with 73 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v3.7.0](https://github.com/puppetlabs/puppetlabs-peadm/tree/v3.7.0) (2022-05-11)
+
+[Full Changelog](https://github.com/puppetlabs/puppetlabs-peadm/compare/v3.6.0...v3.7.0)
+
+### Added
+
+- Add optional `pe_installer_source` parameter [\#261](https://github.com/puppetlabs/puppetlabs-peadm/pull/261) ([reidmv](https://github.com/reidmv))
+- Support PE 2021.6 and 2019.8.11 [\#260](https://github.com/puppetlabs/puppetlabs-peadm/pull/260) ([reidmv](https://github.com/reidmv))
+- Add experimental restore plan [\#250](https://github.com/puppetlabs/puppetlabs-peadm/pull/250) ([reidmv](https://github.com/reidmv))
+
 ## [v3.6.0](https://github.com/puppetlabs/puppetlabs-peadm/tree/v3.6.0) (2022-05-04)
 
 [Full Changelog](https://github.com/puppetlabs/puppetlabs-peadm/compare/v3.5.0...v3.6.0)

diff --git a/REFERENCE.md b/REFERENCE.md
@@ -69,17 +69,18 @@
 * [`puppet_runonce`](#puppet_runonce): Run the Puppet agent one time
 * [`rbac_token`](#rbac_token): Get and save an rbac token for the root user, admin rbac user
 * [`read_file`](#read_file): Read the contents of a file
+* [`restore_classification`](#restore_classification): A short description of this task
 * [`sign_csr`](#sign_csr): Submit a certificate signing request
 * [`ssl_clean`](#ssl_clean): Clean an agent's certificate
 * [`submit_csr`](#submit_csr): Submit a certificate signing request
+* [`transform_classification_groups`](#transform_classification_groups): Transform the user groups from a source backup to a list of groups on the target server
 * [`wait_until_service_ready`](#wait_until_service_ready): Return when the orchestrator service is healthy, or timeout after 15 seconds
 
 ### Plans
 
 #### Public Plans
 
 * [`peadm::add_database`](#peadmadd_database)
-* [`peadm::backup`](#peadmbackup): Backup the core user settings for puppet infrastructure
 * [`peadm::convert`](#peadmconvert): Convert an existing PE cluster to a PEAdm-managed cluster
 * [`peadm::install`](#peadminstall): Install a new PE cluster
 * [`peadm::modify_certificate`](#peadmmodify_certificate): Modify the certificate of one or more targets
@@ -93,8 +94,10 @@
 Supported use cases:
 1: The existing replica is broken, we have a fresh new VM we want to provision the replica to.
    The new replica should have the same certname as the broken one.
+* `peadm::backup`: Backup the core user settings for puppet infrastructure
 * `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL
 * `peadm::modify_cert_extensions`
+* `peadm::restore`: Restore the core user settings for puppet infrastructure from backup
 * `peadm::subplans::component_install`: Install a new PEADM component
 * `peadm::subplans::configure`: Configure first-time classification and DR setup
 * `peadm::subplans::db_populate`: Destructively (re)populates a new or existing database with the contents or a known good source
@@ -1202,6 +1205,20 @@ Data type: `String`
 
 Path to the file to read
 
+### <a name="restore_classification"></a>`restore_classification`
+
+A short description of this task
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `classification_file`
+
+Data type: `String`
+
+The full path to a backed up or transformed classification file
+
 ### <a name="sign_csr"></a>`sign_csr`
 
 Submit a certificate signing request
@@ -1244,6 +1261,26 @@ Data type: `Optional[Array[String]]`
 
 DNS Alternative Names to request for the certificate
 
+### <a name="transform_classification_groups"></a>`transform_classification_groups`
+
+Transform the user groups from a source backup to a list of groups on the target server
+
+**Supports noop?** false
+
+#### Parameters
+
+##### `source_directory`
+
+Data type: `String`
+
+Location of Source node group yaml file
+
+##### `working_directory`
+
+Data type: `String`
+
+Location of target node group yaml file and where to create the transformed file
+
 ### <a name="wait_until_service_ready"></a>`wait_until_service_ready`
 
 Return when the orchestrator service is healthy, or timeout after 15 seconds
@@ -1313,40 +1350,6 @@ Data type: `Optional[Enum[
 
 Default value: ``undef``
 
-### <a name="peadmbackup"></a>`peadm::backup`
-
-This plan can backup data as outlined at insert doc
-
-#### Parameters
-
-The following parameters are available in the `peadm::backup` plan:
-
-* [`targets`](#targets)
-* [`backup`](#backup)
-* [`output_directory`](#output_directory)
-
-##### <a name="targets"></a>`targets`
-
-Data type: `Peadm::SingleTargetSpec`
-
-
-
-##### <a name="backup"></a>`backup`
-
-Data type: `Peadm::Recovery_opts`
-
-
-
-Default value: `{}`
-
-##### <a name="output_directory"></a>`output_directory`
-
-Data type: `String`
-
-
-
-Default value: `'/tmp'`
-
 ### <a name="peadmconvert"></a>`peadm::convert`
 
 This plan sets required certificate extensions on PE nodes, and configures
@@ -1461,6 +1464,7 @@ The following parameters are available in the `peadm::install` plan:
 * [`compiler_pool_address`](#compiler_pool_address)
 * [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address)
 * [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address)
+* [`pe_installer_source`](#pe_installer_source)
 * [`primary_host`](#primary_host)
 * [`replica_host`](#replica_host)
 * [`compiler_hosts`](#compiler_hosts)
@@ -1509,6 +1513,17 @@ architectures.
 
 Default value: ``undef``
 
+##### <a name="pe_installer_source"></a>`pe_installer_source`
+
+Data type: `Optional[String]`
+
+The URL to download the Puppet Enterprise installer media from. If not
+specified, PEAdm will attempt to download PE installation media from its
+standard public source. When specified, PEAdm will download directly from the
+URL given.
+
+Default value: ``undef``
+
 ##### <a name="primary_host"></a>`primary_host`
 
 Data type: `Peadm::SingleTargetSpec`
@@ -1780,6 +1795,7 @@ The following parameters are available in the `peadm::upgrade` plan:
 * [`compiler_pool_address`](#compiler_pool_address)
 * [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address)
 * [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address)
+* [`pe_installer_source`](#pe_installer_source)
 * [`primary_host`](#primary_host)
 * [`replica_host`](#replica_host)
 * [`compiler_hosts`](#compiler_hosts)
@@ -1821,6 +1837,17 @@ architectures.
 
 Default value: ``undef``
 
+##### <a name="pe_installer_source"></a>`pe_installer_source`
+
+Data type: `Optional[String]`
+
+The URL to download the Puppet Enterprise installer media from. If not
+specified, PEAdm will attempt to download PE installation media from its
+standard public source. When specified, PEAdm will download directly from the
+URL given.
+
+Default value: ``undef``
+
 ##### <a name="primary_host"></a>`primary_host`
 
 Data type: `Peadm::SingleTargetSpec`

diff --git a/metadata.json b/metadata.json
@@ -1,6 +1,6 @@
 {
   "name": "puppetlabs-peadm",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "author": "puppetlabs",
   "summary": "Bolt plans used to deploy an at-scale Puppet Enterprise architecture",
   "license": "Apache-2.0",