prometheus-formula

Formula to manage Prometheus on GNU/Linux and MacOS.

Travis CI Build Status Semantic Release

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. Special notes

None.

3. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

4. Available metastates

4.1. prometheus

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

This installs from prometheus solution.

4.2. prometheus.archive

This state will install prometheus components on MacOS and GNU/Linux from archive.

4.3. prometheus.clientlibs

This state will install prometheus client libraries on MacOS and GNU/Linux from archive.

4.4. prometheus.package

This state will install prometheus component packages from GNU/Linux.

4.5. prometheus.config

This state will apply prometheus service configuration (files).

4.6. prometheus.service

This state will start prometheus component services.

4.7. prometheus.exporters

This state will apply prometheus exporters configuration.

4.8. prometheus.exporters.clean

This state will remove prometheus exporters configuration.

4.9. prometheus.service.clean

This state will stop prometheus component services.

4.10. prometheus.config.clean

This state will remove prometheus service configuration (files).

4.11. prometheus.package.clean

This state will uninstall prometheus component packages from GNU/Linux.

4.12. prometheus.clientlibs.clean

This state will uninstall prometheus client libraries.

4.13. prometheus.archive.clean

This state will remove prometheus component archive (directories).

5. Testing

Linux testing is done with kitchen-salt.

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

5.2. bin/kitchen converge

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

5.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

5.4. bin/kitchen destroy

Removes the docker instance.

5.5. bin/kitchen test

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

5.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.