2 <!-- DO NOT EDIT: This document was generated by Puppet Strings -->
8 * [`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.
13 * [`concat_file`](#concat_file): Generates a file with content from fragments sharing a common unique tag.
14 * [`concat_fragment`](#concat_fragment): Manages the fragment.
20 Manages a file, compiled from one or more text fragments.
27 concat { '/tmp/concat':
37 The following parameters are available in the `concat` defined type.
41 Data type: `Variant[Boolean, String]`
43 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
47 Default value: 'puppet'
51 Data type: `Enum['present', 'absent']`
53 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.
56 Default value: 'present'
58 ##### `ensure_newline`
62 Specifies whether to add a line break at the end of each fragment that doesn't already end in one.
64 Default value: `false`
68 Data type: `Optional[String]`
70 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty',
73 Default value: 'plain'
77 Data type: `Optional[Boolean]`
79 Specifies whether to merge data structures, keeping the values with higher order. Used when format is specified as a value other than
82 Default value: `false`
86 Data type: `Optional[Variant[String, Integer]]`
88 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer containing a gid.
90 Default value: `undef`
96 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation.
102 Data type: `Enum['alpha','numeric']`
104 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.
107 Default value: 'alpha'
111 Data type: `Optional[Variant[String, Integer]]`
113 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid.
115 Default value: `undef`
119 Data type: `Stdlib::Absolutepath`
121 Specifies a destination file for the combined fragments.
129 Specifies whether to overwrite the destination file if it already exists.
131 Default value: `true`
133 ##### `selinux_ignore_defaults`
135 Data type: `Optional[Boolean]`
137 See the file type's selinux_ignore_defaults documentention:
138 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults
140 Default value: `undef`
144 Data type: `Optional[String]`
146 See the file type's selrange documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange
148 Default value: `undef`
152 Data type: `Optional[String]`
154 See the file type's selrole documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole
156 Default value: `undef`
160 Data type: `Optional[String]`
162 See the file type's seltype documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype
164 Default value: `undef`
168 Data type: `Optional[String]`
170 See the file type's seluser documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser
172 Default value: `undef`
178 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from insecure
181 Default value: `true`
185 Data type: `Optional[String]`
187 Specifies a validation command to apply to the destination file.
189 Default value: `undef`
193 Data type: `Variant[Boolean, String]`
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
196 to serve as the header.
197 If you set 'warn' to true, concat adds the following line with an order of 0:
198 `# This file is managed by Puppet. DO NOT EDIT.`
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
200 it explicitly if you need it.
202 Default value: `false`
206 Manages a fragment of text to be compiled into a file.
210 The following parameters are available in the `concat::fragment` defined type.
214 Data type: `Optional[String]`
216 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter.
218 Default value: `undef`
222 Data type: `Variant[String, Integer]`
224 Reorders your fragments within the destination file. Fragments that share the same order number are ordered by name. The string
225 option is recommended.
231 Data type: `Optional[Variant[String, Array]]`
233 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.
236 Default value: `undef`
242 Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent concat resource.
248 Generates a file with content from fragments sharing a common unique tag.
255 Concat_fragment <<| tag == 'unique_tag' |>>
257 concat_file { '/tmp/file':
258 tag => 'unique_tag', # Optional. Default to undef
259 path => '/tmp/file', # Optional. If given it overrides the resource name
260 owner => 'root', # Optional. Default to undef
261 group => 'root', # Optional. Default to undef
262 mode => '0644' # Optional. Default to undef
263 order => 'numeric' # Optional, Default to 'numeric'
264 ensure_newline => false # Optional, Defaults to false
270 The following properties are available in the `concat_file` type.
274 Valid values: present, absent
276 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.
279 Default value: present
283 The following parameters are available in the `concat_file` type.
287 Required. Specifies a unique tag reference to collect all concat_fragments with the same tag.
291 Specifies a destination file for the combined fragments. Valid options: a string containing an absolute path. Default value: the
292 title of your declared resource.
296 Specifies the owner of the destination file. Valid options: a string containing a username or integer containing a uid.
300 Specifies a permissions group for the destination file. Valid options: a string containing a group name or integer containing a
305 Specifies the permissions mode of the destination file. Valid options: a string containing a permission mode value in octal notation.
309 Valid values: alpha, numeric
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.
314 Default value: numeric
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
324 Valid values: `true`, `false`, yes, no
326 Specifies whether to overwrite the destination file if it already exists.
328 Default value: `true`
332 Specifies a validation command to apply to the destination file. Requires Puppet version 3.5 or newer. Valid options: a string to
333 be passed to a file resource.
335 ##### `ensure_newline`
337 Valid values: `true`, `false`, yes, no
339 Specifies whether to add a line break at the end of each fragment that doesn't already end in one.
341 Default value: `false`
345 Valid values: plain, yaml, json, json-array, json-pretty, json-array-pretty
347 Specify what data type to merge the fragments as. Valid options: 'plain', 'yaml', 'json', 'json-array', 'json-pretty', 'json-array-pretty'.
353 Valid values: `true`, `false`, yes, no
355 Specifies whether to merge data structures, keeping the values with higher order.
357 Default value: `false`
359 ##### `selinux_ignore_defaults`
361 Valid values: `true`, `false`, yes, no
363 See the file type's selinux_ignore_defaults documentention:
364 https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selinux_ignore_defaults.
368 See the file type's selrange documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrange
372 See the file type's selrole documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-selrole
376 See the file type's seltype documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seltype
380 See the file type's seluser documentention: https://docs.puppetlabs.com/references/latest/type.html#file-attribute-seluser
384 Valid values: `true`, `false`, yes, no
386 Specifies whether to set the show_diff parameter for the file resource. Useful for hiding secrets stored in hiera from insecure
391 Manages the fragment.
398 # The example is based on exported resources.
400 concat_fragment { \"uniqe_name_${::fqdn}\":
401 tag => 'unique_name',
402 order => 10, # Optional. Default to 10
403 content => 'some content' # OR
404 # content => template('template.erb')
405 source => 'puppet:///path/to/file'
411 The following parameters are available in the `concat_fragment` type.
421 Required. Specifies the destination file of the fragment. Valid options: a string containing the path or title of the parent
422 concat_file resource.
426 Supplies the content of the fragment. Note: You must supply either a content parameter or a source parameter. Valid options: a string
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.
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.
442 Specifies a unique tag to be used by concat_file to reference and collect content.