Skip to content

Commit faeffea

Browse files
committed
Update documentation
1 parent 5b522f5 commit faeffea

File tree

2 files changed

+66
-4
lines changed

2 files changed

+66
-4
lines changed

REFERENCE.md

+65-2
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ file on an haproxy load balancer.
4949
* `haproxy::mailer::collect_exported`
5050
* `haproxy::service`: HAProxy service
5151

52+
### Functions
53+
54+
* [`haproxy::generate_error_message`](#haproxy--generate_error_message): Function created to generate error message. Any string as error message can be passed and the function can be called in epp templates.
55+
* [`haproxy::sort_bind`](#haproxy--sort_bind)
56+
* [`haproxy::validate_ip_addr`](#haproxy--validate_ip_addr)
57+
5258
## Classes
5359

5460
### <a name="haproxy"></a>`haproxy`
@@ -740,8 +746,7 @@ Data type: `Boolean`
740746

741747
Whether to merge the user-supplied `options` hash with the
742748
`default_options` values set in params.pp. Merging allows to change
743-
or add options without having to recreate the entire hash. Defaults to
744-
false, but will default to true in future releases.
749+
or add options without having to recreate the entire hash.
745750

746751
Default value: `$haproxy::params::merge_options`
747752

@@ -2022,3 +2027,61 @@ Optional. Defaults to 'haproxy'
20222027

20232028
Default value: `'haproxy'`
20242029

2030+
## Functions
2031+
2032+
### <a name="haproxy--generate_error_message"></a>`haproxy::generate_error_message`
2033+
2034+
Type: Ruby 4.x API
2035+
2036+
Function created to generate error message. Any string as error message can be passed and the function can
2037+
be called in epp templates.
2038+
2039+
#### `haproxy::generate_error_message(String $error_message)`
2040+
2041+
Function created to generate error message. Any string as error message can be passed and the function can
2042+
be called in epp templates.
2043+
2044+
Returns: `Any`
2045+
2046+
##### `error_message`
2047+
2048+
Data type: `String`
2049+
2050+
2051+
2052+
### <a name="haproxy--sort_bind"></a>`haproxy::sort_bind`
2053+
2054+
Type: Ruby 4.x API
2055+
2056+
The haproxy::sort_bind function.
2057+
2058+
#### `haproxy::sort_bind(Hash $bind)`
2059+
2060+
The haproxy::sort_bind function.
2061+
2062+
Returns: `Array`
2063+
2064+
##### `bind`
2065+
2066+
Data type: `Hash`
2067+
2068+
2069+
2070+
### <a name="haproxy--validate_ip_addr"></a>`haproxy::validate_ip_addr`
2071+
2072+
Type: Ruby 4.x API
2073+
2074+
The haproxy::validate_ip_addr function.
2075+
2076+
#### `haproxy::validate_ip_addr(String $virtual_ip)`
2077+
2078+
The haproxy::validate_ip_addr function.
2079+
2080+
Returns: `Boolean`
2081+
2082+
##### `virtual_ip`
2083+
2084+
Data type: `String`
2085+
2086+
2087+

manifests/defaults.pp

+1-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@
1919
# @param merge_options
2020
# Whether to merge the user-supplied `options` hash with the
2121
# `default_options` values set in params.pp. Merging allows to change
22-
# or add options without having to recreate the entire hash. Defaults to
23-
# false, but will default to true in future releases.
22+
# or add options without having to recreate the entire hash.
2423
#
2524
# @param instance
2625
# Optional. Defaults to 'haproxy'.

0 commit comments

Comments
 (0)