summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorNarayan Desai <desai@mcs.anl.gov>2011-06-22 17:01:40 -0500
committerNarayan Desai <desai@mcs.anl.gov>2011-06-22 17:01:40 -0500
commit4849378a62ab0dbf72f8ce4e6b2073dc73f2337a (patch)
tree14945dd6045c438f5dbc8e96f023258d31e1adf9 /man
parent8d08d5195fa0b6f503752273183948e5d24f33d6 (diff)
parent2db056574f5f55c3c802da63abe7e3de10db5d76 (diff)
downloadbcfg2-4849378a62ab0dbf72f8ce4e6b2073dc73f2337a.tar.gz
bcfg2-4849378a62ab0dbf72f8ce4e6b2073dc73f2337a.tar.bz2
bcfg2-4849378a62ab0dbf72f8ce4e6b2073dc73f2337a.zip
Merge branch 'master' of git.mcs.anl.gov:bcfg2
Diffstat (limited to 'man')
-rw-r--r--man/bcfg2-lint.87
-rw-r--r--man/bcfg2-lint.conf.516
-rw-r--r--man/bcfg2-reports.821
-rw-r--r--man/bcfg2.135
-rw-r--r--man/bcfg2.conf.519
5 files changed, 80 insertions, 18 deletions
diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8
index b1fa9244b..25fa30f9e 100644
--- a/man/bcfg2-lint.8
+++ b/man/bcfg2-lint.8
@@ -71,7 +71,7 @@ Require property files to have matching schema files
.SH "PLUGINS"
See
-.BR bcfg-lint.conf(5)
+.BR bcfg2-lint.conf(5)
for more information on the configuration of the plugins listed below.
.TP
@@ -120,6 +120,11 @@ exists for all Cfg files, and that paranoid mode be enabled for all
files.
.TP
+.BR MergeFiles
+Suggest that similar probes and config files be merged into single
+probes or TGenshi templates.
+
+.TP
.BR Pkgmgr
Check for duplicate packages specified in Pkgmgr.
diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5
index 0ae7a27ac..10a812874 100644
--- a/man/bcfg2-lint.conf.5
+++ b/man/bcfg2-lint.conf.5
@@ -43,7 +43,7 @@ section.
A comma-delimited list of plugins to run. By default, all plugins are
run. This can be overridden by listing plugins on the command line.
See
-.B bcfg2-lint(1)
+.B bcfg2-lint(8)
for a list of the available plugins.
.SH ERROR HANDLING
@@ -56,10 +56,10 @@ section. Each option should be the name of an error and one of
, or
.I "silent"
, which tells
-.B bcfg2-lint(1)
+.B bcfg2-lint(8)
how to handle the warning. Error names and their defaults can be
displayed by running
-.B bcfg2-lint(1)
+.B bcfg2-lint(8)
with the
.B --list-errors
option.
@@ -152,6 +152,14 @@ A comma-delimited list of attributes to require on
tags. Default is "owner,group,perms".
.TP
+.BR MergeFiles
+
+\(bu
+.B threshold
+The threshold at which MergeFiles will suggest merging config files
+and probes. Default is 75% similar.
+
+.TP
.BR Validate
\(bu
@@ -162,5 +170,5 @@ The full path to the XML Schema files. Default is
command-line option
.SH SEE ALSO
-.BR bcfg2-lint(1)
+.BR bcfg2-lint(8)
diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8
index bc4c9344b..51399e1c9 100644
--- a/man/bcfg2-reports.8
+++ b/man/bcfg2-reports.8
@@ -39,10 +39,15 @@ of NAME. NAME is the name of the entry.
.RS
Shows help and usage info about bcfg2-reports.
.RE
+.B "\-m NAME"
+.RS
+Single-host mode \- shows modified entries from the current interaction
+of NAME. NAME is the name of the entry.
+.RE
.B "\-s NAME"
.RS
-Single host mode \- shows bad and extra entries from the current
-interaction of NAME. NAME is the name of the entry.
+Single host mode \- shows bad, modified, and extra entries from the
+current interaction of NAME. NAME is the name of the entry.
.RE
.B "\-x NAME"
.RS
@@ -64,11 +69,19 @@ pairs will be read from a file of name ARG1. KIND is the type of entry
.RE
.B "\-\-fields=ARG1,ARG2,..."
.RS
-Only displays the fields ARG1,ARG2,... (name, time, state)
+Only displays the fields ARG1,ARG2,... (name, time, state, total, good,
+bad)
+.RE
+.B "\-\-modifiedentry=KIND,NAME"
+.RS
+Shows only hosts whose current interaction has modified entries in of
+KIND kind and NAME name; if a single argument ARG1 is given, then
+KIND,NAME pairs will be read from a file of name ARG1. KIND is the type
+of entry (Package, Path, Service, etc). NAME is the name of the entry.
.RE
.B "\-\-sort=ARG1,ARG2,..."
.RS
-Sorts output on ARG1,ARG2,... (name, time, state)
+Sorts output on ARG1,ARG2,... (name, time, state, total, good, bad)
.RE
.B "\-\-stale"
.RS
diff --git a/man/bcfg2.1 b/man/bcfg2.1
index 938d41dfe..0ace97e8a 100644
--- a/man/bcfg2.1
+++ b/man/bcfg2.1
@@ -3,7 +3,7 @@
bcfg2 \- reconfigure machine based on settings in Bcfg2
.SH SYNOPSIS
.B bcfg2
-.I [\-d] [\-v] [\-p] [\-c cache file] [\-e] [\-f config file] [\-I] [\-q] [\-b bundle] [\-r removal mode]
+.I [\-d] [\-v] [\-p] [\-c cache file] [\-e] [\-f config file] [\-I] [\-q] [\-z] [\-b bundle] [\-r removal mode] [\-\-ca\-cert=file] [\-\-ssl\-cns=list] [\-\-ssl\-cert=file] [\-\-ssl\-key=file]
.SH DESCRIPTION
.TP
.BR bcfg2
@@ -62,6 +62,10 @@ Run bcfg2 against one or multiple bundles in the configuration.
Cache a copy of the configuration in cachefile.
.TP
+.BR "\-\-ca\-cert=<ca cert>"
+Specifiy the path to the SSL CA certificate.
+
+.TP
.BR "\-d"
Run bcfg2 in debug mode.
@@ -85,10 +89,12 @@ debian toolset; it calls apt\-get update and clean and
dpkg \-\-configure \-\-pending.
.TP
-.BR "\-l <whitelist|blacklist>"
-Run the client in the server decision list mode. This approach is needed
-when particular changes are deemed "high risk". It gives the ability to
-centrally specify these changes, but only install them on clients when
+.BR "\-l <whitelist|blacklist|none>"
+Run the client in the server decision list mode (unless "none" is
+specified, which can be done in order to override the decision list mode
+specified in bcfg2.conf). This approach is needed when particular
+changes are deemed "high risk". It gives the ability to centrally
+specify these changes, but only install them on clients when
administrator supervision is available. Because collaborative
configuration is one of the remaining hard issues in configuration
management, these issues typically crop up in environments with several
@@ -116,7 +122,7 @@ should only be used in safe conditions.
.TP
.BR "\-Q"
Run bcfg2 in "bundle quick" mode, where only entries in a bundle are
-or installed. This runs much faster than -q, but doesn't provide
+verified or installed. This runs much faster than -q, but doesn't provide
statistics to the server at all. In order for this option to work, the
-b option must also be provided. This option is incompatible with -r.
@@ -135,6 +141,14 @@ to stop all services started. disabled suppresses all attempts to
modify services.
.TP
+.BR "\-\-ssl\-cert=<ssl cert>"
+Specifiy the path to the SSL certificate.
+
+.TP
+.BR "\-\-ssl\-cns=<CommonName1:CommonName2 ...>"
+List of acceptable SSL server Common Names.
+
+.TP
.BR "\-\-ssl\-key=<ssl key>"
Specifiy the path to the SSL key.
@@ -147,8 +161,17 @@ Attempt to authenticate as 'user'.
Use 'password' for client communication.
.TP
+.BR "\-t <timeout>"
+Set the timeout (in seconds) for client communication. Default is 90
+seconds.
+
+.TP
.BR "\-v"
Run bcfg2 in verbose mode.
+
+.TP
+.BR "\-z"
+Only configure independent entries, ignore bundles.
.RE
.SH "SEE ALSO"
.BR bcfg2-server(8),
diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5
index f2e47b7ac..7cd04a0b7 100644
--- a/man/bcfg2.conf.5
+++ b/man/bcfg2.conf.5
@@ -38,6 +38,12 @@ The file monitor used to watch for changes in the repository.
Values of 'gamin', 'fam', or 'pseudo' are valid.
.TP
+.B listen_all
+This setting tells the server to listen on all available interfaces. The
+default is to only listen on those interfaces specified by the bcfg2
+setting in the components section of bcfg2.conf.
+
+.TP
.B plugins
A comma-delimited list of enabled server plugins. Currently available
plugins are:
@@ -285,6 +291,10 @@ These options only affect client functionality, specified in the
[client] section.
.TP
+.B decision
+Specify the server decision list mode (whitelist or blacklist).
+
+.TP
.B drivers
Specify tool driver set to use. This option can be used to explicitly
specify the client tool drivers you want to use when the client is run.
@@ -369,6 +379,11 @@ Communication protocol to use. Defaults to xmlrpc/ssl.
A client-only option. Number of times to retry network communication.
.TP
+.B serverCommonNames
+A client-only option. A colon-separated list of Common Names the client
+will accept in the SSL certificate presented by the server.
+
+.TP
.B user
A client-only option. The UUID of the client.
@@ -400,9 +415,7 @@ eg: bcfg2 = https://10.3.1.6:6789
.TP
.B encoding
-Text encoding of configuration files. Defaults to the system default
-encoding.
-
+Text encoding of configuration files. Defaults to UTF-8.
.SH LOGGING OPTIONS
Specified in the [logging] section. These options control the server