From 71a52e143dfa4c98942f3061b725329dbf3c97cc Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 7 Oct 2010 22:13:49 +0000 Subject: doc: Update some documentation from the trac wiki Signed-off-by: Sol Jerome git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@6093 ce84e21b-d406-0410-9b95-82705330c041 --- doc/client/tools/actions.txt | 16 ++++++++++++++ doc/server/plugins/grouping/metadata.txt | 2 +- doc/server/plugins/statistics/dbstats.txt | 6 ++++++ doc/server/plugins/structures/bundler/index.txt | 2 +- doc/server/plugins/version/darcs.txt | 28 +++++++++++++++++++++++++ 5 files changed, 52 insertions(+), 2 deletions(-) create mode 100644 doc/server/plugins/version/darcs.txt (limited to 'doc') diff --git a/doc/client/tools/actions.txt b/doc/client/tools/actions.txt index 6b68164e3..11922b00d 100644 --- a/doc/client/tools/actions.txt +++ b/doc/client/tools/actions.txt @@ -66,3 +66,19 @@ Then a corresponding entry must be included in the Rules directory, like: This allows different clients to get different actions as a part of the same bundle based on group membership. + +Example Action (add APT keys) +============================= + +This example will add the '0C5A2783' for aptitude. It is useful to run +this during the client bootstrap process so that the proper keys are +installed prior to the bcfg2 client trying to install a package which +requires this key. + +.. code-block:: xml + + + + + + diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index 3147e3608..96fc70ff5 100644 --- a/doc/server/plugins/grouping/metadata.txt +++ b/doc/server/plugins/grouping/metadata.txt @@ -108,7 +108,7 @@ Additionally, the following properties can be specified: For detailed information on client authentication see :ref:`authentication` Metadata/groups.xml -------------------- +=================== The ``Metadata/groups.xml`` file contains Group and Profile definitions. Here's a simple ``Metadata/groups.xml`` file: diff --git a/doc/server/plugins/statistics/dbstats.txt b/doc/server/plugins/statistics/dbstats.txt index fed44f11c..8e50df822 100644 --- a/doc/server/plugins/statistics/dbstats.txt +++ b/doc/server/plugins/statistics/dbstats.txt @@ -6,4 +6,10 @@ DBStats ======= +DBStats can be enabled by adding DBStats to the plugins line in +``/etc/bcfg2.conf``: + plugins = DBStats + +For more information on how to use DBStats to setup reporting, see +:ref:`server-reports-dynamic`. diff --git a/doc/server/plugins/structures/bundler/index.txt b/doc/server/plugins/structures/bundler/index.txt index 65c403d06..f7517284d 100644 --- a/doc/server/plugins/structures/bundler/index.txt +++ b/doc/server/plugins/structures/bundler/index.txt @@ -155,7 +155,7 @@ Altsrc ../altsrc Examples --------- +======== In some cases, configuration files need to include the client's hostname in their name. The following template produces such a config file entry. diff --git a/doc/server/plugins/version/darcs.txt b/doc/server/plugins/version/darcs.txt new file mode 100644 index 000000000..98195b30b --- /dev/null +++ b/doc/server/plugins/version/darcs.txt @@ -0,0 +1,28 @@ +.. -*- mode: rst -*- + +.. _server-plugins-version-git: + +===== +Darcs +===== + +This page describes the new Darcs plugin which is experimental. + +Why use the Darcs plugin +======================== + +The Darcs plugin is useful if you would like to track changes to your +Bcfg2 repository using a `Darcs http://darcs.net/`_ backend. Currently, +it enables you to get revision information out of your repository for +reporting purposes. Once the plugin is enabled, every time a client +checks in, it will include the current repository revision in the +reports/statistics. + +How to enable the Darcs plugin +============================== + +You will need to install Darcs on the Bcfg2 server first. Once installed, +simply add Darcs to your plugins line in ``/etc/bcfg2.conf``:: + + [server] + plugins = Base,Bundler,Cfg,...,Darcs -- cgit v1.2.3-1-g7c22