prometheus-formula

History

semantic-release-bot 7eede35f7b chore(release): 3.3.0 [skip ci]

# [3.3.0](https://github.com/saltstack-formulas/prometheus-formula/compare/v3.2.0...v3.3.0) (2019-12-22)

### Bug Fixes

* **pillar.example:** reset `use_upstream_archive` to get tests passing [skip ci] ([978ccc2](978ccc2080))
* test fix for bug 24 ([341fff3](341fff36ea))
* **release.config.js:** use full commit hash in commit link [skip ci] ([cab6e29](cab6e29d8b))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([a51e532](a51e532992))
* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([6ee835c](6ee835cab4))
* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([42ee683](42ee683c44))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([044553e](044553ea8f))
* **travis:** apply changes from build config validation [skip ci] ([bf4022e](bf4022ec1a))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([0867508](086750884d))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([d9c9386](d9c9386038))
* **travis:** run `shellcheck` during lint job [skip ci] ([7ea6967](7ea6967ca7))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([1415c13](1415c13785))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([9b4d5af](9b4d5aff64))
* **travis:** use build config validation (beta) [skip ci] ([0d0af0d](0d0af0df31))

### Features

* **osfamilymap.yaml:** add Gentoo support ([b87e8f4](b87e8f437c))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([36ccdc4](36ccdc4416))

2019-12-22 22:02:41 +00:00

AUTHORS.rst

chore(release): 3.3.0 [skip ci]

2019-12-22 22:02:41 +00:00

CHANGELOG.rst

chore(release): 3.3.0 [skip ci]

2019-12-22 22:02:41 +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

.. _readme:

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

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/prometheus-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/prometheus-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
   :alt: Semantic Release
   :scale: 100%
   :target: https://github.com/semantic-release/semantic-release
Manage Prometheus on MacOS, GNU/Linux and FreeBSD.

.. contents:: **Table of Contents**

General notes
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

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 <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo
-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.

Available states
----------------

.. contents::
   :local:

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