You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/add_replica.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,23 @@
2
2
3
3
-[Add Replica](#Add-replica)
4
4
-[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)
7
7
-[Running the `add_replica` plan](#running-the-add_replica-plan)
8
8
-[Parameters](#parameters)
9
9
10
10
## Introduction
11
11
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.
13
13
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).
15
15
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).
17
17
18
18
...
19
19
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.
22
22
23
23
```json
24
24
{
@@ -27,8 +27,8 @@ As seen below, this is an example of the required paramaters to add a primary re
27
27
}
28
28
```
29
29
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.
32
32
33
33
```json
34
34
{
@@ -46,17 +46,17 @@ bolt plan run peadm::add_replica --params @params.json
46
46
47
47
The plan performs the following steps:
48
48
49
-
1. Installs Puppet Agent on the new replica host.
49
+
1. Installs the Puppet agent on the new replica host.
50
50
2. Updates classifications with new replica configuration.
51
-
3.Provisons the infrastructre replica with PE.
51
+
3.Provisions the infrastructure with PE.
52
52
53
53
## Parameters
54
54
55
55
### `primary_host`
56
56
57
57
-**Type:**`Peadm::SingleTargetSpec`
58
58
-**Description:**
59
-
The hostname and certname of the primary Puppet server.
59
+
The hostname and certname of the PE primary server.
60
60
61
61
### `replica_host`
62
62
@@ -74,7 +74,7 @@ The plan performs the following steps:
74
74
75
75
-**Type:**`Optional[String]`
76
76
-**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.
0 commit comments