Mercurial > repos > other > Puppet

comparison modules/concat/REFERENCE.md @ 478:adf6fe9bbc17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update Puppet modules to latest versions
author IBBoard <dev@ibboard.co.uk>
date Thu, 29 Aug 2024 18:47:29 +0100
parents d9352a684e62
children
comparison
equal deleted inserted replaced
477:21f6add30502 478:adf6fe9bbc17
1 # Reference 1 # Reference
2
2 <!-- DO NOT EDIT: This document was generated by Puppet Strings --> 3 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
3 4
4 ## Table of Contents 5 ## Table of Contents
5 6
6 **Defined types** 7 ### Defined types
7 8
8 * [`concat`](#concat): Manages a file, compiled from one or more text fragments. 9 * [`concat`](#concat): Manages a file, compiled from one or more text fragments.
9 * [`concat::fragment`](#concatfragment): Manages a fragment of text to be compiled into a file. 10 * [`concat::fragment`](#concat--fragment): Manages a fragment of text to be compiled into a file.
10 11
11 **Resource types** 12 ### Resource types
12 13
13 * [`concat_file`](#concat_file): Generates a file with content from fragments sharing a common unique tag. 14 * [`concat_file`](#concat_file): Generates a file with content from fragments sharing a common unique tag.
14 * [`concat_fragment`](#concat_fragment): Manages the fragment. 15 * [`concat_fragment`](#concat_fragment): Manages the fragment.
15 16
16 ## Defined types 17 ## Defined types
17 18
18 ### concat 19 ### <a name="concat"></a>`concat`
19 20
20 Manages a file, compiled from one or more text fragments. 21 Manages a file, compiled from one or more text fragments.
21 22
22 #### Examples 23 #### Examples
23 24
32 } 33 }
33 ``` 34 ```
34 35
35 #### Parameters 36 #### Parameters
36 37
37 The following parameters are available in the `concat` defined type. 38 The following parameters are available in the `concat` defined type:
38 39
39 ##### `backup` 40 * [`backup`](#-concat--backup)
41 * [`ensure`](#-concat--ensure)
42 * [`ensure_newline`](#-concat--ensure_newline)
43 * [`format`](#-concat--format)
44 * [`force`](#-concat--force)
45 * [`group`](#-concat--group)
46 * [`mode`](#-concat--mode)
47 * [`order`](#-concat--order)
48 * [`owner`](#-concat--owner)
49 * [`path`](#-concat--path)
50 * [`replace`](#-concat--replace)
51 * [`selinux_ignore_defaults`](#-concat--selinux_ignore_defaults)
52 * [`selrange`](#-concat--selrange)
53 * [`selrole`](#-concat--selrole)
54 * [`seltype`](#-concat--seltype)
55 * [`seluser`](#-concat--seluser)
56 * [`show_diff`](#-concat--show_diff)
57 * [`validate_cmd`](#-concat--validate_cmd)
58 * [`warn`](#-concat--warn)
59 * [`create_empty_file`](#-concat--create_empty_file)
60
61 ##### <a name="-concat--backup"></a>`backup`
40 62
41 Data type: `Variant[Boolean, String]` 63 Data type: `Variant[Boolean, String]`
42 64
43 Specifies whether (and how) to back up the destination file before overwriting it. Your value gets passed on to Puppet's native file 65 Specifies whether (and how) to back up the destination file before overwriting it. Your value gets passed on to Puppet's native file
44 resource for execution. Valid options: true, false, or a string representing either a target filebucket or a filename extension 66 resource for execution. Valid options: true, false, or a string representing either a target filebucket or a filename extension
45 beginning with ".". 67 beginning with ".".
46 68
47 Default value: 'puppet' 69 Default value: `'puppet'`
48 70
49 ##### `ensure` 71 ##### <a name="-concat--ensure"></a>`ensure`
50 72
51 Data type: `Enum['present', 'absent']` 73 Data type: `Enum['present', 'absent']`
52 74
53 Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and 75 Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and
54 negates the effect of any other parameters. 76 negates the effect of any other parameters.
55 77
56 Default value: 'present' 78 Default value: `'present'`
57 79
58 ##### `ensure_newline` 80 ##### <a name="-concat--ensure_newline"></a>`ensure_newline`
59 81
60 Data type: `Boolean` 82 Data type: `Boolean`
61 83
62 Specifies whether to add a line break at the end of each fragment that doesn't already end in one. 84 Specifies whether to add a line break at the end of each fragment that doesn't already end in one.
63 85
64 Default value: `false` 86 Default value: `false`
65 87
66 ##### `format` 88 ##### <a name="-concat--format"></a>`format`
67 89
68 Data type: `Optional[String]` 90 Data type: `Enum['plain', 'yaml', 'json', 'json-array', 'json-pretty', 'json-array-pretty']`
69 91
70 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty', 92 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty',
71 'json-array-pretty'. 93 'json-array-pretty'.
72 94
73 Default value: 'plain' 95 Default value: `'plain'`
74 96
75 ##### `force` 97 ##### <a name="-concat--force"></a>`force`
76 98
77 Data type: `Optional[Boolean]` 99 Data type: `Boolean`
78 100
79 Specifies whether to merge data structures, keeping the values with higher order. Used when format is specified as a value other than 101 Specifies whether to merge data structures, keeping the values with higher order. Used when format is specified as a value other than
80 'plain'. 102 'plain'.
81 103
82 Default value: `false` 104 Default value: `false`
83 105
84 ##### `group` 106 ##### <a name="-concat--group"></a>`group`
85 107
86 Data type: `Optional[Variant[String, Integer]]` 108 Data type: `Optional[Variant[String, Integer]]`
87 109
88 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer containing a gid. 110 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer containing a gid.
89 111
90 Default value: `undef` 112 Default value: `undef`
91 113
92 ##### `mode` 114 ##### <a name="-concat--mode"></a>`mode`
93 115
94 Data type: `String` 116 Data type: `String`
95 117
96 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation. 118 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation.
97 119
98 Default value: '0644' 120 Default value: `'0644'`
99 121
100 ##### `order` 122 ##### <a name="-concat--order"></a>`order`
101 123
102 Data type: `Enum['alpha','numeric']` 124 Data type: `Enum['alpha','numeric']`
103 125
104 Specifies a method for sorting your fragments by name within the destination file. You can override this setting for individual 126 Specifies a method for sorting your fragments by name within the destination file. You can override this setting for individual
105 fragments by adjusting the order parameter in their concat::fragment declarations. 127 fragments by adjusting the order parameter in their concat::fragment declarations.
106 128
107 Default value: 'alpha' 129 Default value: `'alpha'`
108 130
109 ##### `owner` 131 ##### <a name="-concat--owner"></a>`owner`
110 132
111 Data type: `Optional[Variant[String, Integer]]` 133 Data type: `Optional[Variant[String, Integer]]`
112 134
113 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid. 135 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid.
114 136
115 Default value: `undef` 137 Default value: `undef`
116 138
117 ##### `path` 139 ##### <a name="-concat--path"></a>`path`
118 140
119 Data type: `Stdlib::Absolutepath` 141 Data type: `Stdlib::Absolutepath`
120 142
121 Specifies a destination file for the combined fragments. 143 Specifies a destination file for the combined fragments.
122 144
123 Default value: $name 145 Default value: `$name`
124 146
125 ##### `replace` 147 ##### <a name="-concat--replace"></a>`replace`
126 148
127 Data type: `Boolean` 149 Data type: `Boolean`
128 150
129 Specifies whether to overwrite the destination file if it already exists. 151 Specifies whether to overwrite the destination file if it already exists.
130 152
131 Default value: `true` 153 Default value: `true`
132 154
133 ##### `selinux_ignore_defaults` 155 ##### <a name="-concat--selinux_ignore_defaults"></a>`selinux_ignore_defaults`
134 156
135 Data type: `Optional[Boolean]` 157 Data type: `Optional[Boolean]`
136 158
137 See the file type's selinux_ignore_defaults documentention: 159 See the file type's selinux_ignore_defaults documentention:
138 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults 160 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults
139 161
140 Default value: `undef` 162 Default value: `undef`
141 163
142 ##### `selrange` 164 ##### <a name="-concat--selrange"></a>`selrange`
143 165
144 Data type: `Optional[String]` 166 Data type: `Optional[String]`
145 167
146 See the file type's selrange documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange 168 See the file type's selrange documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange
147 169
148 Default value: `undef` 170 Default value: `undef`
149 171
150 ##### `selrole` 172 ##### <a name="-concat--selrole"></a>`selrole`
151 173
152 Data type: `Optional[String]` 174 Data type: `Optional[String]`
153 175
154 See the file type's selrole documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole 176 See the file type's selrole documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole
155 177
156 Default value: `undef` 178 Default value: `undef`
157 179
158 ##### `seltype` 180 ##### <a name="-concat--seltype"></a>`seltype`
159 181
160 Data type: `Optional[String]` 182 Data type: `Optional[String]`
161 183
162 See the file type's seltype documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype 184 See the file type's seltype documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype
163 185
164 Default value: `undef` 186 Default value: `undef`
165 187
166 ##### `seluser` 188 ##### <a name="-concat--seluser"></a>`seluser`
167 189
168 Data type: `Optional[String]` 190 Data type: `Optional[String]`
169 191
170 See the file type's seluser documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser 192 See the file type's seluser documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser
171 193
172 Default value: `undef` 194 Default value: `undef`
173 195
174 ##### `show_diff` 196 ##### <a name="-concat--show_diff"></a>`show_diff`
175 197
176 Data type: `Boolean` 198 Data type: `Boolean`
177 199
178 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from insecure 200 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from insecure
179 reporting methods. 201 reporting methods.
180 202
181 Default value: `true` 203 Default value: `true`
182 204
183 ##### `validate_cmd` 205 ##### <a name="-concat--validate_cmd"></a>`validate_cmd`
184 206
185 Data type: `Optional[String]` 207 Data type: `Optional[String]`
186 208
187 Specifies a validation command to apply to the destination file. 209 Specifies a validation command to apply to the destination file.
188 210
189 Default value: `undef` 211 Default value: `undef`
190 212
191 ##### `warn` 213 ##### <a name="-concat--warn"></a>`warn`
192 214
193 Data type: `Variant[Boolean, String]` 215 Data type: `Variant[Boolean, String]`
194 216
195 Specifies whether to add a header message at the top of the destination file. Valid options: the booleans true and false, or a string 217 Specifies whether to add a header message at the top of the destination file. Valid options: the booleans true and false, or a string
196 to serve as the header. 218 to serve as the header.
199 Before 2.0.0, this parameter would add a newline at the end of the warn message. To improve flexibilty, this was removed. Please add 221 Before 2.0.0, this parameter would add a newline at the end of the warn message. To improve flexibilty, this was removed. Please add
200 it explicitly if you need it. 222 it explicitly if you need it.
201 223
202 Default value: `false` 224 Default value: `false`
203 225
204 ### concat::fragment 226 ##### <a name="-concat--create_empty_file"></a>`create_empty_file`
227
228 Data type: `Boolean`
229
230 Specifies whether to create an empty file if no fragments are defined. Defaults to true.
231
232 Default value: `true`
233
234 ### <a name="concat--fragment"></a>`concat::fragment`
205 235
206 Manages a fragment of text to be compiled into a file. 236 Manages a fragment of text to be compiled into a file.
207 237
208 #### Parameters 238 #### Parameters
209 239
210 The following parameters are available in the `concat::fragment` defined type. 240 The following parameters are available in the `concat::fragment` defined type:
211 241
212 ##### `content` 242 * [`content`](#-concat--fragment--content)
213 243 * [`order`](#-concat--fragment--order)
214 Data type: `Optional[String]` 244 * [`source`](#-concat--fragment--source)
245 * [`target`](#-concat--fragment--target)
246
247 ##### <a name="-concat--fragment--content"></a>`content`
248
249 Data type: `Optional[Variant[Sensitive[String], String, Deferred]]`
215 250
216 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter. 251 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter.
217 252 Allows a String or a Deferred function which returns a String.
218 Default value: `undef` 253
219 254 Default value: `undef`
220 ##### `order` 255
256 ##### <a name="-concat--fragment--order"></a>`order`
221 257
222 Data type: `Variant[String, Integer]` 258 Data type: `Variant[String, Integer]`
223 259
224 Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. The string 260 Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. The string
225 option is recommended. 261 option is recommended.
226 262
227 Default value: '10' 263 Default value: `'10'`
228 264
229 ##### `source` 265 ##### <a name="-concat--fragment--source"></a>`source`
230 266
231 Data type: `Optional[Variant[String, Array]]` 267 Data type: `Optional[Variant[String, Array]]`
232 268
233 Specifies a file to read into the content of the fragment. Note: You must supply either a content parameter or a source parameter. 269 Specifies a file to read into the content of the fragment. Note: You must supply either a content parameter or a source parameter.
234 Valid options: a string or an array, containing one or more Puppet URLs. 270 Valid options: a string or an array, containing one or more Puppet URLs.
235 271
236 Default value: `undef` 272 Default value: `undef`
237 273
238 ##### `target` 274 ##### <a name="-concat--fragment--target"></a>`target`
239 275
240 Data type: `String` 276 Data type: `String`
241 277
242 Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent concat resource. 278 Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent concat resource.
243 279
244 ## Resource types 280 ## Resource types
245 281
246 ### concat_file 282 ### <a name="concat_file"></a>`concat_file`
247 283
248 Generates a file with content from fragments sharing a common unique tag. 284 Generates a file with content from fragments sharing a common unique tag.
249 285
250 #### Examples 286 #### Examples
251 287
269 305
270 The following properties are available in the `concat_file` type. 306 The following properties are available in the `concat_file` type.
271 307
272 ##### `ensure` 308 ##### `ensure`
273 309
274 Valid values: present, absent 310 Valid values: `present`, `absent`
275 311
276 Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and 312 Specifies whether the destination file should exist. Setting to 'absent' tells Puppet to delete the destination file if it exists, and
277 negates the effect of any other parameters. 313 negates the effect of any other parameters.
278 314
279 Default value: present 315 Default value: `present`
280 316
281 #### Parameters 317 #### Parameters
282 318
283 The following parameters are available in the `concat_file` type. 319 The following parameters are available in the `concat_file` type.
284 320
285 ##### `tag` 321 * [`backup`](#-concat_file--backup)
286 322 * [`create_empty_file`](#-concat_file--create_empty_file)
287 Required. Specifies a unique tag reference to collect all concat_fragments with the same tag. 323 * [`ensure_newline`](#-concat_file--ensure_newline)
288 324 * [`force`](#-concat_file--force)
289 ##### `path` 325 * [`format`](#-concat_file--format)
290 326 * [`group`](#-concat_file--group)
291 Specifies a destination file for the combined fragments. Valid options: a string containing an absolute path. Default value: the 327 * [`mode`](#-concat_file--mode)
328 * [`order`](#-concat_file--order)
329 * [`owner`](#-concat_file--owner)
330 * [`path`](#-concat_file--path)
331 * [`replace`](#-concat_file--replace)
332 * [`selinux_ignore_defaults`](#-concat_file--selinux_ignore_defaults)
333 * [`selrange`](#-concat_file--selrange)
334 * [`selrole`](#-concat_file--selrole)
335 * [`seltype`](#-concat_file--seltype)
336 * [`seluser`](#-concat_file--seluser)
337 * [`show_diff`](#-concat_file--show_diff)
338 * [`tag`](#-concat_file--tag)
339 * [`validate_cmd`](#-concat_file--validate_cmd)
340
341 ##### <a name="-concat_file--backup"></a>`backup`
342
343 Specifies whether (and how) to back up the destination file before overwriting it. Your value gets passed on to Puppet's
344 native file
345 resource for execution. Valid options: true, false, or a string representing either a target filebucket or a filename
346 extension
347 beginning with ".".'
348
349 ##### <a name="-concat_file--create_empty_file"></a>`create_empty_file`
350
351 Valid values: `true`, `false`, `yes`, `no`
352
353 Specifies whether to create an empty file if no fragments are defined.
354
355 Default value: `true`
356
357 ##### <a name="-concat_file--ensure_newline"></a>`ensure_newline`
358
359 Valid values: `true`, `false`, `yes`, `no`
360
361 Specifies whether to add a line break at the end of each fragment that doesn't already end in one.
362
363 Default value: `false`
364
365 ##### <a name="-concat_file--force"></a>`force`
366
367 Valid values: `true`, `false`, `yes`, `no`
368
369 Specifies whether to merge data structures, keeping the values with higher order.
370
371 Default value: `false`
372
373 ##### <a name="-concat_file--format"></a>`format`
374
375 Valid values: `plain`, `yaml`, `json`, `json-array`, `json-pretty`, `json-array-pretty`
376
377 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty',
378 'json-array-pretty'.
379
380 Default value: `plain`
381
382 ##### <a name="-concat_file--group"></a>`group`
383
384 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer
385 containing a
386 gid.
387
388 ##### <a name="-concat_file--mode"></a>`mode`
389
390 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in
391 octal notation.
392
393 ##### <a name="-concat_file--order"></a>`order`
394
395 Valid values: `alpha`, `numeric`
396
397 Specifies a method for sorting your fragments by name within the destination file. You can override this setting for
398 individual
399 fragments by adjusting the order parameter in their concat::fragment declarations.
400
401 Default value: `numeric`
402
403 ##### <a name="-concat_file--owner"></a>`owner`
404
405 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid.
406
407 ##### <a name="-concat_file--path"></a>`path`
408
409 Specifies a destination file for the combined fragments. Valid options: a string containing an absolute path. Default
410 value: the
292 title of your declared resource. 411 title of your declared resource.
293 412
294 ##### `owner` 413 ##### <a name="-concat_file--replace"></a>`replace`
295 414
296 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid. 415 Valid values: `true`, `false`, `yes`, `no`
297
298 ##### `group`
299
300 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer containing a
301 gid.
302
303 ##### `mode`
304
305 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation.
306
307 ##### `order`
308
309 Valid values: alpha, numeric
310
311 Specifies a method for sorting your fragments by name within the destination file. You can override this setting for individual
312 fragments by adjusting the order parameter in their concat::fragment declarations.
313
314 Default value: numeric
315
316 ##### `backup`
317
318 Specifies whether (and how) to back up the destination file before overwriting it. Your value gets passed on to Puppet's native file
319 resource for execution. Valid options: true, false, or a string representing either a target filebucket or a filename extension
320 beginning with ".".'
321
322 ##### `replace`
323
324 Valid values: `true`, `false`, yes, no
325 416
326 Specifies whether to overwrite the destination file if it already exists. 417 Specifies whether to overwrite the destination file if it already exists.
327 418
328 Default value: `true` 419 Default value: `true`
329 420
330 ##### `validate_cmd` 421 ##### <a name="-concat_file--selinux_ignore_defaults"></a>`selinux_ignore_defaults`
331 422
332 Specifies a validation command to apply to the destination file. Requires Puppet version 3.5 or newer. Valid options: a string to 423 Valid values: `true`, `false`, `yes`, `no`
333 be passed to a file resource.
334
335 ##### `ensure_newline`
336
337 Valid values: `true`, `false`, yes, no
338
339 Specifies whether to add a line break at the end of each fragment that doesn't already end in one.
340
341 Default value: `false`
342
343 ##### `format`
344
345 Valid values: plain, yaml, json, json-array, json-pretty, json-array-pretty
346
347 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty', 'json-array-pretty'.
348
349 Default value: plain
350
351 ##### `force`
352
353 Valid values: `true`, `false`, yes, no
354
355 Specifies whether to merge data structures, keeping the values with higher order.
356
357 Default value: `false`
358
359 ##### `selinux_ignore_defaults`
360
361 Valid values: `true`, `false`, yes, no
362 424
363 See the file type's selinux_ignore_defaults documentention: 425 See the file type's selinux_ignore_defaults documentention:
364 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults. 426 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults.
365 427
366 ##### `selrange` 428 ##### <a name="-concat_file--selrange"></a>`selrange`
367 429
368 See the file type's selrange documentation: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange 430 See the file type's selrange documentation:
369 431 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange
370 ##### `selrole` 432
371 433 ##### <a name="-concat_file--selrole"></a>`selrole`
372 See the file type's selrole documentation: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole 434
373 435 See the file type's selrole documentation:
374 ##### `seltype` 436 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole
375 437
376 See the file type's seltype documentation: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype 438 ##### <a name="-concat_file--seltype"></a>`seltype`
377 439
378 ##### `seluser` 440 See the file type's seltype documentation:
379 441 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype
380 See the file type's seluser documentation: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser 442
381 443 ##### <a name="-concat_file--seluser"></a>`seluser`
382 ##### `show_diff` 444
383 445 See the file type's seluser documentation:
384 Valid values: `true`, `false`, yes, no 446 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser
385 447
386 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from insecure 448 ##### <a name="-concat_file--show_diff"></a>`show_diff`
449
450 Valid values: `true`, `false`, `yes`, `no`
451
452 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from
453 insecure
387 reporting methods. 454 reporting methods.
388 455
389 ### concat_fragment 456 ##### <a name="-concat_file--tag"></a>`tag`
457
458 Required. Specifies a unique tag reference to collect all concat_fragments with the same tag.
459
460 ##### <a name="-concat_file--validate_cmd"></a>`validate_cmd`
461
462 Specifies a validation command to apply to the destination file. Requires Puppet version 3.5 or newer. Valid options: a
463 string to
464 be passed to a file resource.
465
466 ### <a name="concat_fragment"></a>`concat_fragment`
390 467
391 Manages the fragment. 468 Manages the fragment.
392 469
393 #### Examples 470 #### Examples
394 471
395 ##### 472 #####
396 473
397 ```puppet 474 ```puppet
398 # The example is based on exported resources. 475 # The example is based on exported resources.
399 476
400 concat_fragment { \"uniqe_name_${::fqdn}\": 477 concat_fragment { "uniqe_name_${::fqdn}":
401 tag => 'unique_name', 478 tag => 'unique_name',
402 order => 10, # Optional. Default to 10 479 order => 10, # Optional. Default to 10
403 content => 'some content' # OR 480 content => 'some content' # OR
404 # content => template('template.erb') 481 # content => template('template.erb')
405 source => 'puppet:///path/to/file' 482 source => 'puppet:///path/to/file'
408 485
409 #### Parameters 486 #### Parameters
410 487
411 The following parameters are available in the `concat_fragment` type. 488 The following parameters are available in the `concat_fragment` type.
412 489
413 ##### `name` 490 * [`content`](#-concat_fragment--content)
491 * [`name`](#-concat_fragment--name)
492 * [`order`](#-concat_fragment--order)
493 * [`source`](#-concat_fragment--source)
494 * [`tag`](#-concat_fragment--tag)
495 * [`target`](#-concat_fragment--target)
496
497 ##### <a name="-concat_fragment--content"></a>`content`
498
499 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter. Valid
500 options: a string
501
502 ##### <a name="-concat_fragment--name"></a>`name`
414 503
415 namevar 504 namevar
416 505
417 Name of resource. 506 Name of resource.
418 507
419 ##### `target` 508 ##### <a name="-concat_fragment--order"></a>`order`
420 509
421 Required. Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent 510 Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. The
511 string
512 option is recommended.
513
514 Default value: `10`
515
516 ##### <a name="-concat_fragment--source"></a>`source`
517
518 Specifies a file to read into the content of the fragment. Note: You must supply either a content parameter or a source
519 parameter.
520 Valid options: a string or an array, containing one or more Puppet URLs.
521
522 ##### <a name="-concat_fragment--tag"></a>`tag`
523
524 Specifies a unique tag to be used by concat_file to reference and collect content.
525
526 ##### <a name="-concat_fragment--target"></a>`target`
527
528 Required. Specifies the destination file of the fragment. Valid options: a string containing the path or title of the
529 parent
422 concat_file resource. 530 concat_file resource.
423 531
424 ##### `content`
425
426 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter. Valid options: a string
427
428 ##### `source`
429
430 Specifies a file to read into the content of the fragment. Note: You must supply either a content parameter or a source parameter.
431 Valid options: a string or an array, containing one or more Puppet URLs.
432
433 ##### `order`
434
435 Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. The string
436 option is recommended.
437
438 Default value: 10
439
440 ##### `tag`
441
442 Specifies a unique tag to be used by concat_file to reference and collect content.
443