Commit 93adb91

committed

(PE-39352) Update REFERENCE.md for new functions.

Also updates the peadm::recovery_opts type doc.

1 parent 0e9b567 commit 93adb91Copy full SHA for 93adb91

File tree

1 file changed

+75

-3

lines changed

REFERENCE.md

1 file changed

+75

-3

lines changed

`‎REFERENCE.md‎`

Lines changed: 75 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`
`17`	`17`	`### Functions`
`18`	`18`
	`19`	+* [`peadm::amend_recovery_defaults_by_pe_version`](#peadm--amend_recovery_defaults_by_pe_version)
`19`	`20`	* [`peadm::assert_supported_architecture`](#peadm--assert_supported_architecture): Assert that the architecture given is a supported one
`20`	`21`	* [`peadm::assert_supported_bolt_version`](#peadm--assert_supported_bolt_version): Assert that the Bolt executable running PEAdm is a supported version
`21`	`22`	* [`peadm::assert_supported_pe_version`](#peadm--assert_supported_pe_version): Assert that the PE version given is supported by PEAdm
`@@ -39,6 +40,7 @@`
`39`	`40`	* [`peadm::recovery_opts_all`](#peadm--recovery_opts_all)
`40`	`41`	* [`peadm::recovery_opts_default`](#peadm--recovery_opts_default)
`41`	`42`	* [`peadm::update_pe_conf`](#peadm--update_pe_conf): Update the pe.conf file on a target with the provided hash
	`43`	+* [`peadm::validated_pe_version_for_backup_restore`](#peadm--validated_pe_version_for_backup_restore): Verify that pe_version string is a valid SemVer. If not, warn, and return "0.0.0" as a permissive default.
`42`	`44`	* [`peadm::wait_until_service_ready`](#peadm--wait_until_service_ready): A convenience function to help remember port numbers for services and handle running the wait_until_service_ready task
`43`	`45`
`44`	`46`	`### Data types`
`@@ -139,6 +141,36 @@ Supported use cases:`
`139`	`141`
`140`	`142`	`## Functions`
`141`	`143`
	`144`	+### <a name="peadm--amend_recovery_defaults_by_pe_version"></a>`peadm::amend_recovery_defaults_by_pe_version`
	`145`	`+`
	`146`	`+Type: Puppet Language`
	`147`	`+`
	`148`	`+The peadm::amend_recovery_defaults_by_pe_version function.`
	`149`	`+`
	`150`	+#### `peadm::amend_recovery_defaults_by_pe_version(Hash $base_opts, Peadm::Pe_version $pe_version, Boolean $opt_value)`
	`151`	`+`
	`152`	`+The peadm::amend_recovery_defaults_by_pe_version function.`
	`153`	`+`
	`154`	+Returns: `Any`
	`155`	`+`
	`156`	+##### `base_opts`
	`157`	`+`
	`158`	+Data type: `Hash`
	`159`	`+`
	`160`	`+`
	`161`	`+`
	`162`	+##### `pe_version`
	`163`	`+`
	`164`	+Data type: `Peadm::Pe_version`
	`165`	`+`
	`166`	`+`
	`167`	`+`
	`168`	+##### `opt_value`
	`169`	`+`
	`170`	+Data type: `Boolean`
	`171`	`+`
	`172`	`+`
	`173`	`+`
`142`	`174`	### <a name="peadm--assert_supported_architecture"></a>`peadm::assert_supported_architecture`
`143`	`175`
`144`	`176`	`Type: Puppet Language`
`@@ -787,12 +819,18 @@ Type: Puppet Language`
`787`	`819`
`788`	`820`	`The peadm::migration_opts_default function.`
`789`	`821`
`790`		-#### `peadm::migration_opts_default()`
	`822`	+#### `peadm::migration_opts_default(Peadm::Pe_version $pe_version)`
`791`	`823`
`792`	`824`	`The peadm::migration_opts_default function.`
`793`	`825`
`794`	`826`	Returns: `Any`
`795`	`827`
	`828`	+##### `pe_version`
	`829`	`+`
	`830`	+Data type: `Peadm::Pe_version`
	`831`	`+`
	`832`	`+`
	`833`	`+`
`796`	`834`	### <a name="peadm--node_manager_yaml_location"></a>`peadm::node_manager_yaml_location`
`797`	`835`
`798`	`836`	`Type: Ruby 4.x API`
`@@ -853,24 +891,36 @@ Type: Puppet Language`
`853`	`891`
`854`	`892`	`The peadm::recovery_opts_all function.`
`855`	`893`
`856`		-#### `peadm::recovery_opts_all()`
	`894`	+#### `peadm::recovery_opts_all(Peadm::Pe_version $pe_version)`
`857`	`895`
`858`	`896`	`The peadm::recovery_opts_all function.`
`859`	`897`
`860`	`898`	Returns: `Any`
`861`	`899`
	`900`	+##### `pe_version`
	`901`	`+`
	`902`	+Data type: `Peadm::Pe_version`
	`903`	`+`
	`904`	`+`
	`905`	`+`
`862`	`906`	### <a name="peadm--recovery_opts_default"></a>`peadm::recovery_opts_default`
`863`	`907`
`864`	`908`	`Type: Puppet Language`
`865`	`909`
`866`	`910`	`The peadm::recovery_opts_default function.`
`867`	`911`
`868`		-#### `peadm::recovery_opts_default()`
	`912`	+#### `peadm::recovery_opts_default(Peadm::Pe_version $pe_version)`
`869`	`913`
`870`	`914`	`The peadm::recovery_opts_default function.`
`871`	`915`
`872`	`916`	Returns: `Any`
`873`	`917`
	`918`	+##### `pe_version`
	`919`	`+`
	`920`	+Data type: `Peadm::Pe_version`
	`921`	`+`
	`922`	`+`
	`923`	`+`
`874`	`924`	### <a name="peadm--update_pe_conf"></a>`peadm::update_pe_conf`
`875`	`925`
`876`	`926`	`Type: Puppet Language`
@@ -895,6 +945,26 @@ Data type: `Hash`
`895`	`945`
`896`	`946`	`The hash to update the pe.conf file with`
`897`	`947`
	`948`	+### <a name="peadm--validated_pe_version_for_backup_restore"></a>`peadm::validated_pe_version_for_backup_restore`
	`949`	`+`
	`950`	`+Type: Puppet Language`
	`951`	`+`
	`952`	`+Verify that pe_version string is a valid SemVer.`
	`953`	`+If not, warn, and return "0.0.0" as a permissive default.`
	`954`	`+`
	`955`	+#### `peadm::validated_pe_version_for_backup_restore(Optional[String] $pe_version)`
	`956`	`+`
	`957`	`+Verify that pe_version string is a valid SemVer.`
	`958`	`+If not, warn, and return "0.0.0" as a permissive default.`
	`959`	`+`
	`960`	+Returns: `Any`
	`961`	`+`
	`962`	+##### `pe_version`
	`963`	`+`
	`964`	+Data type: `Optional[String]`
	`965`	`+`
	`966`	`+`
	`967`	`+`
`898`	`968`	### <a name="peadm--wait_until_service_ready"></a>`peadm::wait_until_service_ready`
`899`	`969`
`900`	`970`	`Type: Puppet Language`
`@@ -1014,6 +1084,8 @@ Struct[{`
`1014`	`1084`	`'orchestrator' => Optional[Boolean],`
`1015`	`1085`	`'puppetdb' => Optional[Boolean],`
`1016`	`1086`	`'rbac' => Optional[Boolean],`
	`1087`	`+ 'hac' => Optional[Boolean],`
	`1088`	`+ 'patching' => Optional[Boolean],`
`1017`	`1089`	`}]`
`1018`	`1090`	```
`1019`	`1091`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 93adb91

File tree

1 file changed

1 file changed

`‎REFERENCE.md‎`

0 commit comments