Skip to content

Commit 592acd2

Browse files
author
mh
committed
re-generate strings
1 parent 2d6bd1c commit 592acd2

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

REFERENCE.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
* [`trocla_lookup_key`](#trocla_lookup_key): The `trocla_lookup_key` is a hiera 5 `lookup_key` data provider function.
2222
* [`trocla_set`](#trocla_set): This will set a password/hash in the local storage and return itself, or hashed in another format, if the password is present in plaintext
2323

24+
### Data types
25+
26+
* [`Trocla::HooksConfig`](#Trocla--HooksConfig): the trocla hooks config options
27+
2428
## Classes
2529

2630
### <a name="trocla--ca--params"></a>`trocla::ca::params`
@@ -76,6 +80,7 @@ The following parameters are available in the `trocla::config` class:
7680
* [`encryption_options`](#-trocla--config--encryption_options)
7781
* [`manage_dependencies`](#-trocla--config--manage_dependencies)
7882
* [`edit_uid`](#-trocla--config--edit_uid)
83+
* [`hooks`](#-trocla--config--hooks)
7984

8085
##### <a name="-trocla--config--options"></a>`options`
8186

@@ -155,6 +160,14 @@ Name of the group assigned to the troclarc file.
155160

156161
Default value: `'puppet'`
157162

163+
##### <a name="-trocla--config--hooks"></a>`hooks`
164+
165+
Data type: `Optional[Trocla::HooksConfig]`
166+
167+
Trocla Hooks configuration
168+
169+
Default value: `undef`
170+
158171
### <a name="trocla--master"></a>`trocla::master`
159172

160173
Manage the necessary things for trocla on a master.
@@ -303,7 +316,7 @@ Type: Ruby 4.x API
303316
The `trocla_gsub` replaces %%TROCLA_[\w_\-]+%% place holders with
304317
data looked up in trocla
305318

306-
#### `trocla::gsub(String $data, Optional[Struct[{ prefix => Optional[String] }]] $options)`
319+
#### `trocla::gsub(String $data, Optional[Struct[{ prefix => Optional[String], key_to_prefix => Optional[Hash[String,String]] }]] $options)`
307320

308321
The `trocla_gsub` replaces %%TROCLA_[\w_\-]+%% place holders with
309322
data looked up in trocla
@@ -318,7 +331,7 @@ Data type: `String`
318331

319332
##### `options`
320333

321-
Data type: `Optional[Struct[{ prefix => Optional[String] }]]`
334+
Data type: `Optional[Struct[{ prefix => Optional[String], key_to_prefix => Optional[Hash[String,String]] }]]`
322335

323336

324337

@@ -500,3 +513,18 @@ trocla, for example via cli.
500513

501514
Returns: `Any`
502515

516+
## Data types
517+
518+
### <a name="Trocla--HooksConfig"></a>`Trocla::HooksConfig`
519+
520+
the trocla hooks config options
521+
522+
Alias of
523+
524+
```puppet
525+
Struct[{
526+
set => Optional[Hash[String, Stdlib::Unixpath]],
527+
delete => Optional[Hash[String, Stdlib::Unixpath]],
528+
}]
529+
```
530+

0 commit comments

Comments
 (0)