diff options
| -rw-r--r-- | doc/man/bcfg2.conf.txt | 22 | ||||
| -rw-r--r-- | doc/server/caching.txt | 3 | ||||
| -rw-r--r-- | man/bcfg2.conf.5 | 33 |
3 files changed, 56 insertions, 2 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. diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index 49aa5369f..dfcb42a24 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -1,4 +1,4 @@ -.TH "BCFG2.CONF" "5" "November 14, 2012" "1.3" "Bcfg2" +.TH "BCFG2.CONF" "5" "November 26, 2012" "1.3" "Bcfg2" .SH NAME bcfg2.conf \- Configuration parameters for Bcfg2 . @@ -394,6 +394,37 @@ executed on the client in the created files. .sp The Trigger plugin provides a method for calling external scripts when clients are configured. +.SH CACHING OPTIONS +.sp +These options are specified in the \fB[caching]\fP section. +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.TP +.B client_metadata +The following four caching modes are available for client +metadata: +.INDENT 7.0 +.IP \(bu 2 +off: No caching of client metadata objects is performed. This +is the default. +.IP \(bu 2 +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. +.IP \(bu 2 +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. \fIon\fP is a synonym for cautious. +.IP \(bu 2 +aggressive: Final metadata objects are cached. Each plugin is +responsible for clearing cache when appropriate. +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT .SH CLIENT OPTIONS .sp These options only affect client functionality. They can be specified in |