summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2011-09-19 11:04:03 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2011-09-19 11:04:03 -0400
commitfe9b75662276326898458a68744b920ebd9d46b8 (patch)
tree999cf9ca885d38e23305408b37ff0b662686832d /doc
parente6489338056d55805a66383bcd5cda6ed8caa22b (diff)
downloadbcfg2-fe9b75662276326898458a68744b920ebd9d46b8.tar.gz
bcfg2-fe9b75662276326898458a68744b920ebd9d46b8.tar.bz2
bcfg2-fe9b75662276326898458a68744b920ebd9d46b8.zip
added Defaults plugin
Diffstat (limited to 'doc')
-rw-r--r--doc/server/plugins/generators/rules.txt70
-rw-r--r--doc/server/plugins/structures/defaults.txt31
2 files changed, 57 insertions, 44 deletions
diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt
index b74c37a39..925ee6419 100644
--- a/doc/server/plugins/generators/rules.txt
+++ b/doc/server/plugins/generators/rules.txt
@@ -115,29 +115,29 @@ See :ref:`client-tools-actions`
Service Tag
-----------
-+------------+-------------------------------+-----------------------------------------------------+
-| Name | Description | Values |
-+============+===============================+=====================================================+
-| mode | Per Service Mode (New in 1.0) | (manual | default | supervised | interactive_only ) |
-+------------+-------------------------------+-----------------------------------------------------+
-| name | Service name or regular | String or regex |
-| | expression | |
-+------------+-------------------------------+-----------------------------------------------------+
-| status | Should the service be on or | (on | off | ignore) |
-| | off (default: off). | |
-+------------+-------------------------------+-----------------------------------------------------+
-| target | Service command for restart | String |
-| | (default: restart) | |
-+------------+-------------------------------+-----------------------------------------------------+
-| type | Driver to use on the client | (chkconfig | deb | rc-update | smf | upstart) |
-| | to manage this service. | |
-+------------+-------------------------------+-----------------------------------------------------+
-| sequence | Order for service startup | integer |
-| | (debian services only) | |
-+------------+-------------------------------+-----------------------------------------------------+
-| parameters | Pass parameters to service | String |
-| | (Upstart services only) | |
-+------------+-------------------------------+-----------------------------------------------------+
++------------+-------------------------------+---------------------------------------------------------+
+| Name | Description | Values |
++============+===============================+=========================================================+
+| mode | Per Service Mode (New in 1.0) | (manual | default | supervised | interactive_only ) |
++------------+-------------------------------+---------------------------------------------------------+
+| name | Service name or regular | String or regex |
+| | expression | |
++------------+-------------------------------+---------------------------------------------------------+
+| status | Should the service be on or | (on | off | ignore) |
+| | off (default: off). | |
++------------+-------------------------------+---------------------------------------------------------+
+| target | Service command for restart | String |
+| | (default: restart) | |
++------------+-------------------------------+---------------------------------------------------------+
+| type | Driver to use on the client | (chkconfig | deb | rc-update | smf | upstart | |
+| | to manage this service. | systemd | freebsd | launchd ) |
++------------+-------------------------------+---------------------------------------------------------+
+| sequence | Order for service startup | integer |
+| | (debian services only) | |
++------------+-------------------------------+---------------------------------------------------------+
+| parameters | Pass parameters to service | String |
+| | (Upstart services only) | |
++------------+-------------------------------+---------------------------------------------------------+
Service mode descriptions
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -354,30 +354,12 @@ how to assign Rules to a host's literal configuration.
Using Regular Expressions in Rules
==================================
-The ``name`` attribute in Rules supports the use of regular expressions
-to match multiple abstract configuration entries. For instance, to
-make all Service entries use the ``systemd`` tool on Fedora 15 and the
-``chkconfig`` tool on Fedora 14, you could do the following.
-
-.. code-block:: xml
-
- <Rules priority="0">
- <Group name="fedora-15">
- <Service name=".*" type="systemd"/>
- </Group>
- <Group name="fedora-14">
- <Service name=".*" type="chkconfig"/>
- </Group>
- </Rules>
+The ``name`` attribute in Rules supports the use of regular
+expressions to match multiple abstract configuration entries.
Regular expressions are anchored at both ends, so ``<Service
name="bcfg2".../>`` will *not* match a Service named ``bcfg2-server``;
you'd have to explicitly specify ``<Service name="bcfg2.*".../>``.
Note that only one Rule can apply to any abstract entry, so you cannot
-specify multiple regexs to match the same rule. In the use case
-above, you would have to specify the services fully (except for type)
-in the bundles.
-
-Attributes specified in a bundle have precedence over attributes
-specified in Rules, so you can use Rules to set defaults.
+specify multiple regexs to match the same rule.
diff --git a/doc/server/plugins/structures/defaults.txt b/doc/server/plugins/structures/defaults.txt
new file mode 100644
index 000000000..58b9feddb
--- /dev/null
+++ b/doc/server/plugins/structures/defaults.txt
@@ -0,0 +1,31 @@
+.. -*- mode: rst -*-
+
+.. _server-plugins-structures-defaults:
+
+==========
+ Defaults
+==========
+
+The Defaults plugin can be used to populate default attributes for
+entries. Defaults is *not* a Generator plugin, so it does not
+actually bind an entry; Defaults are applied after an entry has been
+bound, and only populate attributes that are not yet set.
+
+Like :ref:`server-plugins-generators-rules`, Defaults supports regular
+expressions in the name attribute.
+
+For instance, to make all Service entries use the ``systemd`` tool
+on Fedora 15 and the ``chkconfig`` tool on Fedora 14, you could do::
+
+ <Defaults priority="0">
+ <Group name="fedora-15">
+ <Service name=".*" type="systemd"/>
+ </Group>
+ <Group name="fedora-14">
+ <Service name=".*" type="chkconfig"/>
+ </Group>
+ </Defaults>
+
+If you were to specify a ``type`` attribute for a Service entry in
+Rules (or a ``type`` attribute for a BoundService entry in Bundler),
+that would take precendence over the default.