Skip to content

Commit aa10c39

Browse files
ragingraCoMfUcIoS
authored andcommitted
(PE-38818) Removing experimental and private from add_replica (#478)
* (PE-38818) Removing experimental and private from add_replica * Updating Reference.md --------- Co-authored-by: Neil Anderson <[email protected]>
1 parent 7d37765 commit aa10c39

File tree

2 files changed

+53
-11
lines changed

2 files changed

+53
-11
lines changed

Diff for: REFERENCE.md

+49-3
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@
8989
#### Public Plans
9090

9191
* [`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.
9296
* [`peadm::backup`](#peadm--backup): Backup puppet primary configuration
9397
* [`peadm::backup_ca`](#peadm--backup_ca)
9498
* [`peadm::convert`](#peadm--convert): Convert an existing PE cluster to a PEAdm-managed cluster
@@ -103,9 +107,6 @@
103107
#### Private Plans
104108

105109
* `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.
109110
* `peadm::misc::divert_code_manager`: This plan exists to account for a scenario where a PE XL
110111
* `peadm::modify_cert_extensions`
111112
* `peadm::subplans::component_install`: Install a new PEADM component
@@ -1604,6 +1605,51 @@ Optional[Enum[
16041605

16051606

16061607

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+
16071653
Default value: `undef`
16081654

16091655
### <a name="peadm--backup"></a>`peadm::backup`

Diff for: plans/add_replica.pp

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
# This plan is still in development and currently considered experimental.
2-
#
3-
# @api private
4-
#
5-
# @summary Replace a replica host for a Standard or Large architecture.
1+
# @summary Add or replace a replica host.
62
# Supported use cases:
7-
# 1: The existing replica is broken, we have a fresh new VM we want to provision the replica to.
3+
# 1: Adding a replica to an existing primary.
4+
# 2: The existing replica is broken, we have a fresh new VM we want to provision the replica to.
85
# @param primary_host - The hostname and certname of the primary Puppet server
96
# @param replica_host - The hostname and certname of the replica VM
107
# @param replica_postgresql_host - The hostname and certname of the host with the replica PE-PosgreSQL database.
11-
# @param token_file - (optional) the token file in a different location than the default.
12-
#
138
# Can be a separate host in an XL architecture, or undef in Standard or Large.
9+
# @param token_file - (optional) the token file in a different location than the default.
1410
plan peadm::add_replica(
1511
# Standard or Large
1612
Peadm::SingleTargetSpec $primary_host,

0 commit comments

Comments
 (0)