Prometheus Formula for Saltstack
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Sean Johnson 345e590de9 Remove Debian overrides 1 month ago
bin ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 1 year ago
ci Debian only 1 year ago
docs chore(release): 3.3.0 [skip ci] 1 year ago
prometheus Remove Debian overrides 1 month ago
test/integration/default Add ci config 1 year ago
.gitignore chore: use `semantic-release` cross-formula standard structure 1 year ago
.rubocop.yml ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 1 year ago
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 1 year ago
.travis.yml ci(travis): use `major.minor` for `semantic-release` version [skip ci] 1 year ago
.yamllint ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 1 year ago
AUTHORS.md chore(release): 3.3.0 [skip ci] 1 year ago
CHANGELOG.md chore(release): 3.3.0 [skip ci] 1 year ago
FORMULA chore(release): 3.3.0 [skip ci] 1 year ago
Gemfile Debian only 1 year ago
LICENSE chore(licence): edited year 1 year ago
commitlint.config.js ci(travis): use structure of template-formula 1 year ago
kitchen.yml Support flag-only args 1 year ago
pillar.example Allow writing rules files in prometheus pillar 5 months ago
pre-commit_semantic-release.sh ci(travis): run `shellcheck` during lint job [skip ci] 1 year ago
release-rules.js ci(travis): use structure of template-formula 1 year ago
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 1 year ago

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