diff options
Diffstat (limited to 'doc/client/modes.txt')
-rw-r--r-- | doc/client/modes.txt | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/client/modes.txt b/doc/client/modes.txt new file mode 100644 index 000000000..f2f2b175e --- /dev/null +++ b/doc/client/modes.txt @@ -0,0 +1,78 @@ +.. -*- mode: rst -*- + +.. _client-modes: + +============ +Client modes +============ + +Dryrun 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. +#. On the client, create ``/var/cache/bcfg2`` (or specify an alternate + path in the [paranoid] section of /etc/bcfg2). +#. On the client, run `bcfg2` with the `-P` option (alternatively, you + can set *paranoid* to *true* in the **[client]** section of + ``bcfg2.conf``). + +This will save a copy of the replaced file in ``/var/cache/bcfg2``, +but it'll be named as the path to the file with /'s replaced +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:: + + [paranoid] + path = /my/custom/backup/path + max_copies = 5 + +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 |