7676
7777#### Public Plans
7878
79+ * [ ` peadm::add_database ` ] ( #peadmadd_database )
7980* [ ` peadm::backup ` ] ( #peadmbackup ) : Backup the core user settings for puppet infrastructure
8081* [ ` peadm::convert ` ] ( #peadmconvert ) : Convert an existing PE cluster to a PEAdm-managed cluster
8182* [ ` peadm::install ` ] ( #peadminstall ) : Install a new PE cluster
8283* [ ` peadm::modify_certificate ` ] ( #peadmmodify_certificate ) : Modify the certificate of one or more targets
8384* [ ` peadm::status ` ] ( #peadmstatus ) : Return status information from one or more PE clusters in a table format
85+ * [ ` peadm::subplans::prepare_agent ` ] ( #peadmsubplansprepare_agent )
8486* [ ` peadm::upgrade ` ] ( #peadmupgrade ) : Upgrade a PEAdm-managed cluster
87+ * [ ` peadm::util::db_disable_pglogical ` ] ( #peadmutildb_disable_pglogical )
88+ * [ ` peadm::util::db_purge ` ] ( #peadmutildb_purge )
8589
8690#### Private Plans
8791
@@ -92,13 +96,18 @@ Supported use cases:
9296 The new replica should have the same certname as the broken one.
9397* ` peadm::misc::divert_code_manager ` : This plan exists to account for a scenario where a PE XL
9498* ` peadm::modify_cert_extensions `
99+ * ` peadm::subplans::component_install ` : Install a new PEADM component
95100* ` peadm::subplans::configure ` : Configure first-time classification and DR setup
101+ * ` peadm::subplans::db_populate ` : Destructively (re)populates a new or existing database with the contents or a known good source
96102* ` peadm::subplans::install ` : Perform initial installation of Puppet Enterprise Extra Large
97103* ` peadm::subplans::modify_certificate `
98104* ` peadm::uninstall ` : Single-entry-point plan for uninstalling Puppet Enterprise
105+ * ` peadm::util::code_sync_status `
99106* ` peadm::util::insert_csr_extension_requests `
100107* ` peadm::util::retrieve_and_upload `
101108* ` peadm::util::sanitize_pg_pe_conf `
109+ * ` peadm::util::update_classification ` : Configure classification
110+ * ` peadm::util::update_db_setting ` : Make updates to PuppetDB database settings
102111
103112## Classes
104113
@@ -1226,6 +1235,53 @@ Which port to query the status API on
12261235
12271236## Plans
12281237
1238+ ### <a name =" peadmadd_database " ></a >` peadm::add_database `
1239+
1240+ The peadm::add_database class.
1241+
1242+ #### Parameters
1243+
1244+ The following parameters are available in the ` peadm::add_database ` plan:
1245+
1246+ * [ ` targets ` ] ( #targets )
1247+ * [ ` primary_host ` ] ( #primary_host )
1248+ * [ ` mode ` ] ( #mode )
1249+ * [ ` begin_at_step ` ] ( #begin_at_step )
1250+
1251+ ##### <a name =" targets " ></a >` targets `
1252+
1253+ Data type: ` Peadm::SingleTargetSpec `
1254+
1255+
1256+
1257+ ##### <a name =" primary_host " ></a >` primary_host `
1258+
1259+ Data type: ` Peadm::SingleTargetSpec `
1260+
1261+
1262+
1263+ ##### <a name =" mode " ></a >` mode `
1264+
1265+ Data type: ` Optional[Enum['init', 'pair']] `
1266+
1267+
1268+
1269+ Default value: `` undef ``
1270+
1271+ ##### <a name =" begin_at_step " ></a >` begin_at_step `
1272+
1273+ Data type: `Optional[ Enum[
1274+ 'init-db-node',
1275+ 'replicate-db',
1276+ 'update-classification',
1277+ 'update-db-settings',
1278+ 'cleanup-db',
1279+ 'finalize']] `
1280+
1281+
1282+
1283+ Default value: `` undef ``
1284+
12291285### <a name =" peadmbackup " ></a >` peadm::backup `
12301286
12311287This plan can backup data as outlined at insert doc
@@ -1727,6 +1783,45 @@ Toggles the usage of colors, you may want to disable if the format is json
17271783
17281784Default value: ` $format `
17291785
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+
17301825### <a name =" peadmupgrade " ></a >` peadm::upgrade `
17311826
17321827Upgrade a PEAdm-managed cluster
@@ -1869,3 +1964,49 @@ Data type: `Optional[Enum[
18691964
18701965Default value: `` undef ``
18711966
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+
0 commit comments