Skip to content

Commit 41d6815

Browse files
(PE-40691) review updates
1 parent f6752e8 commit 41d6815

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

documentation/recovery/automated_recovery.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ These instructions provide automated procedures for recovering from select failu
44

55
Manual procedures are documented in [recovery.md](recovery.md)
66

7-
## Recover from failed primary Puppet server
7+
## Recover from failed Puppet primary server
88

99
1. Promote the replica ([official docs](https://puppet.com/docs/pe/2019.8/dr_configure.html#dr-promote-replica))
1010
2. [Replace missing or failed replica Puppet server](#replace-missing-or-failed-replica-puppet-server)
@@ -13,7 +13,7 @@ Manual procedures are documented in [recovery.md](recovery.md)
1313

1414
This procedure uses the following placeholder references.
1515

16-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
16+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
1717
* _\<replica-postgres-server-fqdn\>_ - The FQDN and certname of the PE-PostgreSQL server which resides in the same availability group as the replacement replica Puppet server
1818
* _\<replacement-replica-fqdn\>_ - The FQDN and certname of the replacement replica Puppet server
1919

@@ -28,12 +28,12 @@ This procedure uses the following placeholder references.
2828

2929
## Replace failed PE-PostgreSQL server (A or B side)
3030

31-
The procedure for replacing a failed PE-PostgreSQL server is the same regardless of which PE-PostgreSQL server is missing or if the name of the PE-PostgreSQL server is the same or different. This procedure uses the following placeholder references.
31+
The procedure for replacing a failed PE-PostgreSQL server is the same regardless of which PE-PostgreSQL server is missing or whether the name of the PE-PostgreSQL server is the same or different. This procedure uses the following placeholder references.
3232

3333
* _\<replacement-postgres-server-fqdn\>_ - The FQDN and certname of the new server being brought in to replace the failed PE-PostgreSQL server
3434
* _\<working-postgres-server-fqdn\>_ - The FQDN and certname of the still-working PE-PostgreSQL server
3535
* _\<failed-postgres-server-fqdn\>_ - The FQDN and certname of the failed PE-PostgreSQL server
36-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
36+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
3737
* _\<replica-server-fqdn\>_ - The FQDN and certname of the replica Puppet server
3838

3939
Procedure:
@@ -47,11 +47,11 @@ Procedure:
4747
failed_postgresql_host=<failed-postgres-server-fqdn> \
4848
replacement_postgresql_host=<replacement-postgres-server-fqdn>
4949

50-
## Replace failed replica puppet server AND failed replica pe-postgresql server
50+
## Replace failed replica Puppet server AND failed replica PE-PostgreSQL server
5151

5252
This procedure uses the following placeholder references.
5353

54-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
54+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
5555
* _\<failed-replica-fqdn\>_ - The FQDN and certname of the failed replica Puppet server
5656

5757
1. Ensure the old replica server is forgotten.
@@ -68,7 +68,7 @@ This procedure uses the following placeholder references.
6868
* _\<avail-group-letter\>_ - Either A or B; whichever of the two letter designations the compiler is being assigned to
6969
* _\<compiler-hosts\>_ - A comma-separated list of FQDN and certname of the new compiler(s)
7070
* _\<dns-alt-names\>_ - A comma-separated list of DNS alt names for the compiler
71-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
71+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
7272
* _\<postgresql-server-fqdn\>_ - The FQDN and certname of the PE-PostgreSQL server with availability group _\<avail-group-letter\>_
7373

7474
Procedure:
@@ -82,14 +82,14 @@ Procedure:
8282
dns_alt_names=<dns-alt-names> \
8383
primary_postgresql_host=<postgresql-server-fqdn>
8484

85-
Please note, the optional parameters and values of the plan are as follows.
85+
Please note, the optional parameters and values of the plan are as follows:
8686

8787
<!-- table -->
8888

8989
| Parameter | Default value | Description |
9090
| ------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------ |
9191
| `avail_group_letter` | `A` | By default, each compiler will be added to the primary group A. |
9292
| `dns_alt_names` | `undef` | |
93-
| `primary_postgresql_host` | `undef` | By default, this will pre-populate to the required value depending if your architecture contains HA and or external databases. |
93+
| `primary_postgresql_host` | `undef` | By default, this will pre-populate to the required value depending on whether your architecture contains HA and or external databases. |
9494

9595
For more information around adding compilers to your infrastructure [Expanding Your Deployment](expanding.md#adding-compilers-with-peadmadd_compiler)

documentation/recovery/recovery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The new system needs to be provisioned with the same certificate name as the sys
66

77
Automated procedures are documented in [automated_recovery.md](automated_recovery.md)
88

9-
## Recover from failed primary Puppet server
9+
## Recover from failed Puppet primary server
1010

1111
1. Promote the replica ([official docs](https://puppet.com/docs/pe/2019.8/dr_configure.html#dr-promote-replica))
1212
2. Purge the failed primary server
@@ -20,7 +20,7 @@ Automated procedures are documented in [automated_recovery.md](automated_recover
2020

2121
This procedure uses the following placeholder references.
2222

23-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
23+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
2424
* _\<old-replica-fqdn\>_ - The FQDN and certname of the old replica Puppet server that has failed or is missing
2525
* _\<replacement-replica-fqdn\>_ - The FQDN and certname of the new replica Puppet server
2626
* _\<replacement-avail-group-letter\>_ - Either A or B; whichever of the two letter designations is appropriate for the replacement server. It will be the opposite of the primary server.
@@ -83,7 +83,7 @@ The procedure for replacing a failed PE-PostgreSQL server is the same regardless
8383
* _\<replacement-postgres-server-fqdn\>_ - The FQDN and certname of the new server being brought in to replace the failed PE-PostgreSQL server
8484
* _\<working-postgres-server-fqdn\>_ - The FQDN and certname of the still-working PE-PostgreSQL server
8585
* _\<replacement-avail-group-letter\>_ - Either A or B; whichever of the two letter designations is appropriate for the server being replaced. It will be the opposite of the still-working PE-PostgreSQL server
86-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
86+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
8787

8888
Procedure:
8989

@@ -202,7 +202,7 @@ This procedure uses the following placeholder references.
202202
* _\<avail-group-letter\>_ - Either A or B; whichever of the two letter designations the compiler is being assigned to
203203
* _\<new-compiler-fqdn\>_ - The FQDN and certname of the new compiler
204204
* _\<dns-alt-names\>_ - A comma-separated list of DNS alt names for the compiler
205-
* _\<primary-server-fqdn\>_ - The FQDN and certname of the primary Puppet server
205+
* _\<primary-server-fqdn\>_ - The FQDN and certname of the Puppet primary server
206206
* _\<postgresql-server-fqdn\>_ - The FQDN and certname of the PE-PostgreSQL server with availability group _\<avail-group-letter\>_
207207

208208
1. On _\<postgresql-server-fqdn\>_:

0 commit comments

Comments
 (0)