telegraf-formula
1. 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.
2. Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
3. Available states
3.2. telegraf.repo
Installs the telegraf repository. See Telegraf doc for more details.
3.4. telegraf.config
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.
4. Testing
Linux testing is done with kitchen-salt
.
4.1. Requirements
-
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
.
4.2. bin/kitchen converge
Creates the docker instance and runs the telegraf
main state, ready
for testing.