summaryrefslogtreecommitdiffstats
path: root/lib/puppet/reports
diff options
context:
space:
mode:
authorJames Turnbull <james@lovedthanlost.net>2010-08-12 09:28:36 +1000
committerMarkus Roberts <Markus@reality.com>2010-08-11 22:19:35 -0700
commit1157e8dbaf310cca6f56dda3fa9f100b458662ee (patch)
treed81cf0c9e21d99cc2d0ed24cbaddd23de9d7462d /lib/puppet/reports
parentfef8800acaddd54659602b65bd9fdc728d187c67 (diff)
Updated all types to Markdown output
Updated defaults.rb to Markdown Migrated report documentation to Markdown Migrated Naginator doco to Markdown Updated provider documentation to Markdown
Diffstat (limited to 'lib/puppet/reports')
-rw-r--r--lib/puppet/reports/http.rb2
-rw-r--r--lib/puppet/reports/rrdgraph.rb17
-rw-r--r--lib/puppet/reports/store.rb4
-rw-r--r--lib/puppet/reports/tagmail.rb25
4 files changed, 23 insertions, 25 deletions
diff --git a/lib/puppet/reports/http.rb b/lib/puppet/reports/http.rb
index f1a74195d..7ac54dfbd 100644
--- a/lib/puppet/reports/http.rb
+++ b/lib/puppet/reports/http.rb
@@ -5,7 +5,7 @@ require 'uri'
Puppet::Reports.register_report(:http) do
desc <<-DESC
- Send report information via HTTP to the ``reporturl``. Each host sends
+ Send report information via HTTP to the `reporturl`. Each host sends
its report as a YAML dump and this sends this YAML to a client via HTTP POST.
The YAML is the `report` parameter of the request."
DESC
diff --git a/lib/puppet/reports/rrdgraph.rb b/lib/puppet/reports/rrdgraph.rb
index 9fbeb60e8..2357e233e 100644
--- a/lib/puppet/reports/rrdgraph.rb
+++ b/lib/puppet/reports/rrdgraph.rb
@@ -1,12 +1,11 @@
Puppet::Reports.register_report(:rrdgraph) do
desc "Graph all available data about hosts using the RRD library. You
must have the Ruby RRDtool library installed to use this report, which
- you can get from `the RubyRRDTool RubyForge page`_. This package may also
- be available as ``ruby-rrd`` or ``rrdtool-ruby`` in your distribution's package
- management system. The library and/or package will both require the binary
- ``rrdtool`` package from your distribution to be installed.
-
- .. _the RubyRRDTool RubyForge page: http://rubyforge.org/projects/rubyrrdtool/
+ you can get from
+ [the RubyRRDTool RubyForge page](http://rubyforge.org/projects/rubyrrdtool/).
+ This package may also be available as `ruby-rrd` or `rrdtool-ruby` in your
+ distribution's package management system. The library and/or package will both
+ require the binary `rrdtool` package from your distribution to be installed.
This report will create, manage, and graph RRD database files for each
of the metrics generated during transactions, and it will create a
@@ -14,12 +13,12 @@ Puppet::Reports.register_report(:rrdgraph) do
point, it will not create a common index file to display links to
all hosts.
- All RRD files and graphs get created in the ``rrddir`` directory. If
+ All RRD files and graphs get created in the `rrddir` directory. If
you want to serve these publicly, you should be able to just alias that
directory in a web server.
- If you really know what you're doing, you can tune the ``rrdinterval``,
- which defaults to the ``runinterval``."
+ If you really know what you're doing, you can tune the `rrdinterval`,
+ which defaults to the `runinterval`."
def hostdir
@hostdir ||= File.join(Puppet[:rrddir], self.host)
diff --git a/lib/puppet/reports/store.rb b/lib/puppet/reports/store.rb
index 65159fc07..30f24591c 100644
--- a/lib/puppet/reports/store.rb
+++ b/lib/puppet/reports/store.rb
@@ -2,7 +2,7 @@ require 'puppet'
Puppet::Reports.register_report(:store) do
desc "Store the yaml report on disk. Each host sends its report as a YAML dump
- and this just stores the file on disk, in the ``reportdir`` directory.
+ and this just stores the file on disk, in the `reportdir` directory.
These files collect quickly -- one every half hour -- so it is a good idea
to perform some maintenance on them if you use this report (it's the only
@@ -19,7 +19,7 @@ Puppet::Reports.register_report(:store) do
:owner => 'service',
:group => 'service'
},
-
+
:noop => [false, "Used by settings internally."]
)
diff --git a/lib/puppet/reports/tagmail.rb b/lib/puppet/reports/tagmail.rb
index 652104096..71bafb2da 100644
--- a/lib/puppet/reports/tagmail.rb
+++ b/lib/puppet/reports/tagmail.rb
@@ -6,12 +6,12 @@ require 'time'
Puppet::Reports.register_report(:tagmail) do
desc "This report sends specific log messages to specific email addresses
- based on the tags in the log messages. See the
- `UsingTags tag documentation`:trac: for more information
- on tags.
+ based on the tags in the log messages.
- To use this report, you must create a ``tagmail.conf`` (in the location
- specified by ``tagmap``). This is a simple file that maps tags to
+ See the [UsingTags tag documentation](http://projects.puppetlabs.com/projects/puppet/wiki/Using_Tags) for more information on tags.
+
+ To use this report, you must create a `tagmail.conf` (in the location
+ specified by `tagmap`). This is a simple file that maps tags to
email addresses: Any log messages in the report that match the specified
tags will be sent to the specified email addresses.
@@ -20,21 +20,20 @@ Puppet::Reports.register_report(:tagmail) do
the email addresses by a colon, and the email addresses should also
be comma-separated.
- Lastly, there is an ``all`` tag that will always match all log messages.
+ Lastly, there is an `all` tag that will always match all log messages.
- Here is an example tagmail.conf::
+ Here is an example `tagmail.conf`:
- all: me@domain.com
- webserver, !mailserver: httpadmins@domain.com
+ all: me@domain.com
+ webserver, !mailserver: httpadmins@domain.com
- This will send all messages to ``me@domain.com``, and all messages from
- webservers that are not also from mailservers to ``httpadmins@domain.com``.
+ This will send all messages to `me@domain.com`, and all messages from
+ webservers that are not also from mailservers to `httpadmins@domain.com`.
If you are using anti-spam controls, such as grey-listing, on your mail
- server you should whitelist the sending email (controlled by ``reportform`` configuration option) to ensure your email is not discarded as spam.
+ server you should whitelist the sending email (controlled by `reportform` configuration option) to ensure your email is not discarded as spam.
"
-
# Find all matching messages.
def match(taglists)
matching_logs = []