/telegraf-formula

Primary LanguageHTMLApache License 2.0Apache-2.0

telegraf-formula

Travis CI Build Status Semantic Release

Formula to set up and configure telegraf

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.

Commit message formatting is significant!!

Please see :ref:`How to contribute <CONTRIBUTING>` for more details.

Installs and configures the telegraf package from upstream repository.

Installs the telegraf repository. See Telegraf doc for more details.

Installs the telegraf package.

This state manages the file telegraf.conf under /etc/telegraf (template found in "telegraf/files"). The configuration is populated by values in "telegraf/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.

Manages the startup and running state of the telegraf service.

Linux testing is done with kitchen-salt.

  • Ruby
  • Docker
$ 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.

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

Runs the inspec tests on the actual instance.

Removes the docker instance.

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

Gives you SSH access to the instance for manual testing.