Skip to content

Commit

Permalink
README: puppet refuses to parse class attributes as strings
Browse files Browse the repository at this point in the history
Fixes this kind of error:
```
Syntax error at 'global_config' (file: /etc/puppetlabs/code/environments/rsyslog/site/profile/manifests/rsyslog.pp, line: 5, column: 5)

     1  # Class: profile::rsyslog
     2  # By default provides client configuration, can optionally provide server configuration
     3  class profile::rsyslog {
     4    class { 'rsyslog::config':
     5      'global_config' => {}
     [...]
```
Also in this commit a minor typofix in REFERENCE.
  • Loading branch information
Mike Massonnet committed Aug 30, 2024
1 parent 989b28c commit e7b2bfc
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ The hash accepts the following three values:
Puppet example:
```puppet
class { 'rsyslog::config':
'modules' => {
modules => {
'imuxsock' => {},
'imudp' => {
'config' => {
Expand Down Expand Up @@ -235,7 +235,7 @@ A hash of hashes, they key represents the configuration setting and the value is
Puppet example:
```puppet
class { 'rsyslog::config':
'global_config' => {
global_config => {
'umask' => {
'value' => '0000',
'type' => 'legacy',
Expand Down Expand Up @@ -311,7 +311,7 @@ Configures the `main_queue` object in rsyslog as a hash. eg:
Puppet Example:
```puppet
class { 'rsyslog::config':
'main_queue_opts' => {
main_queue_opts => {
'queue.maxdiskspace' => '1000G',
'queue.dequeuebatchsize' => 1000,
}
Expand Down Expand Up @@ -342,7 +342,7 @@ Puppet Example:

```puppet
class { 'rsyslog::config':
'templates' => {
templates => {
'remote' => {
'type' => 'string',
'string' => '/var/log/rsyslog/logs/%fromhost-ip%.log',
Expand Down Expand Up @@ -388,7 +388,7 @@ Puppet example:

```puppet
class { 'rsyslog::config':
'templates' => {
templates => {
'plain-syslog' => {
'type' => 'list',
'list_descriptions' => [
Expand Down Expand Up @@ -543,7 +543,7 @@ Puppet example:

```puppet
class { 'rsyslog::config':
'actions' => {
actions => {
'all_logs' => {
'type' => 'omfile',
'facility' => '*.*;auth,authpriv.none',
Expand Down Expand Up @@ -626,7 +626,7 @@ Puppet examples:

```puppet
class { 'rsyslog:config':
'inputs' => {
inputs => {
'imudp' => {
'type' => 'imudp',
'config' => {
Expand Down Expand Up @@ -674,7 +674,7 @@ Puppet example:

```puppet
class { 'rsyslog::config':
'lookup_tables' => {
lookup_tables => {
'ip_lookup' => {
'lookup_json' => {
'version' => 1,
Expand Down Expand Up @@ -754,7 +754,7 @@ Puppet Example:

```puppet
class { 'rsyslog::config':
'parser' => {
parser => {
'pmrfc3164_hostname_with_slashes' => {
'type' => 'pmrfc3164',
'config' => {
Expand Down Expand Up @@ -808,7 +808,7 @@ Puppet example:

```puppet
class { 'rsyslog::config':
'rulesets' => {
rulesets => {
'ruleset_eth0_514_tcp' => {
'parameters' => {
'parser' => 'pmrfc3164.hostname_with_slashes',
Expand Down Expand Up @@ -962,7 +962,7 @@ Puppet Example:

```puppet
class { 'rsyslog::config':
'rulesets' => {
rulesets => {
'ruleset_eth0_514_udp' => {
'parameters' => {
'queue.type' => 'LinkedList'
Expand Down Expand Up @@ -1029,7 +1029,7 @@ Puppet example with lookup tables:
*NOTE: Good example for how to define multiple rsyslog resources in a single `rsyslog::config` class*
```puppet
class { 'rsyslog::config':
'lookup_tables' => {
lookup_tables => {
'srv-map' => {
'lookup_json' => {
'version' => 1,
Expand All @@ -1054,7 +1054,7 @@ class { 'rsyslog::config':
'reload_on_hup' => true
}
},
'rulesets' => {
rulesets => {
'ruleset_lookup_set_windows_by_ip' => {
'rules' => [
{
Expand Down Expand Up @@ -1188,7 +1188,7 @@ ruleset(name="ruleset_lookup_set_windows_by_ip"
Puppet Example:
```puppet
class { 'rsyslog::config':
'rulesets' => {
rulesets => {
'ruleset_msg_check_for_error' => {
'rules' => [
{
Expand Down Expand Up @@ -1265,7 +1265,7 @@ Puppet Example:

```puppet
class { 'rsyslog::config':
'property_filters' => {
property_filters => {
'hostname_filter' => {
'property' => 'hostname',
'operator' => 'contains',
Expand Down Expand Up @@ -1357,7 +1357,7 @@ The `rsyslog::config::expression_filters` parameter is a Hash of hashes where th
Old Syntax (still works):
```puppet
class { 'rsyslog::config':
'expression_filters' => {
expression_filters => {
'hostname_filter' => {
'conditionals' => {
'if' => {
Expand All @@ -1381,7 +1381,7 @@ class { 'rsyslog::config':
New Syntax:
```puppet
class { 'rsyslog::config':
'expression_filters' => {
expression_filters => {
'hostname_filter' => {
'conditionals' => {
'main' => {
Expand Down Expand Up @@ -1451,7 +1451,7 @@ NOTE: Due to the amount of potential options available to the user, the `express
Old Syntax (still works):
```puppet
class { 'rsyslog::config':
'expression_filters' => {
expression_filters => {
'complex_filter' => {
'conditionals' => {
'if' => {
Expand Down Expand Up @@ -1479,7 +1479,7 @@ class { 'rsyslog::config':
New Syntax:
```puppet
class { 'rsyslog::config':
'expression_filters' => {
expression_filters => {
'complex_filter' => {
'conditionals' => {
'main' => {
Expand Down Expand Up @@ -1563,7 +1563,7 @@ Example using more than two conditions:
#### Puppet Examples
```puppet
class { 'rsyslog::config':
'expression_filters' => {
expression_filters => {
'conditionals' => {
'main' => {
'expression' => '$syslogfacility-text == "local0" and $msg startswith "DEVNAME" and ($msg contains "error1" or $msg contains "error0")',
Expand Down Expand Up @@ -1652,7 +1652,7 @@ A hash of hashes, each hash name is used as the comment/reference for the settin
##### Puppet Examples
```puppet
class { 'rsyslog::config':
'legacy_config' => {
legacy_config => {
'auth_priv_rule' => {
'key' => 'auth,authpriv.*',
'value' => '/var/log/auth.log',
Expand Down
2 changes: 1 addition & 1 deletion REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ Default value: `{}`
Data type: `Hash`

Hash of rsyslog configuration in the legacy format.
* :name (String) [undef] Na,e of the legacy configuration option.
* :name (String) [undef] Name of the legacy configuration option.
* :priority (Integer) [10] Sets where in the config the option will be placed in the target file.
* :target (String) [50_rsyslog.conf] File to place the conf
* :value (String) [] Value of the configuration item
Expand Down

0 comments on commit e7b2bfc

Please sign in to comment.