summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/appendix/guides/fedora.txt5
-rw-r--r--doc/appendix/guides/ubuntu.txt4
-rw-r--r--doc/client/tools.txt2
-rw-r--r--doc/getting_started/index.txt2
-rw-r--r--doc/help/faq/general.txt2
-rw-r--r--doc/server/configurationentries.txt2
-rw-r--r--doc/server/info.txt12
-rw-r--r--doc/server/plugins/generators/nagiosgen.txt2
-rw-r--r--doc/server/plugins/generators/rules.txt32
-rw-r--r--doc/server/plugins/grouping/metadata.txt3
-rw-r--r--doc/server/plugins/probes/current-kernel.txt2
-rw-r--r--doc/server/plugins/statistics/dbstats.txt2
-rw-r--r--doc/server/plugins/structures/bundler/index.txt15
-rw-r--r--doc/server/snapshots/index.txt4
-rw-r--r--doc/unsorted/howtos.txt4
15 files changed, 47 insertions, 46 deletions
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 <appendix-guides-using_bcfg2_info>` is a utility that
+:ref:`bcfg2-info <server-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/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/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 <server-plugins-generators-rules>`
-or :ref:`Pkgmgr <server-plugins-generators-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 <server-plugins-generators-rules>` or :ref:`Pkgmgr
+<server-plugins-generators-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
<FileInfo>
+ <Client name='foo.example.com'>
+ <Info owner='root' group='root' perms='0652'/>
+ </Client>
<Group name='webserver'>
<Info owner='root' group='root' perms='0652'/>
</Group>
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::
diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt
index fe60a24fd..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
----------
@@ -251,14 +244,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
^^^^^^^^^^^
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/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`
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/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
----------
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.
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-09-24 22:30:48 +0000