Skip to content

Commit eb032d3

Browse files
authored
Merge pull request #262 from puppetlabs/release-prep
Release prep v3.7.0
2 parents f825c31 + e003b87 commit eb032d3

File tree

3 files changed

+75
-38
lines changed

3 files changed

+75
-38
lines changed

CHANGELOG.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,28 @@
22

33
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).
44

5+
## [v3.7.0](https://github.com/puppetlabs/puppetlabs-peadm/tree/v3.7.0) (2022-05-11)
6+
7+
[Full Changelog](https://github.com/puppetlabs/puppetlabs-peadm/compare/v3.6.0...v3.7.0)
8+
9+
### Added
10+
11+
- Add support for PE 2021.6 and 2019.8.11 [\#260](https://github.com/puppetlabs/puppetlabs-peadm/pull/260) ([reidmv](https://github.com/reidmv))
12+
- Add optional `pe_installer_source` parameter [\#261](https://github.com/puppetlabs/puppetlabs-peadm/pull/261) ([reidmv](https://github.com/reidmv))
13+
- Add experimental restore plan [\#250](https://github.com/puppetlabs/puppetlabs-peadm/pull/250) ([reidmv](https://github.com/reidmv))
14+
515
## [v3.6.0](https://github.com/puppetlabs/puppetlabs-peadm/tree/v3.6.0) (2022-05-04)
616

717
[Full Changelog](https://github.com/puppetlabs/puppetlabs-peadm/compare/v3.5.0...v3.6.0)
818

919
### Added
1020

11-
- Solarch 581 [\#235](https://github.com/puppetlabs/puppetlabs-peadm/pull/235) ([davidsandilands](https://github.com/davidsandilands))
21+
- Add experimental backup plan [\#235](https://github.com/puppetlabs/puppetlabs-peadm/pull/235) ([davidsandilands](https://github.com/davidsandilands))
1222

1323
### Fixed
1424

1525
- Add read map so puppetdb can start on new compiler [\#252](https://github.com/puppetlabs/puppetlabs-peadm/pull/252) ([ody](https://github.com/ody))
16-
- \(SOLARCH-434\) Procedure for recovering PSQL [\#243](https://github.com/puppetlabs/puppetlabs-peadm/pull/243) ([ody](https://github.com/ody))
26+
- Fix and document recovery procedure for PSQL [\#243](https://github.com/puppetlabs/puppetlabs-peadm/pull/243) ([ody](https://github.com/ody))
1727

1828
## [v3.5.0](https://github.com/puppetlabs/puppetlabs-peadm/tree/v3.5.0) (2022-04-13)
1929

REFERENCE.md

Lines changed: 62 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -69,17 +69,18 @@
6969
* [`puppet_runonce`](#puppet_runonce): Run the Puppet agent one time
7070
* [`rbac_token`](#rbac_token): Get and save an rbac token for the root user, admin rbac user
7171
* [`read_file`](#read_file): Read the contents of a file
72+
* [`restore_classification`](#restore_classification): A short description of this task
7273
* [`sign_csr`](#sign_csr): Submit a certificate signing request
7374
* [`ssl_clean`](#ssl_clean): Clean an agent's certificate
7475
* [`submit_csr`](#submit_csr): Submit a certificate signing request
76+
* [`transform_classification_groups`](#transform_classification_groups): Transform the user groups from a source backup to a list of groups on the target server
7577
* [`wait_until_service_ready`](#wait_until_service_ready): Return when the orchestrator service is healthy, or timeout after 15 seconds
7678

7779
### Plans
7880

7981
#### Public Plans
8082

8183
* [`peadm::add_database`](#peadmadd_database)
82-
* [`peadm::backup`](#peadmbackup): Backup the core user settings for puppet infrastructure
8384
* [`peadm::convert`](#peadmconvert): Convert an existing PE cluster to a PEAdm-managed cluster
8485
* [`peadm::install`](#peadminstall): Install a new PE cluster
8586
* [`peadm::modify_certificate`](#peadmmodify_certificate): Modify the certificate of one or more targets
@@ -93,8 +94,10 @@
9394
Supported use cases:
9495
1: The existing replica is broken, we have a fresh new VM we want to provision the replica to.
9596
The new replica should have the same certname as the broken one.
97+
* `peadm::backup`: Backup the core user settings for puppet infrastructure
9698
* `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL
9799
* `peadm::modify_cert_extensions`
100+
* `peadm::restore`: Restore the core user settings for puppet infrastructure from backup
98101
* `peadm::subplans::component_install`: Install a new PEADM component
99102
* `peadm::subplans::configure`: Configure first-time classification and DR setup
100103
* `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`
12021205

12031206
Path to the file to read
12041207

1208+
### <a name="restore_classification"></a>`restore_classification`
1209+
1210+
A short description of this task
1211+
1212+
**Supports noop?** false
1213+
1214+
#### Parameters
1215+
1216+
##### `classification_file`
1217+
1218+
Data type: `String`
1219+
1220+
The full path to a backed up or transformed classification file
1221+
12051222
### <a name="sign_csr"></a>`sign_csr`
12061223

12071224
Submit a certificate signing request
@@ -1244,6 +1261,26 @@ Data type: `Optional[Array[String]]`
12441261

12451262
DNS Alternative Names to request for the certificate
12461263

1264+
### <a name="transform_classification_groups"></a>`transform_classification_groups`
1265+
1266+
Transform the user groups from a source backup to a list of groups on the target server
1267+
1268+
**Supports noop?** false
1269+
1270+
#### Parameters
1271+
1272+
##### `source_directory`
1273+
1274+
Data type: `String`
1275+
1276+
Location of Source node group yaml file
1277+
1278+
##### `working_directory`
1279+
1280+
Data type: `String`
1281+
1282+
Location of target node group yaml file and where to create the transformed file
1283+
12471284
### <a name="wait_until_service_ready"></a>`wait_until_service_ready`
12481285

12491286
Return when the orchestrator service is healthy, or timeout after 15 seconds
@@ -1313,40 +1350,6 @@ Data type: `Optional[Enum[
13131350

13141351
Default value: ``undef``
13151352

1316-
### <a name="peadmbackup"></a>`peadm::backup`
1317-
1318-
This plan can backup data as outlined at insert doc
1319-
1320-
#### Parameters
1321-
1322-
The following parameters are available in the `peadm::backup` plan:
1323-
1324-
* [`targets`](#targets)
1325-
* [`backup`](#backup)
1326-
* [`output_directory`](#output_directory)
1327-
1328-
##### <a name="targets"></a>`targets`
1329-
1330-
Data type: `Peadm::SingleTargetSpec`
1331-
1332-
1333-
1334-
##### <a name="backup"></a>`backup`
1335-
1336-
Data type: `Peadm::Recovery_opts`
1337-
1338-
1339-
1340-
Default value: `{}`
1341-
1342-
##### <a name="output_directory"></a>`output_directory`
1343-
1344-
Data type: `String`
1345-
1346-
1347-
1348-
Default value: `'/tmp'`
1349-
13501353
### <a name="peadmconvert"></a>`peadm::convert`
13511354

13521355
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:
14611464
* [`compiler_pool_address`](#compiler_pool_address)
14621465
* [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address)
14631466
* [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address)
1467+
* [`pe_installer_source`](#pe_installer_source)
14641468
* [`primary_host`](#primary_host)
14651469
* [`replica_host`](#replica_host)
14661470
* [`compiler_hosts`](#compiler_hosts)
@@ -1509,6 +1513,17 @@ architectures.
15091513

15101514
Default value: ``undef``
15111515

1516+
##### <a name="pe_installer_source"></a>`pe_installer_source`
1517+
1518+
Data type: `Optional[String]`
1519+
1520+
The URL to download the Puppet Enterprise installer media from. If not
1521+
specified, PEAdm will attempt to download PE installation media from its
1522+
standard public source. When specified, PEAdm will download directly from the
1523+
URL given.
1524+
1525+
Default value: ``undef``
1526+
15121527
##### <a name="primary_host"></a>`primary_host`
15131528

15141529
Data type: `Peadm::SingleTargetSpec`
@@ -1780,6 +1795,7 @@ The following parameters are available in the `peadm::upgrade` plan:
17801795
* [`compiler_pool_address`](#compiler_pool_address)
17811796
* [`internal_compiler_a_pool_address`](#internal_compiler_a_pool_address)
17821797
* [`internal_compiler_b_pool_address`](#internal_compiler_b_pool_address)
1798+
* [`pe_installer_source`](#pe_installer_source)
17831799
* [`primary_host`](#primary_host)
17841800
* [`replica_host`](#replica_host)
17851801
* [`compiler_hosts`](#compiler_hosts)
@@ -1821,6 +1837,17 @@ architectures.
18211837

18221838
Default value: ``undef``
18231839

1840+
##### <a name="pe_installer_source"></a>`pe_installer_source`
1841+
1842+
Data type: `Optional[String]`
1843+
1844+
The URL to download the Puppet Enterprise installer media from. If not
1845+
specified, PEAdm will attempt to download PE installation media from its
1846+
standard public source. When specified, PEAdm will download directly from the
1847+
URL given.
1848+
1849+
Default value: ``undef``
1850+
18241851
##### <a name="primary_host"></a>`primary_host`
18251852

18261853
Data type: `Peadm::SingleTargetSpec`

metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-peadm",
3-
"version": "3.6.0",
3+
"version": "3.7.0",
44
"author": "puppetlabs",
55
"summary": "Bolt plans used to deploy an at-scale Puppet Enterprise architecture",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)