.. _readme:

splunkforwarder-formula

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/splunkforwarder-formula.svg?branch=master :alt: Travis CI Build Status :scale: 100% :target: https://travis-ci.com/saltstack-formulas/splunkforwarder-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 .. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white :alt: pre-commit :scale: 100% :target: https://github.com/pre-commit/pre-commit

A SaltStack formula that is empty. It has dummy content to help with a quick start on a new formula and it serves as a style guide.

.. contents:: Table of Contents :depth: 1

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.

If you need (non-default) configuration, please refer to:

how to configure the formula with map.jinja <map.jinja.rst>_
the pillar.example file
the Special notes_ section

Contributing to this repo

Commit messages ^^^^^^^^^^^^^^^

Commit message formatting is significant!!

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

pre-commit ^^^^^^^^^^

pre-commit <https://pre-commit.com/> is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method <https://pre-commit.com/#installation>, then run bin/install-hooks and now pre-commit will run automatically on each git commit. ::

$ bin/install-hooks pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/commit-msg

Special notes

None

Available states

.. contents:: :local:

splunkforwarder ^^^^^^^^^^^^

Meta-state (This is a state that includes other states).

This installs the splunkforwarder package, manages the splunkforwarder configuration file and then starts the associated splunkforwarder service.

splunkforwarder.package ^^^^^^^^^^^^^^^^^^^^

This state will install the splunkforwarder package only.

splunkforwarder.config ^^^^^^^^^^^^^^^^^^^

This state will configure the splunkforwarder service and has a dependency on splunkforwarder.install via include list.

splunkforwarder.service ^^^^^^^^^^^^^^^^^^^^

This state will start the splunkforwarder service and has a dependency on splunkforwarder.config via include list.

splunkforwarder.clean ^^^^^^^^^^^^^^^^^^

Meta-state (This is a state that includes other states).

this state will undo everything performed in the splunkforwarder meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

splunkforwarder.service.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will stop the splunkforwarder service and disable it at boot time.

splunkforwarder.config.clean ^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the configuration of the splunkforwarder service and has a dependency on splunkforwarder.service.clean via include list.

splunkforwarder.package.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will remove the splunkforwarder package and has a depency on splunkforwarder.config.clean via include list.

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 splunkforwarder 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.