summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Laszlo <tim.laszlo@gmail.com>2012-10-11 13:15:42 -0500
committerTim Laszlo <tim.laszlo@gmail.com>2012-10-11 13:26:13 -0500
commitbfb559574a5e4dc4c44c4950cb722bd4e31c13a5 (patch)
tree7f7fb1723e8f6bcdd235f8bb7138f371df74b881
parentcd3e173e53c5a676353fb6aaf9f6e0beb912247d (diff)
downloadbcfg2-bfb559574a5e4dc4c44c4950cb722bd4e31c13a5.tar.gz
bcfg2-bfb559574a5e4dc4c44c4950cb722bd4e31c13a5.tar.bz2
bcfg2-bfb559574a5e4dc4c44c4950cb722bd4e31c13a5.zip
More updates to the web reporting documentation
-rw-r--r--doc/appendix/guides/web-reports-install.txt31
-rw-r--r--doc/reports/dynamic.txt13
-rw-r--r--doc/server/plugins/index.txt2
-rw-r--r--doc/server/plugins/statistics/reporting.txt18
4 files changed, 46 insertions, 18 deletions
diff --git a/doc/appendix/guides/web-reports-install.txt b/doc/appendix/guides/web-reports-install.txt
index 489a7673d..f03bad289 100644
--- a/doc/appendix/guides/web-reports-install.txt
+++ b/doc/appendix/guides/web-reports-install.txt
@@ -7,9 +7,9 @@
.. _appendix-guides-web-reports-install:
-==================================
-Dynamic (web) Reports installation
-==================================
+========================
+Web Reporting Quickstart
+========================
You need to install the bcfg2-web package that is available for your
particular distribution. All packages for Fedora are in the Fedora
@@ -23,14 +23,17 @@ The same packages are needed for Debian/Ubuntu systems::
[root@system01 ~]# aptitude install bcfg2-web
-Add DBStats to the plugins line of ``bcfg2.conf``. The resulting
+Add Reporting to the plugins line of ``bcfg2.conf``. The resulting
**[server]** section should look something like this::
[server]
repository = /var/lib/bcfg2
- plugins = Base,Bundler,Cfg,...,DBStats
+ plugins = Base,Bundler,Cfg,...,Reporting
-You then need to initialize the DBStats reporting database::
+ [reporting]
+ transport = LocalFilesystem
+
+You then need to initialize the reporting database::
[root@system01 ~]# bcfg2-admin reports init
@@ -38,9 +41,11 @@ Start/restart the Bcfg2 server::
[root@system01 ~]# /etc/init.d/bcfg2-server restart
-Run the Bcfg2 client in order to populate the statistics database
-(this run should take a bit longer since you are uploading the client
-statistics to the database).
+Start the Bcfg2 report collector::
+
+ [root@system01 ~]# /etc/init.d/bcfg2-report-collector start
+
+Run the Bcfg2 client in order to populate the statistics database.
Copy server/statistics sections of ``bcfg2.conf`` to
``/etc/bcfg2-web.conf`` (make sure it is world-readable). You should
@@ -48,10 +53,7 @@ then have something like this::
[server]
repository = /var/lib/bcfg2
- plugins = Base,Bundler,Cfg,...,DBStats
-
- [statistics]
- sendmailpath = /usr/lib/sendmail
+ plugins = Base,Bundler,Cfg,...,Reporting
[database]
engine = sqlite3
@@ -65,6 +67,9 @@ then have something like this::
# Not used with sqlite3.
port =
+ [reporting]
+ transport = LocalFilesystem
+
Restart apache and point a browser to your Bcfg2 server.
If using sqlite be sure the sql database file and directory containing
diff --git a/doc/reports/dynamic.txt b/doc/reports/dynamic.txt
index a44beabf3..f268c3b10 100644
--- a/doc/reports/dynamic.txt
+++ b/doc/reports/dynamic.txt
@@ -2,9 +2,9 @@
.. _reports-dynamic:
-==============================
-Bcfg2 Dynamic Reporting System
-==============================
+==========================
+Bcfg2 Web Reporting System
+==========================
Summary and Features
====================
@@ -29,6 +29,11 @@ configuration. Specific features in the new system include:
Installation
============
+Quickstart
+----------
+
+:ref:`appendix-guides-web-reports-install`
+
Prerequisites
-------------
@@ -74,7 +79,7 @@ After configuring your database be sure to run `bcfg2-admin reports init`
to create the schema.
To enable statistics collection in the bcfg2-server, add
-:ref:`Reporting <server-plugins-statistics-reporting>` to the **plugins**
+:ref:`server-plugins-statistics-reporting` to the **plugins**
line in your ``bcfg2.conf`` and restart the bcfg2-server. A report collecting
daemon should be run to import the collected statistics into the backend.
Please see the section :ref:`Report Collector <report_collector>` for more
diff --git a/doc/server/plugins/index.txt b/doc/server/plugins/index.txt
index a98c95e8a..4f2b484ac 100644
--- a/doc/server/plugins/index.txt
+++ b/doc/server/plugins/index.txt
@@ -88,7 +88,7 @@ Statistics Plugins
statistics/*
-DBStats can be enabled by adding it to the plugins line in
+Reporting can be enabled by adding it to the plugins line in
``/etc/bcfg2.conf``.
Version Plugins
diff --git a/doc/server/plugins/statistics/reporting.txt b/doc/server/plugins/statistics/reporting.txt
new file mode 100644
index 000000000..9ada89ff3
--- /dev/null
+++ b/doc/server/plugins/statistics/reporting.txt
@@ -0,0 +1,18 @@
+.. -*- mode: rst -*-
+
+.. _server-plugins-statistics-reporting:
+
+=========
+Reporting
+=========
+
+Reporting can be enabled by adding Reporting to the plugins line in
+``/etc/bcfg2.conf``:
+
+ plugins = Base,Bundler,Cfg,...,Reporting
+
+For more information on how to use Reporting to setup reporting, see
+:ref:`reports-dynamic`.
+
+..Note:
+This replaces the DBStats plugin