~evilham/cdist-evilham

a5ce219a82bdfc7fda852ee9e969539fbdcc53dd — Michelle 9 months ago 4bd69a9
Added base for manual for alertmanager type
1 files changed, 51 insertions(+), 0 deletions(-)

A type/__evilham_alertmanager/man.rst
A type/__evilham_alertmanager/man.rst => type/__evilham_alertmanager/man.rst +51 -0
@@ 0,0 1,51 @@
cdist-type__evilham_alertmanager(7)
===================================

NAME
----
cdist-type__evilham_alertmanager - Setup a alertmanager service for prometheus


DESCRIPTION
-----------

VictoriaMetrics is a monitoring software solution and time-series database, 
written in go. It can provide long-term storage for Prometheus.

The object identification given to the type will be the subfolder use for the
data storage inside the home directory for the user. This allows for multiple
node instances in the same victoria metrics service.

OPTIONAL PARAMETERS
-------------------
user
    User that owns the prometheus alertmanager data directory.
    Defaults to `alertmanager`.

data-path
    Alternative path for the storage of prometheus alertmanager.
    Defaults to `/var/lib/alertmanager`.

listen-address
    Address and port to listen to TCP connections.
    Defaults to `:9093`.

extra-args
    Extra arguments for configurating flags on alertmanager.

EXAMPLES
--------

.. code-block:: sh

      __evilham_victoriametrics storage1 --user vm --storage-data-path '/var/lib/vm'\
      --retention-period 4w --http-listen-addr :8190 --extra-args '-search.disableCache'

AUTHORS
-------
Evilham <contact@evilham.com>
Michelle <michellequinteroh@gmail.com>

COPYING
-------
Copyright \(C) 2023 Evilham.