diff options
author | Narayan Desai <desai@mcs.anl.gov> | 2006-09-15 15:23:03 +0000 |
---|---|---|
committer | Narayan Desai <desai@mcs.anl.gov> | 2006-09-15 15:23:03 +0000 |
commit | a727d26da93cdbf014892115a9f8559b706f2f34 (patch) | |
tree | 3bd45acff1f5d4b7ef64bd9e426c7ea740056cd2 | |
parent | ee506feaa79f1ce567bd14eae4429717eb0e9c3c (diff) | |
download | bcfg2-a727d26da93cdbf014892115a9f8559b706f2f34.tar.gz bcfg2-a727d26da93cdbf014892115a9f8559b706f2f34.tar.bz2 bcfg2-a727d26da93cdbf014892115a9f8559b706f2f34.zip |
Update for 0.8.4
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@2261 ce84e21b-d406-0410-9b95-82705330c041
-rw-r--r-- | doc/manual.xml | 8 | ||||
-rw-r--r-- | doc/reports.xml | 22 |
2 files changed, 15 insertions, 15 deletions
diff --git a/doc/manual.xml b/doc/manual.xml index 16759a2cf..3213d27d5 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -40,8 +40,8 @@ </affiliation> </author> </authorgroup> - <date>September 5, 2006</date> - <edition>Manual for version 0.8.3</edition> + <date>September 15, 2006</date> + <edition>Manual for version 0.8.4</edition> <releaseinfo>$Revision$</releaseinfo> <pubdate>July 2006</pubdate> <copyright> @@ -72,7 +72,7 @@ <revhistory> <revision> - <revnumber>0.8.3</revnumber> + <revnumber>0.8.4</revnumber> <date>$Date$</date> <revremark>$Id$</revremark> </revision> @@ -85,4 +85,4 @@ &deployment; &development; &reports; -</book>
\ No newline at end of file +</book> diff --git a/doc/reports.xml b/doc/reports.xml index 23493658e..25837bf2a 100644 --- a/doc/reports.xml +++ b/doc/reports.xml @@ -24,9 +24,9 @@ <para> The BCFG2 Reporting System consists of a number of elements - including the <command>StatReports</command> Executable, a + including the <command>bcfg2-build-reports</command> Executable, a configuration file, and XSLT transform - files. <command>StatReports</command> reads a default + files. <command>bcfg2-build-reports</command> reads a default configuration file (or a config file specified on the command line) then prepares and delivers the reports according to the format defined in the transform files. It is expected that this @@ -36,17 +36,17 @@ needs to be generated immediately. </para> <para> - <command>StatReports</command> gets the data it reports from a + <command>bcfg2-build-reports</command> gets the data it reports from a number of sources. <filename>Metadata/clients.xml</filename> contains information about if a host is currently pingable or - not. <command>GenerateHostInfo</command> will be run - automatically by <command>StatReports</command> if the + not. <command>bcfg2-ping-sweep</command> will be run + automatically by <command>bcfg2-build-reports</command> if the <filename>Metadata/clients.xml</filename> file is out of date with pingability information. </para> <para> - The next place <command>StatReports</command> gets data from is + The next place <command>bcfg2-build-reports</command> gets data from is the <filename>statistics.xml</filename> file. This file is maintained by bcfgd, and is updated whenever a client updates, therefore is always up to date and no maintainance is required @@ -55,7 +55,7 @@ </para> <para> - Finally <command>StatReports</command> is able to pull information + Finally <command>bcfg2-build-reports</command> is able to pull information from the <filename>Metadata/groups.xml</filename> file as well. This allows reports to describe the configured profile for each client. </para> @@ -146,7 +146,7 @@ <title>Configuration</title> <para>The <filename>report-configuration.xml</filename> file is - the standard file that the <command>StatReports</command> + the standard file that the <command>bcfg2-build-reports</command> executable uses when it is run without any command line arguments. Alternate configuration files, formatted identically, can be used by specifing -c flag. This can be useful for @@ -154,8 +154,8 @@ example:</para> <programlisting> - Run this hourly: StatReports -c WebAndRssReport-config.xml - Run this daily: StatReports -c emailReports-config.xml + Run this hourly: bcfg2-build-reports -c WebAndRssReport-config.xml + Run this daily: bcfg2-build-reports -c emailReports-config.xml </programlisting> <para>The <filename>report-configuration.xml</filename> @@ -224,7 +224,7 @@ <para> Once configured correctly, just wait for the e-mail or view the outputed html files with a web browser. - <command>StatReports</command> to recieve your reports + <command>bcfg2-build-reports</command> to recieve your reports immediately, or configure cron to run it perodically. E-mail reports will deliver the appropriate content directly to your mail client, and the html files should be viewable with any web |