History

Imran Iqbal 1b2c50ae37 docs: remove files which aren't formula-specific [skip ci] Further reason is to avoid issues with `rst-lint`: ``` ERROR docs/index.rst:10 Unknown directive type "toctree". ```		2021-05-17 18:59:42 +01:00
..
_static/css	refactor(all): align to template-formula; add clientlibs feature	2020-05-15 11:12:28 +01:00
AUTHORS.rst	chore(release): 5.4.0 [skip ci]	2021-02-10 18:34:14 +00:00
CHANGELOG.rst	chore(release): 5.4.0 [skip ci]	2021-02-10 18:34:14 +00:00
README.rst	docs(readme): fix headings and contributing link [skip ci]	2021-05-05 15:21:42 +01:00
TOFS_pattern.rst	ci(pre-commit): finalise `rstcheck` configuration [skip ci]	2020-10-10 06:51:16 +01:00

README.rst

prometheus-formula

Formula to manage Prometheus on GNU/Linux and MacOS.

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.

Special notes

None.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Available metastates

`prometheus`

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

This installs from prometheus solution.

`prometheus.archive`

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

`prometheus.clientlibs`

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

`prometheus.package`

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

`prometheus.config`

This state will apply prometheus service configuration (files).

`prometheus.service`

This state will start prometheus component services.

`prometheus.exporters`

This state will apply prometheus exporters configuration.

`prometheus.exporters.clean`

This state will remove prometheus exporters configuration.

`prometheus.service.clean`

This state will stop prometheus component services.

`prometheus.config.clean`

This state will remove prometheus service configuration (files).

`prometheus.package.clean`

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

`prometheus.clientlibs.clean`

This state will uninstall prometheus client libraries.

`prometheus.archive.clean`

This state will remove prometheus component archive (directories).

Testing

Linux testing is done with kitchen-salt.

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.

`bin/kitchen converge`

Creates the docker instance and runs the prometheus 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.