https://github.com/saltstack-formulas/syslog-ng-formula

https://github.com/saltstack-formulas/syslog-ng-formula

saltstack syslog-ng

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/saltstack-formulas/syslog-ng-formula
• Owner: saltstack-formulas
• License: apache-2.0
• Created: 2014-08-26T20:37:45.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T23:12:24.000Z (6 months ago)
• Last Synced: 2024-09-30T13:39:17.965Z (3 months ago)
• Topics: saltstack, syslog-ng
• Language: Jinja
• Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
• Size: 304 KB
• Stars: 14
• Watchers: 40
• Forks: 17
• Open Issues: 3
• Metadata Files:
  • Readme: docs/README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Authors: AUTHORS.md

Awesome Lists containing this project

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

`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section

`_.

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 `_.

See `Formula Versioning Section `_ for more details.

Contributing to this repo

-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute `_ 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.