Version information
Start using this module
Add this module to your Puppetfile:
mod 'belskiiartem-logcourier', '0.1.3'
Learn more about managing modules with a PuppetfileDocumentation
logcourier
Table of Contents
- Description
- Setup - The basics of getting started with logcourier
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
Start with a one- or two-sentence summary of what the module does and/or what problem it solves. This is your 30-second elevator pitch for your module. Consider including OS/Puppet version it works with.
You can give more descriptive information in a second paragraph. This paragraph should answer the questions: "What does this module do?" and "Why would I use it?" If your module has a range of functionality (installation, configuration, management, etc.), this is the time to mention it.
Setup
What logcourier affects OPTIONAL
TBD
Setup Requirements OPTIONAL
TBD
Beginning with logcourier
TBD
Usage
logcourier::servers:
- some.one.com:5001
- some.another.com:5002
logcourier::ssl_ca: '/etc/ssl/certs/some.one.com.crt' logcourier::files: nginx_access: paths:
- "/var/log/nginx/access.log"
fields:
type: nginx-access
application: webApp
Reference
TBD
Limitations
This is where you list OS compatibility, version compatibility, etc. If there are Known Issues, you might want to include them under their own heading here.
Development
Don't be shy, and ping me about any question in https://github.com/belskiiartem/logcourier
Release Notes/Contributors/Etc. Optional
If you aren't using changelog, put your release notes here (though you should
consider using changelog). You can also add any additional sections you feel
are necessary or important to include here. Please use the ##
header.
Dependencies
- puppetlabs-stdlib (>= 1.0.0)