diff options
author | Sol Jerome <sol.jerome@gmail.com> | 2012-11-26 12:20:24 -0600 |
---|---|---|
committer | Sol Jerome <sol.jerome@gmail.com> | 2012-11-26 12:20:24 -0600 |
commit | b4c90f3cd85a9246e50aedf503fd84208cd9e59e (patch) | |
tree | abcbf1179c48ed93dd3bbab0b7f4b8a1c9e1f0ed /doc | |
parent | d32fd476787eddc8921eeadbfba5fa7e601ca231 (diff) | |
download | bcfg2-b4c90f3cd85a9246e50aedf503fd84208cd9e59e.tar.gz bcfg2-b4c90f3cd85a9246e50aedf503fd84208cd9e59e.tar.bz2 bcfg2-b4c90f3cd85a9246e50aedf503fd84208cd9e59e.zip |
doc: Document metadata caching options
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/bcfg2.conf.txt | 22 | ||||
-rw-r--r-- | doc/server/caching.txt | 3 |
2 files changed, 24 insertions, 1 deletions
diff --git a/doc/man/bcfg2.conf.txt b/doc/man/bcfg2.conf.txt index b8e252cc4..d8f2bc3df 100644 --- a/doc/man/bcfg2.conf.txt +++ b/doc/man/bcfg2.conf.txt @@ -434,6 +434,28 @@ Trigger Plugin The Trigger plugin provides a method for calling external scripts when clients are configured. +Caching options +--------------- + +These options are specified in the **[caching]** section. + + client_metadata + The following four caching modes are available for client + metadata: + + * off: No caching of client metadata objects is performed. This + is the default. + * initial: Only initial metadata objects are cached. Initial + metadata objects are created only from the data in the + Metadata plugin, before additional groups from other plugins + are merged in. + * cautious: Final metadata objects are cached, but each client’s + cache is cleared at the start of each client run, immediately + after probe data is received. Cache is also cleared as in + aggressive mode. *on* is a synonym for cautious. + * aggressive: Final metadata objects are cached. Each plugin is + responsible for clearing cache when appropriate. + Client options -------------- diff --git a/doc/server/caching.txt b/doc/server/caching.txt index ab98e9902..51245bd08 100644 --- a/doc/server/caching.txt +++ b/doc/server/caching.txt @@ -20,7 +20,8 @@ can be generated anywhere from 7 to dozens of times per client run was made more complex and powerful in 1.3.0, caching these objects provides the easiest performance gain. -There are four caching modes available: +To enable caching, add a ``[caching]`` section to bcfg2.conf with a +client_metadata option containing one of the following modes: * ``off``: No caching of client metadata objects is performed. This is the default. |