From adc41302e8d06600d8dbd05c2d5771bd95c957f2 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Thu, 17 Feb 2011 11:50:12 -0600 Subject: doc: Remove unnecessary shell invocation (Reported by Jonathan Billings) Signed-off-by: Sol Jerome --- doc/server/plugins/probes/current-kernel.txt | 2 -- 1 file changed, 2 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/probes/current-kernel.txt b/doc/server/plugins/probes/current-kernel.txt index f057f189b..748b56ecc 100644 --- a/doc/server/plugins/probes/current-kernel.txt +++ b/doc/server/plugins/probes/current-kernel.txt @@ -9,7 +9,5 @@ Probe the currently running kernel. .. code-block:: sh - #!/bin/sh - # # PROBE_NAME : current-kernel echo `uname -r` -- cgit v1.2.3-1-g7c22 From cebc13ad35a2c63ba7cf1374d60a32beaa01f275 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Mon, 21 Feb 2011 13:34:58 -0600 Subject: POSIX: Implement recursive attribute for nonexistent Paths The POSIX client tool now has the ability to recursively remove the contents of a specified directory provided there are no other managed entries under the directory. Signed-off-by: Sol Jerome --- doc/server/configurationentries.txt | 2 +- doc/server/plugins/generators/rules.txt | 19 +++++++++++-------- 2 files changed, 12 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/server/configurationentries.txt b/doc/server/configurationentries.txt index 8741e56f5..6e6ab79f7 100644 --- a/doc/server/configurationentries.txt +++ b/doc/server/configurationentries.txt @@ -87,7 +87,7 @@ necessary for the Path type specified. | | | applies to only | | | | | YUMng) | | +-------------+----------------------+-----------------+--------------------------+ -| nonexistent | New | Specify a path | name | +| nonexistent | New | Specify a path | name, recursive | | | | that should not | | | | | exist | | +-------------+----------------------+-----------------+--------------------------+ diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index fe60a24fd..c3c4b61c4 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -251,14 +251,17 @@ hardlink nonexistent ^^^^^^^^^^^ -+------+--------------------+-------------+ -| Name | Description | Values | -+======+====================+=============+ -| name | Name of the | String | -| | (nonexistent) file | | -+------+--------------------+-------------+ -| type | Type of file | nonexistent | -+------+--------------------+-------------+ ++-----------+--------------------+-------------+ +| Name | Description | Values | ++===========+====================+=============+ +| name | Name of the | String | +| | (nonexistent) file | | ++-----------+--------------------+-------------+ +| type | Type of file | nonexistent | ++-----------+--------------------+-------------+ +| recursive | Recursively remove | true | +| | directory contents | | ++-----------+--------------------+-------------+ permissions ^^^^^^^^^^^ -- cgit v1.2.3-1-g7c22 From 086ff1838634a6b1358234d5c9ba9db295901828 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 24 Feb 2011 10:43:54 -0500 Subject: Service: Allow services that are both supervised and custom (Ticket #979) --- doc/server/plugins/generators/rules.txt | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index c3c4b61c4..cff78a8ee 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -119,7 +119,7 @@ Service Tag +------------+--------------------------+---------------------------------------+ | Name | Description | Values | +============+==========================+=======================================+ -| mode | Per Service Mode (New in | (manual|default|supervised|custom) | +| mode | Per Service Mode (New in | (manual|default|supervised) | | | 1.0) | | +------------+--------------------------+---------------------------------------+ | name | Service Name | String | @@ -129,10 +129,8 @@ Service Tag | | off). | | +------------+--------------------------+---------------------------------------+ | target | Service command for | String | -| | restart, modified | | -| | targets require | | -| | mode="custom" | | -| | (default: restart) | | +| | restart (default: | | +| | restart) | | +------------+--------------------------+---------------------------------------+ | type | Driver to use on the | (chkconfig|deb|rc-update|smf|upstart) | | | client to manage this | | @@ -165,11 +163,6 @@ Service mode descriptions * default and ensure service is running (or stopped) when verification is performed * deprecates supervised='true' -* custom - - * set non-default service command for restart (use in conjunction with - target attribute) - Client Tag ---------- -- cgit v1.2.3-1-g7c22 From 1dcb73e1a06d3a558b498ec5d5a47ff562254b7d Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 26 Feb 2011 13:27:35 -0600 Subject: Bundler: Add support for genshi .xml bundles This commit modifies the Bundler plugin to allow for genshi templates with .xml file extensions via the xml namespace (Resolves ticket #861). Signed-off-by: Sol Jerome --- doc/server/plugins/structures/bundler/index.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/server/plugins/structures/bundler/index.txt b/doc/server/plugins/structures/bundler/index.txt index e5682ac00..0d0054a2c 100644 --- a/doc/server/plugins/structures/bundler/index.txt +++ b/doc/server/plugins/structures/bundler/index.txt @@ -105,13 +105,16 @@ how group entries can be used in bundles) Genshi templates ================ -Genshi templates are used by adding a Genshi xml-style template to the -Bundler directory with a ``.genshi`` file extension. Version 0.4 or newer -of genshi is required. +Genshi xml templates can be specified one of two ways: -.. important:: The ``.genshi`` file extension is required in order for the - server to know that the Bundle should be rendered using - Genshi. +1. Add an xml-style genshi template to the Bundler directory with a + ``.genshi`` and the associated namespace attribute. +2. Simply add the appropriate namespace attribute to your existing xml + bundle. + +The namespace attribute in this case should look like the following:: + + xmlns:py="http://genshi.edgewall.org/" Motivation ---------- -- cgit v1.2.3-1-g7c22 From 1ec391ab8a1fb35bf36d25d30ee165f1af179af0 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 26 Feb 2011 13:37:55 -0600 Subject: doc: Fix broken references Signed-off-by: Sol Jerome --- doc/appendix/guides/fedora.txt | 5 ++--- doc/appendix/guides/ubuntu.txt | 4 ++-- doc/client/tools.txt | 2 +- doc/getting_started/index.txt | 2 +- doc/help/faq/general.txt | 2 +- doc/server/plugins/grouping/metadata.txt | 3 ++- doc/server/plugins/statistics/dbstats.txt | 2 +- doc/server/snapshots/index.txt | 4 ++-- doc/unsorted/howtos.txt | 4 ++-- 9 files changed, 14 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/appendix/guides/fedora.txt b/doc/appendix/guides/fedora.txt index f32eaa8c6..4e3244eaa 100644 --- a/doc/appendix/guides/fedora.txt +++ b/doc/appendix/guides/fedora.txt @@ -252,9 +252,8 @@ Add a probe The next step for the client will be to have the proper arch group membership. For this, we will make use of the -:ref:`server-plugins-grouping-dynamic_groups` capabilities of -the Probes plugin. Add **Probes** to your plugins line in ``bcfg2.conf`` -and create the Probe: +:ref:`unsorted-dynamic_groups` capabilities of the Probes plugin. Add +**Probes** to your plugins line in ``bcfg2.conf`` and create the Probe: .. code-block:: sh diff --git a/doc/appendix/guides/ubuntu.txt b/doc/appendix/guides/ubuntu.txt index e22707f2c..24338c6d2 100644 --- a/doc/appendix/guides/ubuntu.txt +++ b/doc/appendix/guides/ubuntu.txt @@ -201,7 +201,7 @@ should look something like this The last thing we need is for the client to have the proper arch group membership. For this, we will make use of the -:ref:`server-plugins-grouping-dynamic_groups` capabilities of the Probes plugin. Add +:ref:`unsorted-dynamic_groups` capabilities of the Probes plugin. Add Probes to your plugins line in ``bcfg2.conf`` and create the Probe. .. code-block:: sh @@ -484,7 +484,7 @@ Now we run the client and see there are no more unmanaged entries! :: Dynamic (web) reports ===================== -See installation instructions at :ref:`server-reports-install` +See installation instructions at :ref:`appendix-guides-web-reports-install` Upstart ======= diff --git a/doc/client/tools.txt b/doc/client/tools.txt index 676feb175..d9a9b76f4 100644 --- a/doc/client/tools.txt +++ b/doc/client/tools.txt @@ -14,7 +14,7 @@ management. The POSIX tool also handles file system and permissions/groups operations. To write your own tool driver, to handle a new packaging format, or new -service architecture see :ref:`development-index-writingtooldrivers` +service architecture see :ref:`development-client-driver` When the Bcfg2 client is run, it attempts to instantiate each of these drivers. The succeeding list of drivers are printed as a debug message diff --git a/doc/getting_started/index.txt b/doc/getting_started/index.txt index 9661fcb89..b256edd2d 100644 --- a/doc/getting_started/index.txt +++ b/doc/getting_started/index.txt @@ -234,7 +234,7 @@ Next Steps Several other utilities can help from this point on: -:ref:`bcfg2-info ` is a utility that +:ref:`bcfg2-info ` is a utility that instantiates a copy of the bcfg2 server core (minus the networking code) for examination. From this, you can directly query: diff --git a/doc/help/faq/general.txt b/doc/help/faq/general.txt index 0534e72d2..f8ecc9854 100644 --- a/doc/help/faq/general.txt +++ b/doc/help/faq/general.txt @@ -17,7 +17,7 @@ cubic feet of gas. Bcfg2 should run on any POSIX compatible operating system, however direct support for an operating system's package and service formats are limited -by the currently available :ref:`client-tools-index` (although new client +by the currently available :ref:`client-tools` (although new client tools are pretty easy to add). The following is an incomplete but more exact list of platforms on which Bcfg2 works. diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index f215e6cc5..1c915e2cf 100644 --- a/doc/server/plugins/grouping/metadata.txt +++ b/doc/server/plugins/grouping/metadata.txt @@ -105,7 +105,8 @@ Additionally, the following properties can be specified: | | resolution. | | +----------+----------------------------------------+----------------+ -For detailed information on client authentication see :ref:`authentication` +For detailed information on client authentication see +:ref:`appendix-guides-authentication` Metadata/groups.xml =================== diff --git a/doc/server/plugins/statistics/dbstats.txt b/doc/server/plugins/statistics/dbstats.txt index dd25fe9ab..7f59b1ce7 100644 --- a/doc/server/plugins/statistics/dbstats.txt +++ b/doc/server/plugins/statistics/dbstats.txt @@ -12,4 +12,4 @@ DBStats can be enabled by adding DBStats to the plugins line in plugins = Base,Bundler,Cfg,...,DBStats For more information on how to use DBStats to setup reporting, see -:ref:`server-reports-dynamic`. +:ref:`reports-dynamic`. diff --git a/doc/server/snapshots/index.txt b/doc/server/snapshots/index.txt index ca8af2663..13a9fe2c0 100644 --- a/doc/server/snapshots/index.txt +++ b/doc/server/snapshots/index.txt @@ -9,8 +9,8 @@ Bcfg2 Snapshots .. versionadded:: 1.0.0 This page describes the Snapshots plugin. This plugin is meant to replace -the older :ref:`server-reports-dynamic`. It stores various -aspects of a client's state when the client checks into the server. +the older :ref:`reports-dynamic`. It stores various aspects of a client's +state when the client checks into the server. Before you begin ================ diff --git a/doc/unsorted/howtos.txt b/doc/unsorted/howtos.txt index 31e41ab75..4347632f6 100644 --- a/doc/unsorted/howtos.txt +++ b/doc/unsorted/howtos.txt @@ -8,10 +8,10 @@ HOWTOs Here are several howtos that describe different aspects of Bcfg2 deployment -* :ref:`authentication` - a description of the Bcfg2 authentication infrastructure +* :ref:`appendix-guides-authentication` - a description of the Bcfg2 authentication infrastructure * AnnotatedExamples - a description of basic Bcfg2 specification operations * BuildingDebianPackages - How to build debian packages -* :ref:`unsorted-gentoo` - Issues specific to running Bcfg2 on Gentoo +* :ref:`appendix-guides-gentoo` - Issues specific to running Bcfg2 on Gentoo * :ref:`server-plugins-generators-tcheetah` - Howto use the TCheetah template plugin * :ref:`server-plugins-generators-hostbase` - How to use the Hostbase plugin and web interface * :ref:`server-plugins-probes-index` - How to use Probes to gather information from a client machine. -- cgit v1.2.3-1-g7c22 From 4fd8b9486eac208c18925fa103b2360fded7a125 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Tue, 1 Mar 2011 14:25:42 -0600 Subject: doc: Document info capabilities (reported by mkd on irc) It is possible to use tags in info.xml files (in addition to tags). Signed-off-by: Sol Jerome --- doc/server/info.txt | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/server/info.txt b/doc/server/info.txt index 0adf8ce51..231a83a52 100644 --- a/doc/server/info.txt +++ b/doc/server/info.txt @@ -79,10 +79,11 @@ specification. info.xml files ============== -``info.xml`` files add the ability to specify different sets of file -metadata on a group by group basis. These files are XML, and work -similarly to those used by :ref:`Rules ` -or :ref:`Pkgmgr `. +``info.xml`` files add the ability to specify different +sets of file metadata on a group by group or host by host +basis. These files are XML, and work similarly to those used by +:ref:`Rules ` or :ref:`Pkgmgr +`. The following specifies a different global set of permissions (root/sys/0651) than on clients in group webserver (root/root/0652) @@ -90,6 +91,9 @@ The following specifies a different global set of permissions .. code-block:: xml + + + -- cgit v1.2.3-1-g7c22 From 73a4e8648c501437b3b1f4bd95e9c4023da9b681 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 2 Mar 2011 15:38:42 -0600 Subject: doc: Fix broken link to NagiosGen Signed-off-by: Sol Jerome --- doc/server/plugins/generators/nagiosgen.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/server/plugins/generators/nagiosgen.txt b/doc/server/plugins/generators/nagiosgen.txt index 8cd18ca4f..196f1e76b 100644 --- a/doc/server/plugins/generators/nagiosgen.txt +++ b/doc/server/plugins/generators/nagiosgen.txt @@ -8,7 +8,7 @@ NagiosGen This page describes the installation and use of the `NagiosGen`_ plugin. -.. _NagiosGen: http://trac.mcs.anl.gov/projects/bcfg2/browser/trunk/bcfg2/src/lib/Server/Plugins/NagiosGen.py +.. _NagiosGen: http://trac.mcs.anl.gov/projects/bcfg2/browser/src/lib/Server/Plugins/NagiosGen.py Update ``/etc/bcfg2.conf``, adding NagiosGen to plugins:: -- cgit v1.2.3-1-g7c22