summaryrefslogtreecommitdiffstats
path: root/doc
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
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')
-rw-r--r--doc/client/metadata.txt13
-rw-r--r--doc/conf.py4
-rw-r--r--doc/development/caching.txt5
-rw-r--r--doc/development/plugins.txt6
-rw-r--r--doc/exts/xmlschema.py4
-rw-r--r--doc/getting_started/index.txt2
-rw-r--r--doc/releases/1.4.0pre1.txt50
-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
-rw-r--r--doc/unsorted/howtos.txt2
17 files changed, 94 insertions, 76 deletions
diff --git a/doc/client/metadata.txt b/doc/client/metadata.txt
index 27870ba9a..0dec5e3a7 100644
--- a/doc/client/metadata.txt
+++ b/doc/client/metadata.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _client-metadata:
@@ -24,12 +25,12 @@ interaction:
This construction process spans several server plugins. The
:ref:`server-plugins-grouping-metadata` is responsible for
initial instance creation, including the client hostname,
-profile, and basic group memberships. After this initial creation,
-Connector plugins (such as :ref:`server-plugins-probes-index` or
-:ref:`server-plugins-connectors-properties`) can add additional group
-memberships for clients. These memberships are merged into the instance;
-that is, the new group memberships are treated as if they were included
-in groups.xml. If any of these groups are defined in groups.xml,
+profile, and basic group memberships. After this initial
+creation, Connector plugins (such as :ref:`server-plugins-probes`
+or :ref:`server-plugins-connectors-properties`) can add additional
+group memberships for clients. These memberships are merged into the
+instance; that is, the new group memberships are treated as if they were
+included in groups.xml. If any of these groups are defined in groups.xml,
then groups included there are included in the ClientMetadata instance
group list. At the end of this process, the ClientMetadata instance has
its complete set of group memberships. At this point, each connector
diff --git a/doc/conf.py b/doc/conf.py
index 1da6b3b01..1b19d92c7 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -64,9 +64,9 @@ else:
# built documents.
#
# The short X.Y version.
-version = '1.4'
+version = '1.3'
# The full version, including alpha/beta/rc tags.
-release = '1.4.0'
+release = '1.3.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/doc/development/caching.txt b/doc/development/caching.txt
index 47d627278..83ec0290f 100644
--- a/doc/development/caching.txt
+++ b/doc/development/caching.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _development-cache:
@@ -44,10 +45,10 @@ Currently known caches are:
| Metadata | Hostname | :class:`ClientMetadata | The :ref:`Metadata cache <server-caching>` |
| | | <Bcfg2.Server.Plugins.Metadata.ClientMetadata>` | |
+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Probes, | Hostname | ``list`` of group names | Groups set by :ref:`server-plugins-probes-index` |
+| Probes, | Hostname | ``list`` of group names | Groups set by :ref:`server-plugins-probes` |
| probegroups | | | |
+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Probes, | Hostname | ``dict`` of ``<probe name>``: | Other data set by :ref:`server-plugins-probes-index` |
+| Probes, | Hostname | ``dict`` of ``<probe name>``: | Other data set by :ref:`server-plugins-probes` |
| probedata | | :class:`ProbeData | |
| | | <Bcfg2.Server.Plugins.Probes.ProbeData>` | |
+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt
index e4f16b84d..5993c4e29 100644
--- a/doc/development/plugins.txt
+++ b/doc/development/plugins.txt
@@ -1,4 +1,5 @@
.. -*- mode: rst -*-
+.. vim: ft=rst
.. _development-plugins:
@@ -147,9 +148,8 @@ For examples, see:
* :func:`Bcfg2.Server.Plugins.Probes.ReceiveData` takes a copy of the
groups that have been assigned to a client by
- :ref:`server-plugins-probes-index`, and if that data changes when
- new probe data is received, it invalidates the cache for that
- client.
+ :ref:`server-plugins-probes`, and if that data changes when new probe
+ data is received, it invalidates the cache for that client.
* :func:`Bcfg2.Server.Plugins.GroupPatterns.Index` expires the entire
cache whenever a FAM event is received for the
:ref:`server-plugins-grouping-grouppatterns` config file.
diff --git a/doc/exts/xmlschema.py b/doc/exts/xmlschema.py
index c26aed81e..89104c2a6 100644
--- a/doc/exts/xmlschema.py
+++ b/doc/exts/xmlschema.py
@@ -784,7 +784,7 @@ class XMLDomain(Domain):
def clear_doc(self, docname):
to_del = []
for dtype in self.types.keys():
- for key, (doc, _) in self.data[dtype].iteritems():
+ for key, (doc, _) in self.data[dtype].items():
if doc == docname:
to_del.append((dtype, key))
for dtype, key in to_del:
@@ -803,7 +803,7 @@ class XMLDomain(Domain):
def get_objects(self):
for dtype in self.types.keys():
- for name, (docname, tgtid) in self.data[dtype].iteritems():
+ for name, (docname, tgtid) in self.data[dtype].items():
yield (name, name, dtype, docname, tgtid,
self.object_types[dtype].attrs['searchprio'])
diff --git a/doc/getting_started/index.txt b/doc/getting_started/index.txt
index 9b69bf65a..62e804553 100644
--- a/doc/getting_started/index.txt
+++ b/doc/getting_started/index.txt
@@ -223,7 +223,7 @@ you will find that we now have a correct entry::
Done! Now we just have 242 (or more) entries to take care of!
-:ref:`server-plugins-structures-bundler-index` is a
+:ref:`server-plugins-structures-bundler` is a
relatively easy directory to populate. You can find many
samples of Bundles in the :ref:`Bundler Example Repository
<server-plugins-structures-bundler-index-examples>`, many of which can
diff --git a/doc/releases/1.4.0pre1.txt b/doc/releases/1.4.0pre1.txt
index d360588d6..1f92f4665 100644
--- a/doc/releases/1.4.0pre1.txt
+++ b/doc/releases/1.4.0pre1.txt
@@ -27,8 +27,7 @@ backwards-incompatible user-facing changes
reorganized to some degree. ``bcfg2-reports`` syntax is completely
different.
-* Added new ACL plugin
- (http://docs.bcfg2.org/dev/server/plugins/misc/acl.html)
+* Added new :ref:`server-plugins-misc-acl` plugin
Default ACLs only allow clients to perform bcfg2 client runs, and only
permit `bcfg2-admin xcmd` calls from localhost. If you want to change
@@ -36,7 +35,7 @@ backwards-incompatible user-facing changes
* Added genshi requirement for the server
-* Decisions
+* :ref:`server-plugins-generators-decisions`
* Switch plugin to use StructFile instead of host- or group-specific XML
files (this allows a single e.g. whitelist.xml file with <Group> tags)
@@ -48,19 +47,18 @@ backwards-incompatible user-facing changes
deprecated features (will be removed in a future release, likely 1.5)
---------------------------------------------------------------------
-* Bundler
+* :ref:`server-plugins-structures-bundler`
* Deprecated use of an explicit name attribute
- * Deprecated .genshi bundles (use .xml bundles and specify the genshi
- namespace instead)
-
- http://docs.bcfg2.org/dev/server/plugins/structures/bundler/index.html#genshi-templates
+ * Deprecated :ref:`.genshi bundles
+ <server-plugins-structures-bundler-index-genshi-templates>` (use
+ .xml bundles and specify the genshi namespace instead)
* SSLCA
* Deprecated plugin
- * SSLCA functionality has been added to the Cfg plugin.
- http://docs.bcfg2.org/dev/server/plugins/generators/cfg.html#ssl-keys-and-certificates
+ * SSLCA functionality has been added to the Cfg plugin:
+ see :ref:`server-plugins-generators-cfg-ssl-certificates`
deprecated plugins and features which have been removed
-------------------------------------------------------
@@ -97,35 +95,35 @@ Other features
other fixes and new features
----------------------------
-* Added inter-bundle dependencies:
- http://docs.bcfg2.org/dev/server/plugins/structures/bundler/index.html#dependencies
-* Added support for independent bundles (replaces the functionality of
- Base):
- http://docs.bcfg2.org/dev/server/plugins/structures/bundler/index.html#disabling-magic
+* Added :ref:`inter-bundle dependencies
+ <server-plugins-structures-bundler-index-dependencies>`
+* Added support for :ref:`independent bundles
+ <server-plugins-structures-bundler-index-disabling-magic>` (replaces
+ the functionality of Base):
* Added support for wildcard XIncludes
* Add Solaris 11 IPS Package support
* Add bcfg2-report-collector init script to debian package
* Git VCS plugin enhancements
* Removed deprecated plugins
-* Bundler
+* :ref:`server-plugins-structures-bundler`
* Deprecated use of an explicit name attribute
* Deprecated .genshi bundles
* Added path globbing
-* Metadata
+* :ref:`server-plugins-grouping-metadata`
* Allow setting global default authentication type
-* Packages
+* :ref:`server-plugins-generators-packages`
* Add yum group support to internal resolver
* Change location of plugin-generated APT sources
* Add new Pkgng plugin
* Add ability for per-package recommended flag override
-* Reporting
+* :ref:`server-plugins-statistics-reporting`
* Add support for POSIX user/group entries
* Add support for Django > 1.4
@@ -135,11 +133,11 @@ other fixes and new features
* Added option to force server to wait until all FAM events are
processed
-* SSHbase
+* :ref:`server-plugins-generators-sshbase`
* Add support for IPv6 addresses in known_hosts file
- * Add support for encryption of generated ssh keys:
- http://docs.bcfg2.org/dev/server/plugins/generators/sshbase.html#encryption
+ * Add support for :ref:`encryption of generated ssh keys
+ <server-plugins-generators-sshbase-encryption>`
* APT
@@ -153,15 +151,15 @@ other fixes and new features
Existing SSLCA installations will need to migrate to the new format
using ``tools/upgrade/1.4/migrate_sslca.py``.
-* NagiosGen
+* :ref:`server-plugins-generators-nagiosgen`
* Migrate configuration to conf.d
-* Probes
+* :ref:`server-plugins-probes`
* Rewritten to improve caching
- * Add probes.allowed_groups option to restrict group assignments
- (http://docs.bcfg2.org/dev/server/plugins/probes/index.html#dynamic-group-assignment)
+ * Add probes.allowed_groups option to restrict group assignments:
+ see :ref:`server-plugins-probes-dynamic-groups`
Thanks
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 |
+---------------------------------------------------+--------------+--------+------------+------------+
diff --git a/doc/unsorted/howtos.txt b/doc/unsorted/howtos.txt
index cef64a394..81b38e54d 100644
--- a/doc/unsorted/howtos.txt
+++ b/doc/unsorted/howtos.txt
@@ -12,7 +12,7 @@ Here are several howtos that describe different aspects of Bcfg2 deployment
* AnnotatedExamples - a description of basic Bcfg2 specification operations
* BuildingDebianPackages - How to build debian packages
* :ref:`appendix-guides-gentoo` - Issues specific to running Bcfg2 on Gentoo
-* :ref:`server-plugins-probes-index` - How to use Probes to gather information from a client machine.
+* :ref:`server-plugins-probes` - How to use Probes to gather information from a client machine.
* :ref:`client-tools-actions` - How to use Actions
* :ref:`server-plugins-probes-dynamic-groups` - Using dynamic groups
* :ref:`client-modes-paranoid` - How to run an update in paranoid mode