From a727d26da93cdbf014892115a9f8559b706f2f34 Mon Sep 17 00:00:00 2001 From: Narayan Desai Date: Fri, 15 Sep 2006 15:23:03 +0000 Subject: Update for 0.8.4 git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@2261 ce84e21b-d406-0410-9b95-82705330c041 --- doc/manual.xml | 8 ++++---- doc/reports.xml | 22 +++++++++++----------- 2 files changed, 15 insertions(+), 15 deletions(-) (limited to 'doc') 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 @@ - September 5, 2006 - Manual for version 0.8.3 + September 15, 2006 + Manual for version 0.8.4 $Revision$ July 2006 @@ -72,7 +72,7 @@ - 0.8.3 + 0.8.4 $Date$ $Id$ @@ -85,4 +85,4 @@ &deployment; &development; &reports; - \ No newline at end of file + 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 @@ The BCFG2 Reporting System consists of a number of elements - including the StatReports Executable, a + including the bcfg2-build-reports Executable, a configuration file, and XSLT transform - files. StatReports reads a default + files. bcfg2-build-reports 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. - StatReports gets the data it reports from a + bcfg2-build-reports gets the data it reports from a number of sources. Metadata/clients.xml contains information about if a host is currently pingable or - not. GenerateHostInfo will be run - automatically by StatReports if the + not. bcfg2-ping-sweep will be run + automatically by bcfg2-build-reports if the Metadata/clients.xml file is out of date with pingability information. - The next place StatReports gets data from is + The next place bcfg2-build-reports gets data from is the statistics.xml 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 @@ - Finally StatReports is able to pull information + Finally bcfg2-build-reports is able to pull information from the Metadata/groups.xml file as well. This allows reports to describe the configured profile for each client. @@ -146,7 +146,7 @@ Configuration The report-configuration.xml file is - the standard file that the StatReports + the standard file that the bcfg2-build-reports 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: - 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 The report-configuration.xml @@ -224,7 +224,7 @@ Once configured correctly, just wait for the e-mail or view the outputed html files with a web browser. - StatReports to recieve your reports + bcfg2-build-reports 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 -- cgit v1.2.3-1-g7c22