68f54e4dad
# [4.0.0](https://github.com/saltstack-formulas/prometheus-formula/compare/v3.3.0...v4.0.0) (2020-08-09) ### Bug Fixes * **libtofs:** “files_switch” mess up the variable exported by “map.jinja” [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/5403088)) * **pr:** adopt pr comments ([](https://github.com/saltstack-formulas/prometheus-formula/commit/e4b924a)) ### Code Refactoring * **all:** align to template-formula; add clientlibs feature ([](https://github.com/saltstack-formulas/prometheus-formula/commit/ce5b771)) ### Continuous Integration * **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/da8f6a8)) * **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/f63a64d)) * **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/9b45ea4)) * **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/d978c50)) * **travis:** add notifications => zulip [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/4b5ec2f)) * **workflows/commitlint:** add to repo [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/b32d92a)) ### Styles * **libtofs.jinja:** use Black-inspired Jinja formatting [skip ci] ([](https://github.com/saltstack-formulas/prometheus-formula/commit/2660b19)) ### BREAKING CHANGES * **all:** The data dictionary is simplified and expanded. Retest your states and update pillar data accordingly. For developer convenience, clientlibs states were introduced. See pillar.example, defaults.yaml, and docs/README. |
||
|---|---|---|
| .. | ||
| _static/css | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| conf.py | ||
| index.rst | ||
| README.rst | ||
| TOFS_pattern.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 <CONTRIBUTING> 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.