Skip to content

Commit 866fbf4

Browse files
authored
(PE-38802) Adding note about PE Infra agent group purge (#509)
Also added additional legacy compiler updates to classification docs
1 parent ea3d073 commit 866fbf4

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed

documentation/classification.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
This reference implementation uses four non-default node classification groups to implement the Extra Large DR architecture. Intentionally, classification of default, out-of-box node groups is not modified. This allows normal commands such as `puppet infrastructure enable replica` to behave more or less exactly as they would in Standard or Large architecture clusters.
66

7+
>Please note, as of PEADM 3.21 the node group **PE Infrastructure Agent** now has it's assosiated rules enforced. This means that custom rules added to the group will be purged during actions such as `peadm::convert` and `peadm::upgrade`.
8+
79
This image shows a fully expanded view of the PE Infrastructure node group, highlighting the new additions made to support the Extra Large architecture.
810

911
![PE Classification tree](images/pe-xl-classification.png)
@@ -16,6 +18,9 @@ The new groups are:
1618
* PE Primary B
1719
* PE Compiler Group A
1820
* PE Compiler Group B
21+
* PE Legacy Compiler
22+
* PE Legacy Compiler Group A
23+
* PE Legacy Compiler Group B
1924

2025
The configuration applied in each group looks as follows:
2126

@@ -73,3 +78,33 @@ Notes for PE Compiler Group B:
7378
* If you have a load balancer for the compilers in PE Compiler Group A port 8081, you should use that load balancer address instead of "primary-a"
7479
* Modifies the `puppet_enterprise::profile::master::puppetdb_port` parameter
7580
* Should be set to `[8081]`
81+
82+
### PE Legacy Compiler
83+
84+
Notes on PE Legacy Compiler:
85+
86+
* Introduced in PEADM 3.25 along with the legacy compiler functionality
87+
* Similar to the native PE Compiler group, and used to contain legacy compilers
88+
* For more info on legacy compilers, please see [here](upgrade_with_legacy_compilers.md)
89+
90+
### PE Legacy Compiler Group A
91+
92+
Notes on PE Legacy Compiler Group A:
93+
94+
* Modifies the `puppet_enterprise::profile::master::puppetdb_host` parameter
95+
* Should be set to `[${clientcert}, "primary-b"]`, where "primary-b" is the name of the (initial) Primary Replica.
96+
* If you have a load balancer for the compilers in PE Legacy Compiler Group B port 8081, you should use that load balancer address instead of "primary-b"
97+
* Modifies the `puppet_enterprise::profile::master::puppetdb_port` parameter
98+
* Should be set to `[8081]`
99+
100+
### PE Legacy Compiler Group B
101+
102+
Notes on PE Legacy Compiler Group B:
103+
104+
* Modifies the `puppet_enterprise::profile::master::puppetdb_host` parameter
105+
* Should be set to `[${clientcert}, "primary-a"]`, where "primary-a" is the name of the PuppetDB PostgreSQL node paired with the (initial) Primary Replica.
106+
* If you have a load balancer for the compilers in PE Legacy Compiler Group A port 8081, you should use that load balancer address instead of "primary-a"
107+
* Modifies the `puppet_enterprise::profile::master::puppetdb_port` parameter
108+
* Should be set to `[8081]`
109+
110+

documentation/convert.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
The peadm::convert plan can be used to adopt manually deployed infrastructure for use with PEADM or to adopt infrastructure deployed with an older version of peadm.
44

5+
>To understand what classifications PEADM adds to your infrastructure, please see [here](classification.md).
6+
57
## Convert an Existing Deployment
68

79
Prepare to run the plan against all servers in the PE infrastructure, using a params.json file such as this one:

documentation/upgrade.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The `peadm::upgrade` plan requires as input the version of PE to upgrade to, and
88

99
Please note that when upgrading from before 2023.4 to 2023.4 or above and you are using code manager, it is nessesary to provide known hosts for r10k. r10k_known_hosts is an optional parameter and is only required one time when upgrading to 2023.4 or beyond. But if you currently use the SSH protocol to allow r10k to access your remote Git repository, your Code manager or r10k code management tool cannot function until you define the r10k_known_hosts parameter. Subsequent upgrades will already have this and it won't be required again. Please refer to the Puppet Enterprise 2023.4 Upgrade cautions for more details.
1010

11+
>To understand what classifications PEADM adds to your infrastructure, please see [here](classification.md).
12+
1113
The following is an example parameters file for upgrading an Extra Large architecture deployment of PE 2023.2.0 to PE 2023.8.0.
1214

1315
```json

0 commit comments

Comments
 (0)