Skip to content

Commit

Permalink
Update munin-graph and munin-html documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ssm committed Dec 7, 2012
1 parent 118e284 commit fb42616
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 15 deletions.
19 changes: 9 additions & 10 deletions doc/master/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,23 @@ The following components are part of munin-master:
<munin-node>`, which is then stored in RRD files.

* :ref:`munin-graph` is run by :ref:`munin-cron`. It generates
graphs in PNG format from the RRD files. See also
:ref:`munin-cgi-graph`.
metadata used by :ref:`munin-cgi-graph`. If graph_strategy is set
to "cron", it generates static graphs in PNG format.

* :ref:`munin-limits` is run by :ref:`munin-cron`. It notifies any
configured contacts if a value moves between "ok", "warn" or
"crit". Munin is commonly used in combination with Nagios, which
is then configured as a contact.

* :ref:`munin-html` is run by :ref:`munin-cron`. It generates HTML
pages. See also :ref:`munin-cgi-html`.
* :ref:`munin-html` is run by :ref:`munin-cron`. It generates
metadata used by :ref:`munin-cgi-html`. If html_strategy is set
to "cron", it also generates static HTML pages.

* :ref:`munin-cgi-graph` is run by a web server. If graph_strategy
is set to "cgi", munin-cron will not run munin-graph, and assumes
that the web server runs :ref:`munin-cgi-graph` instead.
* :ref:`munin-cgi-graph` is run by a web server, and generates
graphs on request.

* :ref:`munin-cgi-html` is run by a web server. If html_strategy is
set to "cgi", munin-cron will not run munin-html, and assumes
that the web server runs :ref:`munin-cgi-html` instead.
* :ref:`munin-cgi-html` is run by a web server, and generates HTML
pages on request.

Configuration
=============
Expand Down
10 changes: 8 additions & 2 deletions doc/reference/munin-graph.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,14 @@
DESCRIPTION
===========

The munin-graph script is run by munin-cron, and creates graphs from
all RRD files in the munin database directory.
munin-graph script is one of the munin master components run from the
:ref:`munin-cron` script.

munin-graph generates metadata used by :ref:`munin-cgi-graph`.

If "graph_strategy" is set to "cron", munin-graph creates static
graphs from all RRD files in the munin database directory. If
graph_strategy is set to "cgi", munin-graph will not create graphs.

OPTIONS
=======
Expand Down
6 changes: 3 additions & 3 deletions doc/reference/munin-html.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ DESCRIPTION
munin-html is one of the munin master components run from the
:ref:`munin-cron` script.

This script is responsible for generating static HTML pages.
munin-html generates metadata used by :ref:`munin-cgi-html`.

If "html_strategy cgi" is set in munin.conf, munin-html will assume
HTML pages are generated by munin-cgi-html, and exit silently.
If "html_strategy" is set to "cron", munin-html creates static HTML
pages. If "html_strategy" is set to "cgi", it will not generate pages.

OPTIONS
=======
Expand Down

0 comments on commit fb42616

Please sign in to comment.