saltstack-formulas/prometheus-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
06dce05ca7
prometheus-formula/docs
History
semantic-release-bot 06dce05ca7 chore(release): 3.2.0 [skip ci] 
# [3.2.0](https://github.com/saltstack-formulas/prometheus-formula/compare/v3.1.2...v3.2.0) (2019-10-17)

### Bug Fixes

* **args:** allow boolean arguments ([](https://github.com/saltstack-formulas/prometheus-formula/commit/39dacf0))
* **examples:** fixed pillar.example ([](https://github.com/saltstack-formulas/prometheus-formula/commit/464a186))
* **node_exporter:** allow standalone use of node_exporter ([](https://github.com/saltstack-formulas/prometheus-formula/commit/a0d8ad4))
* **package:** use correct node exporter package name in Debian ([](https://github.com/saltstack-formulas/prometheus-formula/commit/a4fd589))
* **readme:** removed already gone prometheus.exporters from README.rst ([](https://github.com/saltstack-formulas/prometheus-formula/commit/07d6209))

### Continuous Integration

* merge travis matrix, add `salt-lint` & `rubocop` to `lint` job ([](https://github.com/saltstack-formulas/prometheus-formula/commit/9def915))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/fabcc4a))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/da2a5aa))

### Features

* **freebsd:** support for FreeBSD ([](https://github.com/saltstack-formulas/prometheus-formula/commit/871da35))
* **textfile_collectors:** added IPMI textfile collector ([](https://github.com/saltstack-formulas/prometheus-formula/commit/d731309))
* **textfile_collectors:** added smartmon textfile collector ([](https://github.com/saltstack-formulas/prometheus-formula/commit/7b2f5ce))
* **textfile_collectors:** added support for textfile collectors ([](https://github.com/saltstack-formulas/prometheus-formula/commit/930552d))
2019-10-17 06:32:30 +00:00
..
AUTHORS.rst chore(release): 3.2.0 [skip ci] 2019-10-17 06:32:30 +00:00
CHANGELOG.rst chore(release): 3.2.0 [skip ci] 2019-10-17 06:32:30 +00:00
README.rst feat(textfile_collectors): added support for textfile collectors 2019-10-17 08:21:16 +02:00
TOFS_pattern.rst chore: use semantic-release cross-formula standard structure 2019-08-17 16:06:58 +01:00

README.rst

prometheus-formula ================

Travis CI Build Status Semantic Release

Manage Prometheus on MacOS, GNU/Linux and FreeBSD.

Table of Contents

General notes

See the full SaltStack Formulas installation and usage instructions.

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.

Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

Available states

prometheus ^^^^^^^^^^^^

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

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

prometheus.archive ^^^^^^^^^^^^^^^^^^^^

This state will install the prometheus from archive file only.

prometheus.archive.alternatives ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will install the prometheus linux alternatives for archives only.

prometheus.package ^^^^^^^^^^^^^^^^^^^^

This state will install the prometheus package only.

prometheus.package.repo ^^^^^^^^^^^^^^^^^^^^^^^^^

This state will install the prometheus package only.

prometheus.config ^^^^^^^^^^^^^^^^^^^

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

prometheus.service ^^^^^^^^^^^^^^^^^^^^

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

prometheus.clean ^^^^^^^^^^^^^^^^^^

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

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

prometheus.service.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^

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

prometheus.config.clean ^^^^^^^^^^^^^^^^^^^^^^^^^

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

prometheus.package.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^

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

prometheus.package.archive.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will uninstall the prometheus archive-extracted directory only.

prometheus.package.archive.alternatives.clean ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This state will uninstall the prometheus linux alternatives for archives only.

prometheus.package.repo.clean ^^^^^^^^^^^^^^^^^^^^^^^^^

This state will uninstall the prometheus upstream package repository only.

prometheus.config.node_exporter.textfile_collectors

This state will manage the node exporter's textfile collectors according to Pillar prometheus:exporters:node_exporter:textfile_collectors.