syslog-ng-formula

Saltstack Official Syslog-NG Formula

semantic-release-bot c73ed1a962 chore(release): 0.5.1 [skip ci] ## [0.5.1](https://github.com/saltstack-formulas/syslog-ng-formula/compare/v0.5.0...v0.5.1) (2020-09-09) ### Bug Fixes * libtofs: “files_switch” mess up the variable exported by “map.jinja” [skip ci] ([`e9c5153`](`e9c515371b`)) * release.config.js: use full commit hash in commit link [skip ci] ([`4d6851d`](`4d6851dd78`)) * state: restart service when configuration has changed ([`a8100d0`](`a8100d0f32`)) ### Continuous Integration * gemfile: restrict `train` gem version until upstream fix [skip ci] ([`b44bfb5`](`b44bfb5872`)) * gemfile.lock: add to repo with updated `Gemfile` [skip ci] ([`4af7a0f`](`4af7a0fdd6`)) * kitchen: avoid using bootstrap for `master` instances [skip ci] ([`b44b24e`](`b44b24ed5c`)) * kitchen: install required packages to bootstrapped `opensuse` [skip ci] ([`8fe499e`](`8fe499e722`)) * kitchen: use `debian-10-master-py3` instead of `develop` [skip ci] ([`3ce84e4`](`3ce84e4cf0`)) * kitchen: use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([`68366d7`](`68366d7052`)) * kitchen: use `saltimages` Docker Hub where available [skip ci] ([`1762054`](`17620541ca`)) * kitchen: use bootstrapped `opensuse` images until `2019.2.2` [skip ci] ([`9b435f2`](`9b435f2b60`)) * kitchen+travis: remove `master-py2-arch-base-latest` [skip ci] ([`766962a`](`766962a6b0`)) * kitchen+travis: upgrade matrix after `2019.2.2` release [skip ci] ([`b5ebab0`](`b5ebab0447`)) * travis: add notifications => zulip [skip ci] ([`7cffd70`](`7cffd70d48`)) * travis: apply changes from build config validation [skip ci] ([`c3685b3`](`c3685b356d`)) * travis: opt-in to `dpl v2` to complete build config validation [skip ci] ([`3d5cd5c`](`3d5cd5ccf3`)) * travis: quote pathspecs used with `git ls-files` [skip ci] ([`668926c`](`668926cbd8`)) * travis: run `shellcheck` during lint job [skip ci] ([`fd9aba2`](`fd9aba207e`)) * travis: update `salt-lint` config for `v0.0.10` [skip ci] ([`ce2de8b`](`ce2de8b669`)) * travis: use `major.minor` for `semantic-release` version [skip ci] ([`dcfa3d5`](`dcfa3d5c7d`)) * travis: use build config validation (beta) [skip ci] ([`9d34a63`](`9d34a6399f`)) * workflows/commitlint: add to repo [skip ci] ([`ff23c72`](`ff23c72345`)) * merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([`a3fd56e`](`a3fd56e002`)) * merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([`2eb11ff`](`2eb11ff146`)) ### Documentation * contributing: remove to use org-level file instead [skip ci] ([`b44429d`](`b44429d6c4`)) * readme: update link to `CONTRIBUTING` [skip ci] ([`9231f3f`](`9231f3f144`)) ### Performance Improvements * travis: improve `salt-lint` invocation [skip ci] ([`1958610`](`19586109fa`)) ### Styles * libtofs.jinja: use Black-inspired Jinja formatting [skip ci] ([`3de8cb7`](`3de8cb7462`))		vor 4 Jahren
..
AUTHORS.rst	chore(release): 0.5.1 [skip ci]	vor 4 Jahren
CHANGELOG.rst	chore(release): 0.5.1 [skip ci]	vor 4 Jahren
README.rst	docs(readme): update link to `CONTRIBUTING` [skip ci]	vor 5 Jahren
TOFS_pattern.rst	feat(tofs): add TOFS support	vor 5 Jahren

README.rst

.. _readme:

syslog-ng-formula
=================

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/syslog-ng-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/syslog-ng-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
   :alt: Semantic Release
   :scale: 100%
   :target: https://github.com/semantic-release/semantic-release

Formula to set up and configure syslog_ng

.. contents:: **Table of Contents**

General notes
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.

If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
which contains the currently released version. This formula is versioned according to `Semantic Versioning <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo
-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.

Available states
----------------

.. contents::
    :local:

``syslog_ng``
^^^^^^^^^^^^^
Installs and configures the syslog_ng package.

``syslog_ng.package``
^^^^^^^^^^^^^^^^^^^^^^
Installs the syslog_ng package and optional packages which may provide additional functionalities.

``syslog_ng.config``
^^^^^^^^^^^^^^^^^^^^
This state manages the file ``syslog_ng.conf`` under ``/etc/syslog-ng`` (template found in "syslog_ng/files"). The configuration is populated by values in "syslog_ng/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.

``syslog_ng.service``
^^^^^^^^^^^^^^^^^^^^
Manages the startup and running state of the syslog_ng service.

Testing
-------

Linux testing is done with ``kitchen-salt``.

Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash

   $ gem install bundler
   $ bundle install
   $ bin/kitchen test [platform]

Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.

``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^

Creates the docker instance and runs the ``syslog_ng`` main state, ready for testing.

``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^

Runs the ``inspec`` tests on the actual instance.

``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^

Removes the docker instance.

``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^

Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.

``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^

Gives you SSH access to the instance for manual testing.