|
89 | 89 | #### Public Plans
|
90 | 90 |
|
91 | 91 | * [`peadm::add_database`](#peadm--add_database)
|
| 92 | +* [`peadm::add_replica`](#peadm--add_replica): Add or replace a replica host. |
| 93 | +Supported use cases: |
| 94 | +1: Adding a replica to an existing primary. |
| 95 | +2: The existing replica is broken, we have a fresh new VM we want to provision the replica to. |
92 | 96 | * [`peadm::backup`](#peadm--backup): Backup puppet primary configuration
|
93 | 97 | * [`peadm::backup_ca`](#peadm--backup_ca)
|
94 | 98 | * [`peadm::convert`](#peadm--convert): Convert an existing PE cluster to a PEAdm-managed cluster
|
|
103 | 107 | #### Private Plans
|
104 | 108 |
|
105 | 109 | * `peadm::add_compiler`: Add a new compiler to a PE architecture or replace an existing one with new configuration.
|
106 |
| -* `peadm::add_replica`: Replace a replica host for a Standard or Large architecture. |
107 |
| -Supported use cases: |
108 |
| -1: The existing replica is broken, we have a fresh new VM we want to provision the replica to. |
109 | 110 | * `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL
|
110 | 111 | * `peadm::modify_cert_extensions`
|
111 | 112 | * `peadm::subplans::component_install`: Install a new PEADM component
|
@@ -1604,6 +1605,51 @@ Optional[Enum[
|
1604 | 1605 |
|
1605 | 1606 |
|
1606 | 1607 |
|
| 1608 | +Default value: `undef` |
| 1609 | + |
| 1610 | +### <a name="peadm--add_replica"></a>`peadm::add_replica` |
| 1611 | + |
| 1612 | +Add or replace a replica host. |
| 1613 | +Supported use cases: |
| 1614 | +1: Adding a replica to an existing primary. |
| 1615 | +2: The existing replica is broken, we have a fresh new VM we want to provision the replica to. |
| 1616 | + |
| 1617 | +#### Parameters |
| 1618 | + |
| 1619 | +The following parameters are available in the `peadm::add_replica` plan: |
| 1620 | + |
| 1621 | +* [`primary_host`](#-peadm--add_replica--primary_host) |
| 1622 | +* [`replica_host`](#-peadm--add_replica--replica_host) |
| 1623 | +* [`replica_postgresql_host`](#-peadm--add_replica--replica_postgresql_host) |
| 1624 | +* [`token_file`](#-peadm--add_replica--token_file) |
| 1625 | + |
| 1626 | +##### <a name="-peadm--add_replica--primary_host"></a>`primary_host` |
| 1627 | + |
| 1628 | +Data type: `Peadm::SingleTargetSpec` |
| 1629 | + |
| 1630 | +- The hostname and certname of the primary Puppet server |
| 1631 | + |
| 1632 | +##### <a name="-peadm--add_replica--replica_host"></a>`replica_host` |
| 1633 | + |
| 1634 | +Data type: `Peadm::SingleTargetSpec` |
| 1635 | + |
| 1636 | +- The hostname and certname of the replica VM |
| 1637 | + |
| 1638 | +##### <a name="-peadm--add_replica--replica_postgresql_host"></a>`replica_postgresql_host` |
| 1639 | + |
| 1640 | +Data type: `Optional[Peadm::SingleTargetSpec]` |
| 1641 | + |
| 1642 | +- The hostname and certname of the host with the replica PE-PosgreSQL database. |
| 1643 | +Can be a separate host in an XL architecture, or undef in Standard or Large. |
| 1644 | + |
| 1645 | +Default value: `undef` |
| 1646 | + |
| 1647 | +##### <a name="-peadm--add_replica--token_file"></a>`token_file` |
| 1648 | + |
| 1649 | +Data type: `Optional[String]` |
| 1650 | + |
| 1651 | +- (optional) the token file in a different location than the default. |
| 1652 | + |
1607 | 1653 | Default value: `undef`
|
1608 | 1654 |
|
1609 | 1655 | ### <a name="peadm--backup"></a>`peadm::backup`
|
|
0 commit comments