saltstack-logstash-formula

SaltStack formula to set up and configure Logstash, a tool for receiving, processing and outputting data

• Instructions
• Contributing
• TODO
• Authors
• Miscellaneous

Instructions

Please refer to https://github.com/bechtoldt/formula-docs to learn how to use this formula, how it is built and how you can add your changes.

NOTICE: This formula might uses the formhelper module which is a very useful Salt execution module that isn't available in upstream yet. Please consider retrieving it manually from https://github.com/bechtoldt/salt-modules and make it available to your Salt installation. Read SaltStack documentation to see how this can be achieved.

Take a look at older releases (branches) to get a version that isn't using the formhelper yet (if any).

NOTICE: Plugin management doesn't work when using Logtash with upstream's Debian package. They set a custom version in lib/logstash/version.rb that makes the plugin tool unable to download the contrib plugin. Custom plugin management is not supported yet.

Contributing

Contributions are welcome! All development guidelines we ask you to follow can be found at https://github.com/bechtoldt/formula-docs.

In general:

1. Fork this repo on Github
2. Add changes, test them, update docs (README.rst) if possible
3. Submit your pull request (PR) on Github, wait for feedback

But it’s better to file an issue with your idea first.

TODO

• add instructions how to use formhelper, add information about it in the formula-docs (dependency), show up alternative?
• table/ matrix: os/salt compatibility (dedicated file)
• add list of available states
• add tests
• support tarball-based deployment (that won't install distro's java)
• create a serializer that supports deserializing yaml/json: logstash config
• extend logstash access permissions so the logstash is able to read root/adm-chgrp'ed files like /var/log/syslog
• logstash 1.5 needs another plugin management concept

Authors

• Arnold Bechtoldt <mail@arnoldbechtoldt.com>

Miscellaneous

Recommended formulas:

• Elasticsearch management: saltstack-elasticsearch-formula
• Kibana user interface management: saltstack-kibana-formula
• Java deployment: saltstack-java-formula
• sysctl configuration: saltstack-sysctl-formula
• repo management: saltstack-repos-formula

Further reading:

• Documentation and Standardisation of SaltStack formulas: https://github.com/bechtoldt/formula-docs