prometheus-formula/docs

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

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

This state will manage prometheus exporters according to Pillar prometheus:exporters. It includes sub-states like prometheus.exporters.node. If you don't want to use Pillar data for this you may use the sub-states directly.