Skip to content

Commit 4a07155

Browse files
committed
docs: update documentation for converting and upgrading legacy compilers
- Updated the version reference from 3.21 to 3.25 in the upgrade documentation. - Added instructions for using the `peadm::convert_compiler_to_legacy` plan. - Removed outdated steps for updating certificate extensions and converting legacy compilers. - Simplified the upgrade process description for Puppet Enterprise using puppetlabs-peadm module 3.25 or later.
1 parent 438ca01 commit 4a07155

File tree

2 files changed

+13
-24
lines changed

2 files changed

+13
-24
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Convert compilers to legacy
2+
3+
### Puppet Enterprise installed with puppetlabs-peadm version 3.25 or later
4+
5+
To convert compilers to legacy compilers use the `peadm::convert_compiler_to_legacy` plan. This plan will create the needed Node group and Classifier rules to make compilers legacy. Also will add certificate extensions to those nodes.
6+
7+
```shell
8+
bolt plan run peadm::convert_compiler_to_legacy legacy_hosts=compiler1.example.com,compiler2.example.com primary_host=primary.example.com
9+
```

documentation/upgrade_with_legacy_compilers.md

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ As a legacy compiler we refer to a compiler that doesn't have PuppetDB. And a cu
66

77
## Who is this documentation for
88

9-
For those users that have installed Puppet Enterprise with puppetlabs-peadm prior version 3.21 and manually converted their existing complilers (all of the or at least 1) to legacy compilers.
9+
For those users that have installed Puppet Enterprise with puppetlabs-peadm prior version 3.25 and manually converted their existing complilers (all of the or at least 1) to legacy compilers.
1010

1111
## Who is this documentation not for
1212

13-
For those users that have installed Puppet Enterprise with PEADM with 3.21 version or later, there is no need to follow this documentation. The install process will automatically have created the necessary configurations for you and you can use the `peadm::convert_compiler_to_legacy` plan if you need a legacy compiler. example:
13+
For those users that have installed Puppet Enterprise with PEADM with 3.25 version or later, there is no need to follow this documentation. The install process will automatically have created the necessary configurations for you and you can use the `peadm::convert_compiler_to_legacy` plan if you need a legacy compiler. example:
1414

1515
```shell
1616
bolt plan run peadm::convert_compiler_to_legacy legacy_hosts=compiler1.example.com,compiler2.example.com primary_host=primary.example.com
@@ -22,26 +22,6 @@ bolt plan run peadm::convert_compiler_to_legacy legacy_hosts=compiler1.example.c
2222

2323
Usually users pin the nodes in the Pe Master Node Group and then manually removing PuppetDB from compilers nodes. To revert this changes go to your Puppet Enterprise console and unpin the compilers nodes from the Group.
2424

25-
### 2. Update certificate extensions for NON legacy compilers
25+
### 2. Upgrade Puppet Enterprise
2626

27-
If you have NON legacy compilers in your infrastructure, you have to add a certificate extension to them that recognizes them as NON legacy compilers. To do this, execute the following plan:
28-
29-
```shell
30-
bolt plan run peadm::update_compiler_extensions primary_host=primary.example.com compiler_hosts=compiler1.example.com,compiler2.example.com
31-
```
32-
33-
### 3. Use the convert legacy compiler plan
34-
35-
Now that we have unpinned the compilers nodes from the PE Master node group, execute the following plan to convert your needed compilers to legacy compilers:
36-
37-
```shell
38-
bolt plan run peadm::convert_compiler_to_legacy legacy_hosts=compiler1.example.com,compiler2.example.com primary_host=primary.example.com
39-
```
40-
41-
The above will create the needed Node group and Classifier rules to make the compilers legacy. Also will add certificate extensions to those nodes.
42-
43-
If you want to keep puppetDB service on the converted compilers, you can do so by passing the `remove_pdb` parameter as `false`.
44-
45-
### 4. Upgrade Puppet Enterprise
46-
47-
After you have completed the above steps, you can proceed with the upgrade of Puppet Enterprise as usual using the puppetlabs-peadm module. There is no need to do the above ever again.
27+
You can proceed with the upgrade of Puppet Enterprise as usual using the puppetlabs-peadm module 3.25 or later and pass legacy compilers to the upgrade plan.

0 commit comments

Comments
 (0)