Forked from puppet-hash2stuff by Mark McKinstry, which is no longer maintained.
This module will convert puppet hashes to different common file formats. It is used to overwrite an entire file with one from puppet, if you are trying to manage bits and pieces of a config file, you want to use something like puppetlabs/inifile or augeas.
Supported file formats are ini, json, kv (key/value), properties (java style), and yaml.
The module includes a defined type for each file format and the main module class has a matching parameter to support creating any of the supported file types from hiera. The module does nothing when assigned unless hiera data is present.
Converts a hash into an INI file format. Type: rvalue.
It is used when you want to overwrite an entire file with a hash of settings. If you want to manage bits and pieces of an INI file, you want puppetlabs/inifile.
Note that version 1.4.0 and later of the module supports arrays as key values. This results in an INI file where multiple lines in the same section will have the same key, but may have different values. See the example below.
It accepts the following optional parameters passed to it in a hash as the second argument:
header: String you want at the top of the file saying it is controlled by puppet. Default: '# THIS FILE IS CONTROLLED BY PUPPET'section_prefix: String that will appear before the section's name. Default: '['section_suffix: String that will appear after the section's name. Default: ']'key_val_separator: String to use between setting name and value (e.g., to determine whether the separator includes whitespace). Default: '='.quote_char: Character or string to quote the entire value of the setting. Default: '"'
For example:
$config = {
'main' => {
'logging' => 'INFO',
'limit' => 314,
'awesome' => true,
'dup_key' => ['value1', 'value2'],
},
'dev' => {
'logging' => 'DEBUG',
'log_location' => '/var/log/dev.log',
}
}
file {'/etc/config.ini':
ensure => 'present',
content => hash2ini($config)
}will produce a file at /etc/config.ini that looks like:
# THIS FILE IS CONTROLLED BY PUPPET
[main]
logging="INFO"
limit="314"
awesome="true"
dup_key="value1"
dup_key="value2"
[dev]
logging="DEBUG"
log_location="/var/log/dev.log"Or you can specify custom settings:
$settings = {
'header' => '; THIS FILE IS CONTROLLED BY PUPPET',
'key_val_separator' => ' = ',
'quote_char' => '',
}
$php_config = {
'PHP' => {
'engine' => 'On',
'realpath_cache_size' => '32k',
'zlib.output_compression' => 'On',
'expose_php' => 'Off',
},
'Date' => {
'date.timezone' => '"America/Detroit"',
}
}
file {'/etc/php.ini':
ensure => 'present',
content => hash2ini($php_config, $settings)
}will produce a file at /etc/php.ini that looks like:
; THIS FILE IS CONTROLLED BY PUPPET
[PHP]
engine = On
realpath_cache_size = 32k
zlib.output_compression = On
expose_php = Off
[Date]
date.timezone = "America/Detroit"This FUNCTION HAS BEEN REMOVED FROM THE MODULE in favor of to_json_pretty from puppetlab's stdlib.
This example uses 'to_json_pretty' to convert a hash into a formatted JSON string. Type: rvalue.
It is used when you want to overwrite an entire file with a hash of settings. If you want to manage bits and pieces of an JSON file, you want augeas with the JSON lens.
For example:
$config = {
'domain' => 'example.com',
'mysql' => {
'hosts' => ['192.0.2.2', '192.0.2.4'],
'user' => 'root',
'pass' => 'setec-astronomy',
},
'awesome' => true,
}
file {'/etc/config.json':
ensure => 'present',
content => to_json_pretty($config)
}will produce a file at /etc/config.json that looks like:
{
"domain": "example.com",
"mysql": {
"hosts": [
"192.0.2.2",
"192.0.2.4"
],
"user": "root",
"pass": "setec-astronomy"
},
"awesome": true
}Converts a hash into an key-value/shellvar string. Type: rvalue.
It is used when you want to overwrite an entire file with a hash of settings. If you want to manage bits and pieces of an key-value/shellvar style file, you probably want herculesteam/augeasproviders_shellvar.
It accepts the following optional parameters passed to it in a hash as the second argument:
header: String you want at the top of the file saying it is controlled by puppet. Default: '# THIS FILE IS CONTROLLED BY PUPPET'.key_val_separator: String to use between setting name and value (e.g., to determine whether the separator includes whitespace). Default: '='.quote_char: Character or string to quote the entire value of the setting. Default: '"'.quote_booleans: A boolean controlling whether or not to quote boolean values. Default: 'true'.quote_numerics: A boolean controlling whether or not to quote numeric values. Default: 'true'.
For example:
$config = {
'HOSTNAME' => 'foo.example.com',
'RSYNC_IONICE' => '3',
'PORTS' => '53 123 80',
}
file {'/etc/config.sh':
ensure => 'present',
content => hash2kv($config)
}will produce a file at /etc/config.sh that looks like:
# THIS FILE IS CONTROLLED BY PUPPET
HOSTNAME="foo.example.com"
RSYNC_IONICE="3"
PORTS="53 123 80"Or you can specify custom settings:
$settings = {
'header' => '; THIS FILE IS CONTROLLED BY PUPPET',
'key_val_separator' => ': ',
'quote_char' => '',
}
$config = {
'HOSTNAME' => 'foo.example.com',
'RSYNC_IONICE' => '3',
'PORTS' => '53 123 80',
}
file {'/etc/config.kv':
ensure => 'present',
content => hash2kv($php_config, $settings)
}will produce a file at /etc/config.kv that looks like:
; THIS FILE IS CONTROLLED BY /dev/random
HOSTNAME: foo.example.com
RSYNC_IONICE: 3
PORTS: 53 123 80
Converts a hash into a Java properties file. Type: rvalue.
It accepts the following optional parameters passed to it in a hash as the second argument:
header: String you want at the top of the file saying it is controlled by puppet. Default: '# THIS FILE IS CONTROLLED BY PUPPET'.key_val_separator: String to use between setting name and value (e.g., to determine whether the separator includes whitespace). Default: '='.quote_char: Character or string to quote the entire value of the setting. Default: '"'.list_separator: Character to separate lists
For example:
$config = {
'main' => {
'logging' => 'INFO',
'limit' => 314,
'awesome' => true,
'nested' => {
'sublevel1' => 'value1',
'subnested1' => {
'node1' => 'leaf1',
'node2' => 'leaf2',
},
'list' => [
'item1',
'item2',
]
}
},
'dev' => {
'logging' => 'DEBUG',
'log_location' => '/var/log/dev.log',
}
}
file {'/etc/config.properties':
ensure => 'present',
content => hash2properties($config)
}will produce a file at /etc/config.properties that looks like:
# THIS FILE IS CONTROLLED BY PUPPET
dev.log_location=/var/log/dev.log
dev.logging=DEBUG
main.awesome=true
main.limit=314
main.logging=INFO
main.nested.list=item1,item2
main.nested.sublevel1=value1
main.nested.subnested1.node1=leaf1
main.nested.subnested1.node2=leaf2Or you can specify custom settings:
settings = {
'header' => '# THIS FILE IS CONTROLLED BY /dev/random',
'key_val_separator' => ': ',
'quote_char' => '"',
}
$config = {
'main' => {
'logging' => 'INFO',
'limit' => 314,
'awesome' => true,
'nested' => {
'sublevel1' => 'value1',
'subnested1' => {
'node1' => 'leaf1',
'node2' => 'leaf2',
},
'list' => [
'item1',
'item2',
]
}
},
'dev' => {
'logging' => 'DEBUG',
'log_location' => '/var/log/dev.log',
}
}
file {'/etc/config.properties':
ensure => 'present',
content => hash2properites($config, $settings)
}will produce a file at /etc/config.properties that looks like:
# THIS FILE IS CONTROLLED BY /dev/random
dev.log_location: "/var/log/dev.log"
dev.logging: "DEBUG"
main.awesome: "true"
main.limit: "314"
main.logging: "INFO"
main.nested.list: "item1,item2"
main.nested.sublevel1: "value1"
main.nested.subnested1.node1: "leaf1"
main.nested.subnested1.node2: "leaf2"
This function overlaps with to_yaml from puppetlab's stdlib. This function does provide a header option to give a string saying the file is controlled by puppet.
Converts a hash into a YAML string. Type: rvalue.
It is used when you want to overwrite an entire file with a hash of settings. If you want to manage bits and pieces of an YAML file, you want augeas with the YAML lens.
It accepts the following optional parameters passed to it in a hash as the second argument:
header: String you want at the top of the file saying it is controlled by puppet. Default: '""'.
For example:
$config = {
'domain' => 'example.com',
'mysql' => {
'hosts' => ['192.0.2.2', '192.0.2.4'],
'user' => 'root',
'pass' => 'setec-astronomy',
},
'awesome' => true,
}
file {'/etc/config.yaml':
ensure => 'present',
content => hash2yaml($config)
}will produce a file at /etc/config.yaml that looks like:
---
domain: example.com
mysql:
hosts:
- 192.0.2.2
- 192.0.2.4
user: root
pass: setec-astronomy
awesome: trueOr you can specify custom settings:
$settings = {
'header' => '# THIS FILE IS CONTROLLED BY PUPPET',
}
$config = {
'domain' => 'example.com',
'mysql' => {
'hosts' => ['192.0.2.2', '192.0.2.4'],
'user' => 'root',
'pass' => 'setec-astronomy',
},
'awesome' => true,
}
file {'/etc/config.yaml':
ensure => 'present',
content => hash2yaml($config, $settings)
}That will produce a file at /etc/config.yaml that looks like:
# THIS FILE IS CONTROLLED BY PUPPET
---
domain: example.com
mysql:
hosts:
- 192.0.2.2
- 192.0.2.4
user: root
pass: setec-astronomy
awesome: true