diff options
author | Sol Jerome <solj@ices.utexas.edu> | 2010-03-22 20:17:42 +0000 |
---|---|---|
committer | Sol Jerome <solj@ices.utexas.edu> | 2010-03-22 20:24:54 -0500 |
commit | 030325e0ffc3ab6748b8dc258a9e5a39e055feed (patch) | |
tree | 930f62ec424f94e60c8cd2f2a78c3bc575d0ce77 | |
parent | 79ef1ac677d7df1633b5654b5310317ee9c6aede (diff) | |
download | bcfg2-030325e0ffc3ab6748b8dc258a9e5a39e055feed.tar.gz bcfg2-030325e0ffc3ab6748b8dc258a9e5a39e055feed.tar.bz2 bcfg2-030325e0ffc3ab6748b8dc258a9e5a39e055feed.zip |
doc: Create new doc outlining the various client modes available
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5786 ce84e21b-d406-0410-9b95-82705330c041
-rw-r--r-- | doc/client/index.txt | 23 | ||||
-rw-r--r-- | doc/client/modes.txt (renamed from doc/client/paranoid.txt) | 51 |
2 files changed, 44 insertions, 30 deletions
diff --git a/doc/client/index.txt b/doc/client/index.txt index e13d97ea8..536bedfbb 100644 --- a/doc/client/index.txt +++ b/doc/client/index.txt @@ -22,34 +22,13 @@ architecture, as opposed to one with a smarter client, for a few reasons: deployment engine that can be driven by anything that writes a compatible configuration description. -Overall client service mode ---------------------------- - -`New in version 1.0.0` - -Overall client service mode. Specified on the client using ``-s <service -mode``. - -* default - - * perform all service manipulations - -* disabled - - * perform no service manipulations - -* build - - * attempt to stop all services started - * deprecates/replaces -B - .. toctree:: :maxdepth: 2 agent debugging metadata - paranoid + modes .. toctree:: :maxdepth: 2 diff --git a/doc/client/paranoid.txt b/doc/client/modes.txt index 8f50c550d..f2f2b175e 100644 --- a/doc/client/paranoid.txt +++ b/doc/client/modes.txt @@ -1,20 +1,34 @@ .. -*- mode: rst -*- -.. _client-paranoid: +.. _client-modes: -============= -Paranoid Mode -============= +============ +Client modes +============ + +Dryrun mode +=========== -What is paranoid mode? -====================== +Dryrun mode (-n) prevents the client from making changes, but gives you +some insight into the state of the machine. This mode is also useful if +you simply want to gather data from the client into the reporting +system. + +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. + +Paranoid mode +============= Paranoid mode creates a backup of a local configuration file before Bcfg2 replaces the file. This allows for easier recovery by the local administrator. How do I use it? -================ +---------------- #. In the Bcfg2 repository, put `paranoid='true'` in the ``info.xml`` file. @@ -30,7 +44,7 @@ by _'s. For example, the old ``/etc/hosts`` will be named ``/var/cache/bcfg2/etc_hosts``. 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:: @@ -41,3 +55,24 @@ 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. + +Overall client service mode +=========================== + +`New in version 1.0.0` + +Overall client service mode. Specified on the client using ``-s <service +mode``. + +* default + + * perform all service manipulations + +* disabled + + * perform no service manipulations + +* build + + * attempt to stop all services started + * deprecates/replaces -B |