summaryrefslogtreecommitdiffstats
path: root/doc/server
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2014-06-16 15:38:08 -0500
committerSol Jerome <sol.jerome@gmail.com>2014-06-16 15:38:08 -0500
commit1d3ed4665dcdd3a37404a181c3f88055a5af576e (patch)
tree7c99397139f5356499a82833b6f71eb6d4ef408d /doc/server
parent67285919a86c8ffaf7a7ae7cc67e7c831c66ce33 (diff)
downloadbcfg2-1d3ed4665dcdd3a37404a181c3f88055a5af576e.tar.gz
bcfg2-1d3ed4665dcdd3a37404a181c3f88055a5af576e.tar.bz2
bcfg2-1d3ed4665dcdd3a37404a181c3f88055a5af576e.zip
doc: Fix 1.4.0pre1 release notes
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/server')
-rw-r--r--doc/server/caching.txt17
-rw-r--r--doc/server/database.txt38
-rw-r--r--doc/server/encryption.txt3
-rw-r--r--doc/server/plugins/generators/cfg.txt1
-rw-r--r--doc/server/plugins/generators/sshbase.txt3
-rw-r--r--doc/server/plugins/index.txt3
-rw-r--r--doc/server/plugins/probes/index.txt3
-rw-r--r--doc/server/plugins/structures/bundler/index.txt11
-rw-r--r--doc/server/xml-common.txt5
9 files changed, 51 insertions, 33 deletions
diff --git a/doc/server/caching.txt b/doc/server/caching.txt
index 32be684db..3557bf0f3 100644
--- a/doc/server/caching.txt
+++ b/doc/server/caching.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _server-caching:
@@ -42,15 +43,15 @@ descending order of reliability. That is, odds are higher that
biggest speed boost. ``off`` will never result in stale data, but it
gives no speed boost.
-In addition to the :ref:`server-plugins-grouping-metadata` plugin,
-Bcfg2 includes three plugins that can set additional groups, and thus
-may affect the caching behavior. They are
-:ref:`server-plugins-grouping-grouppatterns`,
-:ref:`server-plugins-probes-index`, and
+In addition to the :ref:`server-plugins-grouping-metadata`
+plugin, Bcfg2 includes three plugins that can set additional
+groups, and thus may affect the caching behavior. They
+are :ref:`server-plugins-grouping-grouppatterns`,
+:ref:`server-plugins-probes`, and
:ref:`server-plugins-connectors-puppetenc`. All of those plugins
-**except** for PuppetENC fully support all caching levels. PuppetENC
-is incompatible with ``aggressive``, and may result in some stale data
-with ``cautious``.
+**except** for PuppetENC fully support all caching levels. PuppetENC is
+incompatible with ``aggressive``, and may result in some stale data with
+``cautious``.
If you are not using the PuppetENC plugin, and do not have any custom
plugins that provide additional groups, then all four modes should be
diff --git a/doc/server/database.txt b/doc/server/database.txt
index fdb3ab04c..986914171 100644
--- a/doc/server/database.txt
+++ b/doc/server/database.txt
@@ -10,20 +10,19 @@ Global Database Settings
.. versionadded:: 1.3.0
Several Bcfg2 plugins, including
-:ref:`server-plugins-grouping-metadata`,
-:ref:`server-plugins-probes-index`, and
-:ref:`server-plugins-statistics-reporting`, can connect use a
-relational database to store data. They use the global database
-settings in ``bcfg2.conf``, described in this document, to connect.
+:ref:`server-plugins-grouping-metadata`, :ref:`server-plugins-probes`, and
+:ref:`server-plugins-statistics-reporting`, can connect use a relational
+database to store data. They use the global database settings in
+``bcfg2.conf``, described in this document, to connect.
.. note::
Although SQLite is supported as a database, it may cause
- significant thread contention (and a performance penalty) if you
- use SQLite with :ref:`server-plugins-grouping-metadata` or
- :ref:`server-plugins-probes-index`. If you are using the
- database-backed features of either of those plugins, it's
- recommended that you use a higher performance database backend.
+ significant thread contention (and a performance penalty) if
+ you use SQLite with :ref:`server-plugins-grouping-metadata` or
+ :ref:`server-plugins-probes`. If you are using the database-backed
+ features of either of those plugins, it's recommended that you use
+ a higher performance database backend.
Separate Reporting Database
@@ -31,15 +30,16 @@ Separate Reporting Database
.. versionadded:: 1.4.0
-Bcfg2 supports storing the data generated by the
-:ref:`server-plugins-statistics-reporting` in a separate database
-from the data generated by the other plugins (e.g.
-:ref:`server-plugins-grouping-metadata` and
-:ref:`server-plugins-probes-index`). To activate this support, set
-the ``reporting_engine``, ``reporting_name``, ``reporting_user``, etc.
-options in the ``[database]`` section of the config file. The valid values
-for the ``reporting_*`` options are the same as for the standard database
-options. See :ref:`server-database-configuration-options` for a full listing.
+Bcfg2 supports storing the data generated by the
+:ref:`server-plugins-statistics-reporting` in a separate
+database from the data generated by the other plugins (e.g.
+:ref:`server-plugins-grouping-metadata` and :ref:`server-plugins-probes`).
+To activate this support, set the ``reporting_engine``,
+``reporting_name``, ``reporting_user``, etc. options in the
+``[database]`` section of the config file. The valid values for the
+``reporting_*`` options are the same as for the standard database
+options. See :ref:`server-database-configuration-options` for a full
+listing.
.. _server-database-configuration-options:
diff --git a/doc/server/encryption.txt b/doc/server/encryption.txt
index b657deb8c..db5e2ae29 100644
--- a/doc/server/encryption.txt
+++ b/doc/server/encryption.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _server-encryption:
@@ -54,7 +55,7 @@ In general, Properties encryption is preferred for a few reasons:
Other types of data that can be encrypted are:
* Text content of Path tags in
- :ref:`server-plugins-structures-bundler-index`
+ :ref:`server-plugins-structures-bundler`
* Passphrases in XML description files for generated
:ref:`server-plugins-generators-cfg-sshkeys`
diff --git a/doc/server/plugins/generators/cfg.txt b/doc/server/plugins/generators/cfg.txt
index 7a404c824..9ebbd2666 100644
--- a/doc/server/plugins/generators/cfg.txt
+++ b/doc/server/plugins/generators/cfg.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _server-plugins-generators-cfg:
diff --git a/doc/server/plugins/generators/sshbase.txt b/doc/server/plugins/generators/sshbase.txt
index 4578d5810..540cc1e06 100644
--- a/doc/server/plugins/generators/sshbase.txt
+++ b/doc/server/plugins/generators/sshbase.txt
@@ -162,6 +162,9 @@ in order to permit :ref:`pulling with bcfg2-admin
<server-admin-pull>`. You should almost certainly set ``sensitive``
to "true" in ``info.xml``.
+
+.. _server-plugins-generators-sshbase-encryption:
+
Encryption
==========
diff --git a/doc/server/plugins/index.txt b/doc/server/plugins/index.txt
index f3d6daa73..b39be0786 100644
--- a/doc/server/plugins/index.txt
+++ b/doc/server/plugins/index.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _server-plugins-index:
@@ -13,7 +14,7 @@ perform one of several tasks:
#. Generating configuration entry contents for clients
#. Probing client-side state (like hardware inventory, etc)
-- the generic client probing mechanism is described at
- :ref:`server-plugins-probes-index`.
+ :ref:`server-plugins-probes`.
#. Automating administrative tasks
(e.g. :ref:`server-plugins-generators-sshbase` which automates ssh
key management)
diff --git a/doc/server/plugins/probes/index.txt b/doc/server/plugins/probes/index.txt
index 2e23c31d5..091c85e63 100644
--- a/doc/server/plugins/probes/index.txt
+++ b/doc/server/plugins/probes/index.txt
@@ -1,6 +1,7 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
-.. _server-plugins-probes-index:
+.. _server-plugins-probes:
======
Probes
diff --git a/doc/server/plugins/structures/bundler/index.txt b/doc/server/plugins/structures/bundler/index.txt
index 5bcf467e7..31faeaf17 100644
--- a/doc/server/plugins/structures/bundler/index.txt
+++ b/doc/server/plugins/structures/bundler/index.txt
@@ -1,7 +1,7 @@
.. -*- mode: rst -*-
.. vim: ft=rst
-.. _server-plugins-structures-bundler-index:
+.. _server-plugins-structures-bundler:
=======
Bundler
@@ -92,6 +92,9 @@ split these entries into two bundles. See
:ref:`server-plugins-structures-bundler-bcfg2-server` for an example
of this.
+
+.. _server-plugins-structures-bundler-index-disabling-magic:
+
Disabling Magic
---------------
@@ -112,6 +115,9 @@ entries in independent bundles are only executed if ``when="always"``.
(I.e., an Action entry in an independent bundle with
``when="modified"`` is useless.)
+
+.. _server-plugins-structures-bundler-index-genshi-templates:
+
Genshi templates
================
@@ -139,6 +145,9 @@ entries in the bundle.
See :ref:`bcfg2-info <server-bcfg2-info>` for more details.
+
+.. _server-plugins-structures-bundler-index-dependencies:
+
Dependencies
============
diff --git a/doc/server/xml-common.txt b/doc/server/xml-common.txt
index ab558c2cb..5302a59e4 100644
--- a/doc/server/xml-common.txt
+++ b/doc/server/xml-common.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _xml-features:
@@ -76,7 +77,7 @@ Or, more compactly:
Manage the abstract service "bar"
As an example, consider the following :ref:`bundle
-<server-plugins-structures-bundler-index>`:
+<server-plugins-structures-bundler>`:
.. code-block:: xml
@@ -309,7 +310,7 @@ Feature Matrix
| <server-plugins-misc-acl>` | | | | |
+---------------------------------------------------+--------------+--------+------------+------------+
| :ref:`Bundler | Yes | Yes | Yes | Yes |
-| <server-plugins-structures-bundler-index>` | | | | |
+| <server-plugins-structures-bundler>` | | | | |
+---------------------------------------------------+--------------+--------+------------+------------+
| :ref:`info.xml <server-info>` | Yes [#f1]_ | Yes | Yes | Yes |
+---------------------------------------------------+--------------+--------+------------+------------+