diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/client/modes.txt | 23 | ||||
| -rw-r--r-- | doc/client/tools/actions.txt | 68 | ||||
| -rw-r--r-- | doc/server/plugins/generators/rules.txt | 2 | ||||
| -rw-r--r-- | doc/unsorted/howtos.txt | 17 | ||||
| -rw-r--r-- | doc/unsorted/index.txt | 1 |
5 files changed, 98 insertions, 13 deletions
diff --git a/doc/client/modes.txt b/doc/client/modes.txt index 55aec34e7..aa5a1c2ac 100644 --- a/doc/client/modes.txt +++ b/doc/client/modes.txt @@ -20,6 +20,8 @@ Interactive mode The client can be run interactively (-I) so that you are able to step through each operation in order to see what the client is doing. +.. _client-modes-paranoid: + Paranoid mode ============= @@ -46,8 +48,10 @@ by _'s. For example, the old ``/etc/hosts`` will be named Extra configuration ------------------- -Here is an example of how to use the extra paranoid features available -in 1.0. For the following section in ``bcfg2.conf``:: +.. versionadded:: 1.0.0 + +Here is an example of how to use some of the extra paranoid features +available. For the following section in ``bcfg2.conf`` (client-side):: [paranoid] path = /my/custom/backup/path @@ -56,6 +60,21 @@ in 1.0. For the following section in ``bcfg2.conf``:: You will have the file backups store in ``/my/custom/backup/path``. This will also keep the five most recent backups of files. +Altering the global metadata to enable paranoid mode for all files +------------------------------------------------------------------ + +You may also want to just globally enable the *paranoid* attribute for +all files distributed to clients from your Bcfg2 server. You can +accomplish this by adding a global metadata override in your +``bcfg2.conf`` (server-side) with the following syntax:: + + [mdata] + paranoid=true + +This will override the default value of "paranoid=false" and change it to +"true" which will cause every file you add or update in your Bcfg2 repo +to backup on the client as specified in your client config. + Overall client service mode =========================== diff --git a/doc/client/tools/actions.txt b/doc/client/tools/actions.txt new file mode 100644 index 000000000..6b68164e3 --- /dev/null +++ b/doc/client/tools/actions.txt @@ -0,0 +1,68 @@ +.. -*- mode: rst -*- + +.. _client-tools-actions: + +======= +Actions +======= + +This page describes use of the Action configuration entry. Action entries +are commands that are executed either before bundle installation, +after bundle installation or both. If exit status is observed, a +failing pre-action will cause no modification of the enclosing bundle +to be performed; all entries in included in that bundle will not be +modified. Failing actions are reported through Bcfg2's reporting system, +so they can be centrally observed. Actions look like: + +.. code-block:: xml + + <Action timing='pre|post|both' + name='name' + command='cmd text' + when='always|modified' + status='ignore|check'/> + ++-----------+------------------+-------------------------------------------+ +| Attribute | Values | Meaning | ++===========+==================+===========================================+ +| timing | pre, post, both | When the action is run | ++-----------+------------------+-------------------------------------------+ +| name | freeform | action name | ++-----------+------------------+-------------------------------------------+ +| command | freeform | command text | ++-----------+------------------+-------------------------------------------+ +| when | always, modified | If the action is always run, or only when | +| | | a bundle should be or has been modified | ++-----------+------------------+-------------------------------------------+ +| status | ignore, check | If the return code of the action | +| | | should be reported or not | ++-----------+------------------+-------------------------------------------+ + +Note that the status attribute tells the bcfg2 client to ignore +return status, causing failures to still not be centrally reported. If +central reporting of action failure is desired, set this attribute to +'check'. Also note that Action entries included in Base will not be +executed. + +Actions cannot be completely defined inside of a bundle; they are a bound +entry, much like Packages, Services or Paths. The Rules plugin can bind +these entries. For example to include the above action in a bundle, +first the Action entry must be included in the bundle: + +.. code-block:: xml + + <Bundle name='bundle_name'> + ... + <Action name='action_name'/> + </Bundle> + +Then a corresponding entry must be included in the Rules directory, like: + +.. code-block:: xml + + <Rules priority='0'> + <Action timing='post' when='modified' name='action_name' command='/path/to/command arg1 arg2' status='ignore'/> + </Rules> + +This allows different clients to get different actions as a part of the +same bundle based on group membership. diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index fb2b07cc4..1ca66b9a0 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -111,7 +111,7 @@ The Package Tag may have the following attributes: Action Tag ---------- -See [wiki:Plugins/Actions Actions] +See :ref:`client-tools-actions` Service Tag ----------- diff --git a/doc/unsorted/howtos.txt b/doc/unsorted/howtos.txt index b81f17130..31e41ab75 100644 --- a/doc/unsorted/howtos.txt +++ b/doc/unsorted/howtos.txt @@ -8,14 +8,13 @@ HOWTOs Here are several howtos that describe different aspects of Bcfg2 deployment -* [wiki:Authentication] - a description of the Bcfg2 authentication infrastructure +* :ref:`authentication` - a description of the Bcfg2 authentication infrastructure * AnnotatedExamples - a description of basic Bcfg2 specification operations -* EncapPackages, EncapReadme, EncapInstall, EncapHowto - building encap packages * BuildingDebianPackages - How to build debian packages -* [wiki:Gentoo] - Issues specific to running Bcfg2 on Gentoo -* [wiki:Plugins/TCheetah TCheetah] - Howto use the TCheetah template plugin -* [wiki:Hostbase] - How to use the Hostbase plugin and web interface -* [wiki:Plugins/Probes Probes] - How to use Probes to gather information from a client machine. -* [wiki:Plugins/Actions Actions] - How to use the new Action facility in Bcfg2-0.9.0 -* [wiki:DynamicGroups] - Using new dynamic groups in Bcfg2-0.9.0 -* [wiki:ParanoidMode] - How to run an update in paranoid mode +* :ref:`unsorted-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. +* :ref:`client-tools-actions` - How to use Actions +* :ref:`unsorted-dynamic_groups` - Using dynamic groups +* :ref:`client-modes-paranoid` - How to run an update in paranoid mode diff --git a/doc/unsorted/index.txt b/doc/unsorted/index.txt index f2e5f52fd..8e079de10 100644 --- a/doc/unsorted/index.txt +++ b/doc/unsorted/index.txt @@ -14,7 +14,6 @@ list below. .. _TitleIndex: https://trac.mcs.anl.gov/projects/bcfg2/wiki/TitleIndex * `ManualPages` -* `Plugins/Actions` * `Plugins/Ohai` * `Plugins/Snapshots` * `PrecompiledPackages` |