Skip to content

Commit e85822e

Browse files
committed
Mark missed private plans @api private
1 parent aaf4692 commit e85822e

File tree

4 files changed

+6
-88
lines changed

4 files changed

+6
-88
lines changed

REFERENCE.md

Lines changed: 3 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,7 @@
8282
* [`peadm::install`](#peadminstall): Install a new PE cluster
8383
* [`peadm::modify_certificate`](#peadmmodify_certificate): Modify the certificate of one or more targets
8484
* [`peadm::status`](#peadmstatus): Return status information from one or more PE clusters in a table format
85-
* [`peadm::subplans::prepare_agent`](#peadmsubplansprepare_agent)
8685
* [`peadm::upgrade`](#peadmupgrade): Upgrade a PEAdm-managed cluster
87-
* [`peadm::util::db_disable_pglogical`](#peadmutildb_disable_pglogical)
88-
* [`peadm::util::db_purge`](#peadmutildb_purge)
8986

9087
#### Private Plans
9188

@@ -101,8 +98,11 @@ Supported use cases:
10198
* `peadm::subplans::db_populate`: Destructively (re)populates a new or existing database with the contents or a known good source
10299
* `peadm::subplans::install`: Perform initial installation of Puppet Enterprise Extra Large
103100
* `peadm::subplans::modify_certificate`
101+
* `peadm::subplans::prepare_agent`
104102
* `peadm::uninstall`: Single-entry-point plan for uninstalling Puppet Enterprise
105103
* `peadm::util::code_sync_status`
104+
* `peadm::util::db_disable_pglogical`
105+
* `peadm::util::db_purge`
106106
* `peadm::util::insert_csr_extension_requests`
107107
* `peadm::util::retrieve_and_upload`
108108
* `peadm::util::sanitize_pg_pe_conf`
@@ -1783,45 +1783,6 @@ Toggles the usage of colors, you may want to disable if the format is json
17831783

17841784
Default value: `$format`
17851785

1786-
### <a name="peadmsubplansprepare_agent"></a>`peadm::subplans::prepare_agent`
1787-
1788-
The peadm::subplans::prepare_agent class.
1789-
1790-
#### Parameters
1791-
1792-
The following parameters are available in the `peadm::subplans::prepare_agent` plan:
1793-
1794-
* [`targets`](#targets)
1795-
* [`primary_host`](#primary_host)
1796-
* [`certificate_extensions`](#certificate_extensions)
1797-
* [`dns_alt_names`](#dns_alt_names)
1798-
1799-
##### <a name="targets"></a>`targets`
1800-
1801-
Data type: `Peadm::SingleTargetSpec`
1802-
1803-
1804-
1805-
##### <a name="primary_host"></a>`primary_host`
1806-
1807-
Data type: `Peadm::SingleTargetSpec`
1808-
1809-
1810-
1811-
##### <a name="certificate_extensions"></a>`certificate_extensions`
1812-
1813-
Data type: `Hash`
1814-
1815-
1816-
1817-
##### <a name="dns_alt_names"></a>`dns_alt_names`
1818-
1819-
Data type: `Optional[Array]`
1820-
1821-
1822-
1823-
Default value: ``undef``
1824-
18251786
### <a name="peadmupgrade"></a>`peadm::upgrade`
18261787

18271788
Upgrade a PEAdm-managed cluster
@@ -1964,49 +1925,3 @@ Data type: `Optional[Enum[
19641925

19651926
Default value: ``undef``
19661927

1967-
### <a name="peadmutildb_disable_pglogical"></a>`peadm::util::db_disable_pglogical`
1968-
1969-
The peadm::util::db_disable_pglogical class.
1970-
1971-
#### Parameters
1972-
1973-
The following parameters are available in the `peadm::util::db_disable_pglogical` plan:
1974-
1975-
* [`targets`](#targets)
1976-
* [`databases`](#databases)
1977-
1978-
##### <a name="targets"></a>`targets`
1979-
1980-
Data type: `Peadm::SingleTargetSpec`
1981-
1982-
1983-
1984-
##### <a name="databases"></a>`databases`
1985-
1986-
Data type: `Array[String[1]]`
1987-
1988-
1989-
1990-
### <a name="peadmutildb_purge"></a>`peadm::util::db_purge`
1991-
1992-
The peadm::util::db_purge class.
1993-
1994-
#### Parameters
1995-
1996-
The following parameters are available in the `peadm::util::db_purge` plan:
1997-
1998-
* [`targets`](#targets)
1999-
* [`databases`](#databases)
2000-
2001-
##### <a name="targets"></a>`targets`
2002-
2003-
Data type: `TargetSpec`
2004-
2005-
2006-
2007-
##### <a name="databases"></a>`databases`
2008-
2009-
Data type: `Array[String[1]]`
2010-
2011-
2012-

plans/subplans/prepare_agent.pp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @api private
12
plan peadm::subplans::prepare_agent (
23
Peadm::SingleTargetSpec $targets,
34
Peadm::SingleTargetSpec $primary_host,

plans/util/db_disable_pglogical.pp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @api private
12
plan peadm::util::db_disable_pglogical(
23
Peadm::SingleTargetSpec $targets,
34
Array[String[1]] $databases,

plans/util/db_purge.pp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# @api private
12
plan peadm::util::db_purge(
23
TargetSpec $targets,
34
Array[String[1]] $databases,

0 commit comments

Comments
 (0)