Skip to content

Commit a7fe10c

Browse files
ragingraCoMfUcIoS
authored andcommitted
(PE-38817) Text fixes for add_replica docs (#496)
1 parent 83ebea1 commit a7fe10c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Diff for: documentation/add_replica.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@
22

33
- [Add Replica](#Add-replica)
44
- [Introduction](#Introduction)
5-
- [Adding Replica to Standard or Large infrastructure](#Adding-Replica-to-Standard-or-Large-infrastructure)
6-
- [Adding Replica to Extra Large infrastructure](#Adding-Replica-to-Extra-Large-infrastructure)
5+
- [Adding a replica to standard and large infrastructures](#Adding-a-replica-to-standard-and-large-infrastructures)
6+
- [Adding a Replica to extra large infrastructure](#Adding-a-Replica-to-extra-large-infrastructure)
77
- [Running the `add_replica` plan](#running-the-add_replica-plan)
88
- [Parameters](#parameters)
99

1010
## Introduction
1111

12-
The `peadm::add_replica` plan is designed to setup disaster recovery of a Primary Puppet Enterprise server. This is acheived through adding a primary replica to your system. Although this plan doesn't change your PE architcture, adding DR does depend on the structure of your current architecture.
12+
The `peadm::add_replica` plan is designed to setup disaster recovery (DR) of a Puppet Enterprise primary server. This is achieved by adding a primary replica to your system. Although this plan doesn't change your PE architecture, adding DR depends on the structure of your current architecture.
1313

14-
In the case of Standard and Large installations, DR can be acheiveived by simply utilising this plan and adding the primary replica. In the case of an Extra Large infrastructure which includes an external DB, a replica DB is also required. This can be done with the `peadm::add_database` plan. For more detail see [Adding External Databases with peadm::add_database](expanding.md#adding-external-databases-with-peadmadd_database).
14+
In the case of standard and large installations, DR can be achieved by simply utilising this plan and adding the primary replica. In the case of an extra large infrastructure which includes an external DB, a replica DB is also required. This can be done with the `peadm::add_database` plan. For more detail see [Adding External Databases with peadm::add_database](expanding.md#adding-external-databases-with-peadmadd_database).
1515

16-
Please note, to setup a replica you must have code manager configured. To learn more about code manager, please see [Puppet Docs](help.puppet.com).
16+
Please note, to setup a replica you must have Code Manager configured. To learn more about code manager, please see [Puppet Docs](help.puppet.com).
1717

1818
...
1919

20-
## Adding Replica to Standard or Large infrastructure
21-
As seen below, this is an example of the required paramaters to add a primary replica. These paramaters can be passed in-line or as a params file.
20+
## Adding a replica to standard and large infrastructures
21+
Below is an example of the required parameters to add a primary replica. These parameters can be passed in-line or as a params file.
2222

2323
```json
2424
{
@@ -27,8 +27,8 @@ As seen below, this is an example of the required paramaters to add a primary re
2727
}
2828
```
2929

30-
## Adding Replica to Extra Large infrastructure
31-
In the below example, we have already have an external DB and a replica of it. This means that we should pass in the additional parameter of the replicas hostname.
30+
## Adding a Replica to extra large infrastructure
31+
In the below example, we already have an external DB and a replica of it. This means that we should pass in the additional parameter of the replica's hostname.
3232

3333
```json
3434
{
@@ -46,17 +46,17 @@ bolt plan run peadm::add_replica --params @params.json
4646

4747
The plan performs the following steps:
4848

49-
1. Installs Puppet Agent on the new replica host.
49+
1. Installs the Puppet agent on the new replica host.
5050
2. Updates classifications with new replica configuration.
51-
3. Provisons the infrastructre replica with PE.
51+
3. Provisions the infrastructure with PE.
5252

5353
## Parameters
5454

5555
### `primary_host`
5656

5757
- **Type:** `Peadm::SingleTargetSpec`
5858
- **Description:**
59-
The hostname and certname of the primary Puppet server .
59+
The hostname and certname of the PE primary server.
6060

6161
### `replica_host`
6262

@@ -74,7 +74,7 @@ The plan performs the following steps:
7474

7575
- **Type:** `Optional[String]`
7676
- **Description:**
77-
Path to token file, only required if located in a non-default location.
77+
The Path to token file, only required if located in a non-default location.
7878

7979

8080

0 commit comments

Comments
 (0)