Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-augeasproviders_syslog
Augeas-based syslog type and providers for Puppet
https://github.com/voxpupuli/puppet-augeasproviders_syslog
augeas augeasproviders centos-puppet-module configuration configuration-files configuration-management debian-puppet-module hacktoberfest linux-puppet-module oraclelinux-puppet-module puppet puppet-module puppet-resources redhat-puppet-module rsyslog syslog ubuntu-puppet-module
Last synced: 3 months ago
JSON representation
Augeas-based syslog type and providers for Puppet
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-augeasproviders_syslog
- Owner: voxpupuli
- License: apache-2.0
- Created: 2014-08-05T10:13:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T07:54:05.000Z (5 months ago)
- Last Synced: 2024-10-29T14:22:33.048Z (3 months ago)
- Topics: augeas, augeasproviders, centos-puppet-module, configuration, configuration-files, configuration-management, debian-puppet-module, hacktoberfest, linux-puppet-module, oraclelinux-puppet-module, puppet, puppet-module, puppet-resources, redhat-puppet-module, rsyslog, syslog, ubuntu-puppet-module
- Language: Ruby
- Size: 746 KB
- Stars: 3
- Watchers: 44
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# syslog: types/providers for syslog files for Puppet
[](https://github.com/voxpupuli/puppet-augeasproviders_syslog/blob/master/LICENSE)
[](https://forge.puppetlabs.com/puppet/augeasproviders_syslog)
[](https://forge.puppetlabs.com/puppet/augeasproviders_syslog)
[](https://github.com/voxpupuli/puppet-augeasproviders_syslog/actions?query=workflow%3ACI)
[](#transfer-notice)
# Features
This module provides new types/providers for Puppet to read and modify syslog
config files using the Augeas configuration library.
The advantage of using Augeas over the default Puppet `parsedfile`
implementations is that Augeas will go to great lengths to preserve file
formatting and comments, while also failing safely when needed.
This provider will hide *all* of the Augeas commands etc., you don't need to
know anything about Augeas to make use of it.
## Requirements
Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as
normal.
See [Puppet/Augeas pre-requisites](http://docs.puppetlabs.com/guides/augeas.html#pre-requisites).
## Installing
On Puppet 2.7.14+, the module can be installed easily ([documentation](http://docs.puppetlabs.com/puppet/latest/reference/modules_installing.html)):
puppet module install herculesteam/augeasproviders_syslog
You may see an error similar to this on Puppet 2.x ([#13858](http://projects.puppetlabs.com/issues/13858)):
Error 400 on SERVER: Puppet::Parser::AST::Resource failed with error ArgumentError: Invalid resource type `syslog` at ...
Ensure the module is present in your puppetmaster's own environment (it doesn't
have to use it) and that the master has pluginsync enabled. Run the agent on
the puppetmaster to cause the custom types to be synced to its local libdir
(`puppet master --configprint libdir`) and then restart the puppetmaster so it
loads them.
## Compatibility
### Puppet versions
Minimum of Puppet 2.7.
### Augeas versions
Augeas Versions | 0.10.0 | 1.0.0 | 1.1.0 | 1.2.0 |
:-------------------------|:-------:|:-------:|:-------:|:-------:|
**PROVIDERS** |
syslog (augeas) | **yes** | **yes** | **yes** | **yes** |
syslog (rsyslog) | no | **yes** | **yes** | **yes** |
rsyslog\_filter (augeas) | no | **yes** | **yes** | **yes** |
## Documentation and examples
Type documentation can be generated with `puppet doc -r type` or viewed on the
[Puppet Forge page](http://forge.puppetlabs.com/voxpupuli/augeasproviders_syslog).
A `syslog` provider handles basic syslog configs, while an `rsyslog` provider
handles the extended rsyslog config (this requires Augeas 1.0.0).
### manage entry
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "file",
action => "/var/log/test.log",
}
### manage entry with no file sync
syslog { "cron.*":
ensure => present,
facility => "cron",
level => "*",
action_type => "file",
action => "/var/log/cron",
no_sync => true,
}
### manage remote hostname entry
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "hostname",
action => "centralserver",
}
### manage remote hostname entry with port and protocol
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "hostname",
action_port => "514",
action_protocol => "tcp",
action => "centralserver",
}
### manage user destination entry
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "user",
action => "root",
}
### manage program entry
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "program",
action => "/usr/bin/foo",
}
### delete entry
syslog { "mail.*":
ensure => absent,
facility => "mail",
level => "*",
action_type => "file",
action => "/var/log/maillog",
}
### manage entry in rsyslog
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "file",
action => "/var/log/test.log",
provider => "rsyslog",
}
### manage entry in another syslog location
syslog { "my test":
ensure => present,
facility => "local2",
level => "*",
action_type => "file",
action => "/var/log/test.log",
target => "/etc/mysyslog.conf",
}
## Issues
Please file any issues or suggestions [on GitHub](https://github.com/voxpupuli/augeasproviders_syslog/issues).
## Supported OS
See [metadata.json](metadata.json) for supported OS versions.
## Dependencies
See [metadata.json](metadata.json) for dependencies.
## Puppet
The supported Puppet versions are listed in the [metadata.json](metadata.json)
## REFERENCES
Please see [REFERENCE.md](https://github.com/voxpupuli/puppet-augeasproviders_syslog/blob/master/REFERENCE.md) for more details.
## Contributing
Please report bugs and feature request using [GitHub issue
tracker](https://github.com/voxpupuli/puppet-augeasproviders_syslog/issues).
For pull requests, it is very much appreciated to check your Puppet manifest
with [puppet-lint](https://github.com/puppetlabs/puppet-lint/) to follow the recommended Puppet style guidelines from the
[Puppet Labs style guide](https://www.puppet.com/docs/puppet/latest/style_guide.html).
## Transfer Notice
This plugin was originally authored by [Hercules Team](https://github.com/hercules-team).
The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance.
Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Hercules Team.