Skip to content

Commit 94a2ac6

Browse files
committed
(PE-39352) Update REFERENCE.md for new functions.
1 parent ef01b7d commit 94a2ac6

File tree

1 file changed

+74
-3
lines changed

1 file changed

+74
-3
lines changed

REFERENCE.md

+74-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
### Functions
1818

19+
* [`peadm::amend_recovery_defaults_by_pe_version`](#peadm--amend_recovery_defaults_by_pe_version)
1920
* [`peadm::assert_supported_architecture`](#peadm--assert_supported_architecture): Assert that the architecture given is a supported one
2021
* [`peadm::assert_supported_bolt_version`](#peadm--assert_supported_bolt_version): Assert that the Bolt executable running PEAdm is a supported version
2122
* [`peadm::assert_supported_pe_version`](#peadm--assert_supported_pe_version): Assert that the PE version given is supported by PEAdm
@@ -39,6 +40,7 @@
3940
* [`peadm::recovery_opts_all`](#peadm--recovery_opts_all)
4041
* [`peadm::recovery_opts_default`](#peadm--recovery_opts_default)
4142
* [`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.
4244
* [`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
4345

4446
### Data types
@@ -139,6 +141,36 @@ Supported use cases:
139141

140142
## Functions
141143

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+
142174
### <a name="peadm--assert_supported_architecture"></a>`peadm::assert_supported_architecture`
143175

144176
Type: Puppet Language
@@ -787,12 +819,18 @@ Type: Puppet Language
787819

788820
The peadm::migration_opts_default function.
789821

790-
#### `peadm::migration_opts_default()`
822+
#### `peadm::migration_opts_default(Peadm::Pe_version $pe_version)`
791823

792824
The peadm::migration_opts_default function.
793825

794826
Returns: `Any`
795827

828+
##### `pe_version`
829+
830+
Data type: `Peadm::Pe_version`
831+
832+
833+
796834
### <a name="peadm--node_manager_yaml_location"></a>`peadm::node_manager_yaml_location`
797835

798836
Type: Ruby 4.x API
@@ -853,24 +891,36 @@ Type: Puppet Language
853891

854892
The peadm::recovery_opts_all function.
855893

856-
#### `peadm::recovery_opts_all()`
894+
#### `peadm::recovery_opts_all(Peadm::Pe_version $pe_version)`
857895

858896
The peadm::recovery_opts_all function.
859897

860898
Returns: `Any`
861899

900+
##### `pe_version`
901+
902+
Data type: `Peadm::Pe_version`
903+
904+
905+
862906
### <a name="peadm--recovery_opts_default"></a>`peadm::recovery_opts_default`
863907

864908
Type: Puppet Language
865909

866910
The peadm::recovery_opts_default function.
867911

868-
#### `peadm::recovery_opts_default()`
912+
#### `peadm::recovery_opts_default(Peadm::Pe_version $pe_version)`
869913

870914
The peadm::recovery_opts_default function.
871915

872916
Returns: `Any`
873917

918+
##### `pe_version`
919+
920+
Data type: `Peadm::Pe_version`
921+
922+
923+
874924
### <a name="peadm--update_pe_conf"></a>`peadm::update_pe_conf`
875925

876926
Type: Puppet Language
@@ -895,6 +945,26 @@ Data type: `Hash`
895945

896946
The hash to update the pe.conf file with
897947

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+
898968
### <a name="peadm--wait_until_service_ready"></a>`peadm::wait_until_service_ready`
899969

900970
Type: Puppet Language
@@ -1014,6 +1084,7 @@ Struct[{
10141084
'orchestrator' => Optional[Boolean],
10151085
'puppetdb' => Optional[Boolean],
10161086
'rbac' => Optional[Boolean],
1087+
'hac' => Optional[Boolean],
10171088
}]
10181089
```
10191090

0 commit comments

Comments
 (0)