Skip to content

Commit f71ced7

Browse files
(PE-40163) update reference.md
1 parent cdae5da commit f71ced7

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

REFERENCE.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ Supported use cases:
109109
* [`peadm::convert`](#peadm--convert): Convert an existing PE cluster to a PEAdm-managed cluster
110110
* [`peadm::install`](#peadm--install): Install a new PE cluster
111111
* [`peadm::modify_certificate`](#peadm--modify_certificate): Modify the certificate of one or more targets
112+
* [`peadm::replace_failed_postgresql`](#peadm--replace_failed_postgresql): Replaces a failed PostgreSQL host
112113
* [`peadm::restore`](#peadm--restore): Restore puppet primary configuration
113114
* [`peadm::restore_ca`](#peadm--restore_ca)
114115
* [`peadm::status`](#peadm--status): Return status information from one or more PE clusters in a table format
@@ -2370,6 +2371,50 @@ Data type: `Boolean`
23702371

23712372
Default value: `false`
23722373

2374+
### <a name="peadm--replace_failed_postgresql"></a>`peadm::replace_failed_postgresql`
2375+
2376+
Replaces a failed PostgreSQL host
2377+
2378+
#### Parameters
2379+
2380+
The following parameters are available in the `peadm::replace_failed_postgresql` plan:
2381+
2382+
* [`primary_host`](#-peadm--replace_failed_postgresql--primary_host)
2383+
* [`replica_host`](#-peadm--replace_failed_postgresql--replica_host)
2384+
* [`working_postgresql_host`](#-peadm--replace_failed_postgresql--working_postgresql_host)
2385+
* [`failed_postgresql_host`](#-peadm--replace_failed_postgresql--failed_postgresql_host)
2386+
* [`replacement_postgresql_host`](#-peadm--replace_failed_postgresql--replacement_postgresql_host)
2387+
2388+
##### <a name="-peadm--replace_failed_postgresql--primary_host"></a>`primary_host`
2389+
2390+
Data type: `Peadm::SingleTargetSpec`
2391+
2392+
- The hostname and certname of the primary Puppet server
2393+
2394+
##### <a name="-peadm--replace_failed_postgresql--replica_host"></a>`replica_host`
2395+
2396+
Data type: `Peadm::SingleTargetSpec`
2397+
2398+
- The hostname and certname of the replica VM
2399+
2400+
##### <a name="-peadm--replace_failed_postgresql--working_postgresql_host"></a>`working_postgresql_host`
2401+
2402+
Data type: `Peadm::SingleTargetSpec`
2403+
2404+
- The hostname and certname of the still-working PE-PostgreSQL server
2405+
2406+
##### <a name="-peadm--replace_failed_postgresql--failed_postgresql_host"></a>`failed_postgresql_host`
2407+
2408+
Data type: `Peadm::SingleTargetSpec`
2409+
2410+
- The hostname and certname of the failed PE-PostgreSQL server
2411+
2412+
##### <a name="-peadm--replace_failed_postgresql--replacement_postgresql_host"></a>`replacement_postgresql_host`
2413+
2414+
Data type: `Peadm::SingleTargetSpec`
2415+
2416+
- The hostname and certname of the server being brought in to replace the failed PE-PostgreSQL server
2417+
23732418
### <a name="peadm--restore"></a>`peadm::restore`
23742419

23752420
Restore puppet primary configuration

0 commit comments

Comments
 (0)