~evilham/cdist-evilham

845df7719b369e038d2568d3dc946d259977e4dd — Michelle 9 months ago a5ce219
Manuals for victoria metrics types updated
2 files changed, 16 insertions(+), 8 deletions(-)

M type/__evilham_victoriametrics/man.rst
M type/__evilham_victoriametrics_vmauth/man.rst
M type/__evilham_victoriametrics/man.rst => type/__evilham_victoriametrics/man.rst +7 -3
@@ 22,7 22,7 @@ user
    User that owns the victoria metrics data directory.
    Defaults to `victoriametrics`.

storage-data-path
data-path
    Alternative path for the storage of victoria metrics.
    Defaults to `/var/lib/victoria-metrics-data`.



@@ 32,16 32,20 @@ retention-period
    y(years). If the unit isn't specified, months is the default.
    Defaults to 1 month.

http-listen-addr
listen-address
    Address and port to listen to TCP connections.
    Defaults to `:8428`.

extra-args
    Extra arguments for configurating flags on victoria metrics.

EXAMPLES
--------

.. code-block:: sh

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

AUTHORS
-------

M type/__evilham_victoriametrics_vmauth/man.rst => type/__evilham_victoriametrics_vmauth/man.rst +9 -5
@@ 15,16 15,17 @@ written in go. It can provide long-term storage for Prometheus.
This type allows for the use of a proxy to router access to each storage node
for victoria metrics in a specific direction, or load balancing requests.

REQUIRED MULTIPLE PARAMETERS
REQUIRED PARAMETERS
-------------------
user-entry
    User entry for authentication. This section will be added to config.yml
    for the authentcation of the each user. It has to be a block of 
config-file-source
    This section will be added to config.yml for the authentcation
    of the each user. It has to be a block of
    characters, see `https://docs.victoriametrics.com/vmauth.html`.

    This parameter accepts stdin as input, we don't make responsible for
    the misuse of it.


OPTIONAL PARAMETERS
-------------------
user


@@ 38,10 39,13 @@ data-path

    The needed directories will be automatically created.

http-listen-addr
listen-address
    Address and port to listen to TCP connections.
    Defaults to `:8427`.

extra-args
    Extra arguments for configurating flags on victoria metrics.

EXAMPLES
--------