diff options
| author | Sol Jerome <sol.jerome@gmail.com> | 2012-06-03 16:58:00 -0500 |
|---|---|---|
| committer | Sol Jerome <sol.jerome@gmail.com> | 2012-06-03 16:58:00 -0500 |
| commit | 9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b (patch) | |
| tree | a640aba51d2e1e4e9a80764dbe00f676d165b86f /man | |
| parent | 55a09f413871f6f8288a2f2f1d14b5831e3acaf5 (diff) | |
| download | bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.tar.gz bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.tar.bz2 bcfg2-9a6cae4e5ed2c8615c17d462d5aa5b7828cdb23b.zip | |
man: Clean up man pages
Created new rst files with man page information so that generating man
pages is easier and more consistent throughout bcfg2.
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/bcfg2-admin.8 | 422 | ||||
| -rw-r--r-- | man/bcfg2-build-reports.8 | 74 | ||||
| -rw-r--r-- | man/bcfg2-info.8 | 263 | ||||
| -rw-r--r-- | man/bcfg2-lint.8 | 239 | ||||
| -rw-r--r-- | man/bcfg2-lint.conf.5 | 259 | ||||
| -rw-r--r-- | man/bcfg2-ping-sweep.8 | 30 | ||||
| -rw-r--r-- | man/bcfg2-reports.8 | 168 | ||||
| -rw-r--r-- | man/bcfg2-server.8 | 104 | ||||
| -rw-r--r-- | man/bcfg2.1 | 345 | ||||
| -rw-r--r-- | man/bcfg2.conf.5 | 833 |
10 files changed, 1235 insertions, 1502 deletions
diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8 index 6607344d8..a863151d4 100644 --- a/man/bcfg2-admin.8 +++ b/man/bcfg2-admin.8 @@ -1,214 +1,208 @@ -.TH "bcfg2-admin" 8 -.SH NAME -bcfg2-admin \- Perform repository administration tasks -.SH SYNOPSIS -.B bcfg2-admin -.I [-C config-file] -.I <mode> -.I <mode args> -.I <mode options> -.SH DESCRIPTION -.PP -.B bcfg2-admin -Perform Bcfg2 repository administration -.SH OPTIONS -.PP -.B \-C <config-file> -.RS -Specify the location of the configuration file (if it is not in -/etc/bcfg2.conf). -.RE -.SH MODES -.PP -.B init -.RS -Initialize a new repository (interactive). -.RE -.B backup -.RS -Create an archive of the whole Bcfg2 repository. -.RE -.B bundle <action> -.RS -Display details about the available bundles. -.RE -.B client <action> <client> [attribute=value] -.RS -Add, edit, or remove clients entries in metadata. -.RE -.B query [g=group] [p=profile] [-f output-file] [-n] [-c] -.RS -Search for clients based on group or profile. -.RE -.B compare <old> <new> -.RS -Compare two client configurations. Can be used to verify consistent -behavior between releases. Determine differences between files or -directories. -.RE -.B minestruct <client> [-f xml-file] [-g groups] -.RS -Build structure entries based on client statistics extra entries. -.RE -.B pull <client> <entry-type> <entry-name> -.RS -Install configuration information into repo based on client bad -entries. -.RE -.B reports [init|load_stats|purge|scrub|update] -.RS -Interact with the dynamic reporting system. -.RE -.B snapshots [init|dump|query|reports] -.RS -Interact with the Snapshots database. -.RE -.B tidy -.RS -Remove unused files from repository. -.RE -.B viz [-H] [-b] [-k] [-o png-file] -.RS -Create a graphviz diagram of client, group and bundle information. -.RE -.SH BUNDLE OPTIONS -.PP -.B mode -.RS -List all available xml bundles 'list-xml' or for all available genshi -bundles 'list-genshi'. 'show' provides an interactive dialog to get -details about the available bundles. -.RE -.SH CLIENT OPTIONS -.PP -.B mode -.RS -Add a client 'add', delete a client 'del', or 'list' all client entries. -.RE -.B client -.RS -Specify the client's name. -.RE -.B attribute=value -.RS -Set attribute values when adding a new client. Allowed attributes -are 'profile', 'uuid', 'password', 'location', 'secure', and 'address'. -.RE -.SH QUERY OPTIONS -.PP -.B g=group -.RS -Specify a group to search within. -.RE -.B p=profile -.RS -Specify a profile to search within. -.RE -.B \-f <output-file> -.RS -Write the results of the query to a file. -.RE -.B \-n -.RS -Print the results, one on each line. -.RE -.B \-c -.RS -Print the results, separated by commas. -.RE -.SH COMPARE OPTIONS -.PP -.B old -.RS -Specify the location of the old configuration file. -.RE -.B new -.RS -Specify the location of the new configuration file. -.RE -.SH MINESTRUCT OPTIONS -.PP -.B client -.RS -Client whose metadata is to be searched for extra entries. -.RE -.B \-g <groups> -.RS -Hierarchy of groups in which to place the extra entries in. -.RE -.B \-f <xml-output-file> -.RS -Specify the xml file in which to write the extra entries. -.RE -.SH PULL OPTIONS -.PP -.B client -.RS -Specify the name of the client to search for. -.RE -.B entry-type -.RS -Specify the type of the entry to pull. -.RE -.B entry-name -.RS -Specify the name of the entry to pull. -.RE -.SH REPORTS OPTIONS -.PP -.B init -.RS -Initialize the database. -.RE -.B load_stats [-s] [-c] [-03] -.RS -Load statistics data. -.RE -.B purge [--client [n]] [--days [n]] [--expired] -.RS -Purge historic and expired data. -.RE -.B scrub -.RS -Scrub the database for duplicate reasons and orphaned entries. -.RE -.B update -.RS -Apply any updates to the reporting database. -.RE -.SH SNAPSHOTS OPTIONS -.PP -.B init -.RS -Initialize the snapshots database. -.RE -.B query -.RS -Query the snapshots database. -.RE -.B dump -.RS -Dump some of the contents of the snapshots database. -.RE -.B reports [-a] [-b] [-e] [--date=<MM-DD-YYYY>] -.RS -Generate reports for clients in the snapshots database. -.RE -.SH VIZ OPTIONS -.PP -.B \-H -.RS -Include hosts in diagram. -.RE -.B \-b -.RS -Include bundles in diagram. -.RE -.B \-o <output file> -.RS -Write to outfile file instead of stdout. -.RE -.B \-k -.RS -Add a shape/color key. -.RE +. +.TH "BCFG2\-ADMIN" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-admin\fR \- Perform repository administration tasks +. +.SH "SYNOPSIS" +\fBbcfg2\-admin\fR [\-C \fIconfigfile\fR] \fImode\fR [\fImode args\fR] [\fImode options\fR] +. +.SH "DESCRIPTION" +\fBbcfg2\-admin\fR is used to perform Bcfg2 repository administration +. +.SH "OPTIONS" +. +.TP +\fB\-C\fR \fIconfigfile\fR +Specify alternate bcfg2\.conf location +. +.SH "MODES" +. +.TP +\fBinit\fR +Initialize a new repository (interactive)\. +. +.TP +\fBbackup\fR +Create an archive of the entire Bcfg2 repository\. +. +.TP +\fBbundle\fR \fIaction\fR +Display details about the available bundles (See \fI\fBBUNDLE OPTIONS\fR\fR below)\. +. +.TP +\fBclient\fR \fIaction\fR \fIclient\fR [attribute=value] +Add, edit, or remove clients entries in metadata (See \fI\fBCLIENT OPTIONS\fR\fR below)\. +. +.TP +\fBquery\fR [g=group] [p=profile] [\-f output\-file] [\-n] [\-c] +Search for clients based on group or profile (See \fI\fBQUERY OPTIONS\fR\fR below)\. +. +.TP +\fBcompare\fR \fIold\fR \fInew\fR +Compare two client configurations\. Can be used to verify consistent behavior between releases\. Determine differences between files or directories (See \fI\fBCOMPARE OPTIONS\fR\fR below)\. +. +.TP +\fBminestruct\fR \fIclient\fR [\-f xml\-file] [\-g groups] +Build structure entries based on client statistics extra entries (See \fI\fBMINESTRUCT OPTIONS\fR\fR below)\. +. +.TP +\fBpull\fR \fIclient\fR \fIentry\-type\fR \fIentry\-name\fR +Install configuration information into repo based on client bad entries (See \fI\fBPULL OPTIONS\fR\fR below)\. +. +.TP +\fBreports\fR [init|load_stats|purge|scrub|update] +Interact with the dynamic reporting system (See \fI\fBREPORTS OPTIONS\fR\fR below)\. +. +.TP +\fBsnapshots\fR [init|dump|query|reports] +Interact with the Snapshots database (See \fI\fBSNAPSHOTS OPTIONS\fR\fR below)\. +. +.TP +\fBtidy\fR +Remove unused files from repository\. +. +.TP +\fBviz\fR [\-H] [\-b] [\-k] [\-o png\-file] +Create a graphviz diagram of client, group and bundle information (See \fI\fBVIZ OPTIONS\fR\fR below)\. +. +.SS "BUNDLE OPTIONS" +. +.TP +\fBmode\fR +List all available xml bundles ’list\-xml’ or for all available genshi bundles ’list\-genshi’\. ’show’ provides an interactive dialog to get details about the available bundles\. +. +.SS "CLIENT OPTIONS" +. +.TP +\fBmode\fR +Add a client ’add’, delete a client ’del’, or ’list’ all client entries\. +. +.TP +\fBclient\fR +Specify the client’s name\. +. +.TP +\fBattribute=value\fR +Set attribute values when adding a new client\. Allowed attributes are ’profile’, ’uuid’, ’password’, ’location’, ’secure’, and ’address’\. +. +.SS "QUERY OPTIONS" +. +.TP +\fBg=group\fR +Specify a group to search within\. +. +.TP +\fBp=profile\fR +Specify a profile to search within\. +. +.TP +\fB\-f\fR \fIoutput file\fR +Write the results of the query to a file\. +. +.TP +\fB\-n\fR +Print the results, one on each line\. +. +.TP +\fB\-c\fR +Print the results, separated by commas\. +. +.SS "COMPARE OPTIONS" +. +.TP +\fBold\fR +Specify the location of the old configuration file\. +. +.TP +\fBnew\fR +Specify the location of the new configuration file\. +. +.SS "MINESTRUCT OPTIONS" +. +.TP +\fBclient\fR +Client whose metadata is to be searched for extra entries\. +. +.TP +\fB\-g\fR \fIgroups\fR +Hierarchy of groups in which to place the extra entries in\. +. +.TP +\fB\-f\fR \fIxml output file\fR +Specify the xml file in which to write the extra entries\. +. +.SS "PULL OPTIONS" +. +.TP +\fBclient\fR +Specify the name of the client to search for\. +. +.TP +\fBentry type\fR +Specify the type of the entry to pull\. +. +.TP +\fBentry name\fR +Specify the name of the entry to pull\. +. +.SS "REPORTS OPTIONS" +. +.TP +\fBinit\fR +Initialize the database\. +. +.TP +\fBload_stats\fR [\-s] [\-c] [\-03] +Load statistics data\. +. +.TP +\fBpurge\fR [\-\-client [n]] [\-\-days [n]] [\-\-expired] +Purge historic and expired data\. +. +.TP +\fBscrub\fR +Scrub the database for duplicate reasons and orphaned entries\. +. +.TP +\fBupdate\fR +Apply any updates to the reporting database\. +. +.SS "SNAPSHOTS OPTIONS" +. +.TP +\fBinit\fR +Initialize the snapshots database\. +. +.TP +\fBquery\fR +Query the snapshots database\. +. +.TP +\fBdump\fR +Dump some of the contents of the snapshots database\. +. +.TP +\fBreports\fR [\-a] [\-b] [\-e] [\-\-date=\fIMM\-DD\-YYYY\fR] +Generate reports for clients in the snapshots database\. +. +.SS "VIZ OPTIONS" +. +.TP +\fB\-H\fR +Include hosts in diagram\. +. +.TP +\fB\-b\fR +Include bundles in diagram\. +. +.TP +\fB\-o\fR \fIoutput file\fR +Write to outfile file instead of stdout\. +. +.TP +\fB\-k\fR +Add a shape/color key\. +. +.SH "SEE ALSO" +bcfg2\-info(8), bcfg2\-server(8) diff --git a/man/bcfg2-build-reports.8 b/man/bcfg2-build-reports.8 index a14dea728..7ece94c32 100644 --- a/man/bcfg2-build-reports.8 +++ b/man/bcfg2-build-reports.8 @@ -1,40 +1,36 @@ -.TH "bcfg2-build-reports" 8 -.SH NAME -bcfg2-build-reports \- Generate state reports for Bcfg2 clients -.SH SYNOPSIS -.B bcfg2-build-reports -.I [-A] [-c] [-s] [-N] -.SH DESCRIPTION -.PP -.B bcfg2-build-reports -Build all client state reports. See the Bcfg2 manual for report setup -information. -.SH OPTIONS -.PP -.B "\-A" -.RS -Displays all data. -.RE -.B "\-c <configuration file>" -.RS -Specify an alternate report configuration path. The default is -repo/etc/reports-configuration.xml. -.RE -.B "\-h" -.RS -Produce a help message. -.RE -.B "\-s <statistics Path>" -.RS -Use an alternative path for the statistics file. The default is -repo/etc/statistics.xml -.RE -.B "\-N" -.RS -No pinging. -.RE +. +.TH "BCFG2\-BUILD\-REPORTS" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-build\-reports\fR \- Generate state reports for Bcfg2 clients +. +.SH "SYNOPSIS" +\fBbcfg2\-build\-reports\fR [\fI\-A\fR] [\fI\-c\fR] [\fI\-s\fR] [\fI\-N\fR] +. +.SH "DESCRIPTION" +\fBbcfg2\-build\-reports\fR is used to build all client state reports\. See the Bcfg2 manual for report setup information\. +. +.SH "OPTIONS" +. +.TP +\fB\-A\fR +Displays all data\. +. +.TP +\fB\-c\fR \fIconfiguration file\fR +Specify an alternate report configuration path\. The default is repo/etc/reports\-configuration\.xml\. +. +.TP +\fB\-h\fR +Produce a help message\. +. +.TP +\fB\-s\fR \fIstatistics path\fR +Use an alternative path for the statistics file\. The default is repo/etc/statistics\.xml\. +. +.TP +\fB\-N\fR +No pinging\. +. .SH "SEE ALSO" -.BR bcfg(1), -.BR bcfg2-server(8) -.SH "BUGS" -None currently known +bcfg2(1), bcfg2\-server(8) diff --git a/man/bcfg2-info.8 b/man/bcfg2-info.8 index a644926b5..12b6ae9c6 100644 --- a/man/bcfg2-info.8 +++ b/man/bcfg2-info.8 @@ -1,131 +1,134 @@ -.TH "bcfg2-info" 8 -.SH NAME -bcfg2-info \- Creates a local version of the bcfg2 server core for -state observation -.SH SYNOPSIS -.B bcfg2-info -.I [\-C <config file>] [\-E <encoding>] [\-Q <repository path>] [\-h] [\-p] [\-x <password>] -.I <mode> -.I <mode args> -.I <mode options> -.SH DESCRIPTION -.PP -.B bcfg2-info -Instantiate an instance of the Bcfg2 core for data examination and -debugging purposes. -.SH OPTIONS -.PP -.B "\-C <config file>" -.RS -Specify the location of the configuration file (if it is not in -/etc/bcfg2.conf). -.RE -.B "\-E <encoding>" -.RS -Specify the encoding of config files. -.RE -.B "\-Q <repository path> -.RS -Specify the server repository path. -.RE -.B "\-d" -.RS -Run in debug mode. -.RE -.B "\-h" -.RS -Give a bit of help about the command line arguments and -options. After this bcfg2-info exits. -.RE -.B "\-p" -.RS -Specify a profile. -.RE -.B "\-x <password>" -.RS -Set the communication password. -.RE -.SH MODES -.PP -.B build <hostname> <filename> -.RS -Build config for hostname, writing to filename. -.RE -.B builddir <hostname> <dirname> -.RS -Build config for hostname, writing separate files to dirname. -.RE -.B buildall <directory> -.RS -Build configs for all clients in directory. -.RE -.B buildbundle <filename> <hostname> -.RS -Build bundle for hostname (not written to disk). If filename is a bundle -template, it is rendered. -.RE -.B buildfile [--altsrc=<altsrc>] <filename> <hostname> -.RS -Build config file for hostname (not written to disk). -.RE -.B bundles -.RS -Print out group/bundle information. -.RE -.B clients -.RS -Print out client/profile information. -.RE -.B config -.RS -Print out the configuration of the Bcfg2 server. -.RE -.B debug -.RS -Shell out to native python interpreter. -.RE -.B event_debug -.RS -Display filesystem events as they are processed. -.RE -.B groups -.RS -List groups -.RE -.B help -.RS -Print the list of available commands. -.RE -.B mappings <type*> <name*> -.RS -Print generator mappings for optional type and name. -.RE -.B profile <command> <args> -.RS -Profile a single bcfg2-info command. -.RE -.B quit -.RS -Exit bcfg2-info command line. -.RE -.B showentries <hostname> <type> -.RS -Show abstract configuration entries for a given host. -.RE -.B showclient <client1> <client2> -.RS -Show metadata for given hosts. -.RE -.B update -.RS -Process pending file events. -.RE -.B version -.RS -Print version of this tool. -.RE +. +.TH "BCFG2\-INFO" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-info\fR \- Creates a local version of the Bcfg2 server core for state observation +. +.SH "SYNOPSIS" +\fBbcfg2\-info\fR [\fI\-C configfile\fR] [\-E \fIencoding\fR] [\-Q \fIrepository path\fR] [\-h] [\-p] [\-x \fIpassword\fR] [\fImode\fR] [\fImode args\fR] [\fImode options\fR] +. +.SH "DESCRIPTION" +\fBbcfg2\-info\fR instantiates an instance of the Bcfg2 core for data examination and debugging purposes\. +. +.SH "OPTIONS" +. +.TP +\fB\-C\fR \fIconfigfile\fR +Specify alternate bcfg2\.conf location +. +.TP +\fB\-E\fR \fIencoding\fR +Specify the encoding of config files\. +. +.TP +\fB\-Q\fR \fIrepository path\fR +Specify the server repository path\. +. +.TP +\fB\-d\fR +Run in debug mode\. +. +.TP +\fB\-h\fR +Give a bit of help about the command line arguments and options\. After this bcfg2\-info exits\. +. +.TP +\fB\-p\fR +Specify a profile\. +. +.TP +\fB\-x\fR \fIpassword\fR +Set the communication password\. +. +.SH "MODES" +. +.TP +\fBbuild\fR \fIhostname\fR \fIfilename\fR +Build config for hostname, writing to filename\. +. +.TP +\fBbuildall\fR \fIdirectory\fR +Build configs for all clients in directory\. +. +.TP +\fBbuildallfile\fR \fIdirectory\fR \fIfilename\fR [\fIhostnames\fR] +Build config file for all clients in directory\. +. +.TP +\fBbuildbundle\fR \fIfilename\fR \fIhostname\fR +Build bundle for hostname (not written to disk)\. If filename is a bundle template, it is rendered\. +. +.TP +\fBbuilddir\fR \fIhostname\fR \fIdirname\fR +Build config for hostname, writing separate files to dirname\. +. +.TP +\fBbuildfile\fR [\-\-altsrc=\fIaltsrc\fR] \fIfilename\fR \fIhostname\fR +Build config file for hostname (not written to disk)\. +. +.TP +\fBbundles\fR +Print out group/bundle information\. +. +.TP +\fBclients\fR +Print out client/profile information\. +. +.TP +\fBconfig\fR +Print out the configuration of the Bcfg2 server\. +. +.TP +\fBdebug\fR +Shell out to native python interpreter\. +. +.TP +\fBevent_debug\fR +Display filesystem events as they are processed\. +. +.TP +\fBgroups\fR +List groups\. +. +.TP +\fBhelp\fR +Print the list of available commands\. +. +.TP +\fBmappings\fR [\fIentry type\fR] [\fIentry name\fR] +Print generator mappings for optional type and name\. +. +.TP +\fBpackageresolve\fR \fIhostname\fR \fIpackage\fR [\fIpackage\fR\.\.\.] +Resolve the specified set of packages\. +. +.TP +\fBpackagesources\fR \fIhostname\fR +Show package sources\. +. +.TP +\fBprofile\fR \fIcommand\fR \fIargs\fR +Profile a single bcfg2\-info command\. +. +.TP +\fBquit\fR +Exit bcfg2\-info command line\. +. +.TP +\fBshowentries\fR \fIhostname\fR \fItype\fR +Show abstract configuration entries for a given host\. +. +.TP +\fBshowclient\fR \fIclient1\fR \fIclient2\fR +Show metadata for given hosts\. +. +.TP +\fBupdate\fR +Process pending file events\. +. +.TP +\fBversion\fR +Print version of this tool\. +. .SH "SEE ALSO" -.BR bcfg2(1), -.BR bcfg2-server(8) -.SH "BUGS" -None currently known +bcfg2(1), bcfg2\-server(8) diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 index 25fa30f9e..02d472d22 100644 --- a/man/bcfg2-lint.8 +++ b/man/bcfg2-lint.8 @@ -1,174 +1,99 @@ -.TH "bcfg2-lint" 8 -.SH NAME -bcfg2-lint \- Check Bcfg2 specification for validity, common mistakes, -and style - -.SH SYNOPSIS -.B bcfg2-lint -.I [OPTIONS] -.I [<plugin> [<plugin>...]] - -.SH DESCRIPTION -.PP -.B bcfg2-lint -This script checks the Bcfg2 specification for schema validity, common -mistakes, and other criteria. It can be quite helpful in finding -typos or malformed data. - -.B bcfg2-lint -exits with a return value of 2 if errors were found, and 3 -if warnings (but no errors) were found. Any other non-0 exit value -denotes some failure in the script itself. - -.B bcfg2-lint -is a rewrite of the older -.B bcfg2-repo-validate -tool. - -.SH OPTIONS - +. +.TH "BCFG2\-LINT" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-lint\fR \- Check Bcfg2 specification for validity, common mistakes, and style +. +.SH "SYNOPSIS" +\fBbcfg2\-lint\fR [\fIoptions\fR] [\fIplugin\fR [\fIplugin\fR\.\.\.]] +. +.SH "DESCRIPTION" +\fBbcfg2\-lint\fR checks the Bcfg2 specification for schema validity, common mistakes, and other criteria\. It can be quite helpful in finding typos or malformed data\. +. +.P +\fBbcfg2\-lint\fR exits with a return value of 2 if errors were found, and 3 if warnings (but no errors) were found\. Any other non\-0 exit value denotes some failure in the script itself\. +. +.P +\fBbcfg2\-lint\fR is a rewrite of the older bcfg2\-repo\-validate tool\. +. +.SH "OPTIONS" +. .TP -.BR "-v" -Be verbose. - +\fB\-C\fR \fIconfigfile\fR +Specify alternate bcfg2\.conf location\. +. .TP -.BR "-C" -Specify path to bcfg2.conf (default /etc/bcfg2.conf) - +\fB\-Q\fR +Specify the server repository path\. +. .TP -.BR "--lint-config" -Specify path to bcfg2-lint.conf (default /etc/bcfg2-lint.conf) - +\fB\-v\fR +Be verbose\. +. .TP -.BR "-Q" -Specify path to Bcfg2 repository (default /var/lib/bcfg2) - +\fB\-\-lint\-config\fR +Specify path to bcfg2\-lint\.conf (default \fB/etc/bcfg2\-lint\.conf\fR)\. +. .TP -.BR "--stdin" -Rather than operating on all files in the Bcfg2 specification, only -validate a list of files supplied on stdin. This mode is particularly -useful in pre-commit hooks. - +\fB\-\-stdin\fR +Rather than operating on all files in the Bcfg2 specification, only validate a list of files supplied on stdin\. This mode is particularly useful in pre\-commit hooks\. +. +.IP This makes a few assumptions: - -Metadata files will only be checked if a valid chain of XIncludes can -be followed all the way from clients.xml or groups.xml. Since there -are multiple formats of metadata stored in Metadata/ (i.e., clients -and groups), there is no way to determine which sort of data a file -contains unless there is a valid chain of XIncludes. It may be useful -to always specify all metadata files should be checked, even if not -all of them have changed. - -Property files will only be validated if both the property file itself -and its matching schema are included on stdin. - +. +.IP +Metadata files will only be checked if a valid chain of XIncludes can be followed all the way from clients\.xml or groups\.xml\. Since there are multiple formats of metadata stored in Metadata/ (i\.e\., clients and groups), there is no way to determine which sort of data a file contains unless there is a valid chain of XIncludes\. It may be useful to always specify all metadata files should be checked, even if not all of them have changed\. +. +.IP +Property files will only be validated if both the property file itself and its matching schema are included on stdin\. +. .TP -.BR "--require-schema" -Require property files to have matching schema files - -.RE - +\fBrequire\-schema\fR +Require property files to have matching schema files\. +. .SH "PLUGINS" - -See -.BR bcfg2-lint.conf(5) -for more information on the configuration of the plugins listed below. - +See \fBbcfg2\-lint\.conf\fR(5) for more information on the configuration of the plugins listed below\. +. .TP -.BR Bundles -Check the specification for several issues with Bundler: bundles -referenced in metadata but not found in -.I Bundler/ -; bundles whose -.I name -attribute does not match the filename; and Genshi template bundles -that use the -.I <Group> -tag (which is not processed in templated bundles). - +\fBBundles\fR +Check the specification for several issues with Bundler: bundles referenced in metadata but not found in \fBBundler/\fR; bundles whose \fIname\fR attribute does not match the filename; and Genshi template bundles that use the \fI\fIGroup\fR\fR tag (which is not processed in templated bundles)\. +. .TP -.BR Comments -Check the specification for VCS keywords and any comments that are -required. By default, this only checks that the -.I $Id$ -keyword is included and expanded in all files. You may specify VCS -keywords to check and comments to be required in the config file. -(For instance, you might require that every file have a "Maintainer" -comment.) - -In XML files, only comments are checked for the keywords and comments -required. - +\fBComments\fR +Check the specification for VCS keywords and any comments that are required\. By default, this only checks that the \fI$Id$\fR keyword is included and expanded in all files\. You may specify VCS keywords to check and comments to be required in the config file\. (For instance, you might require that every file have a "Maintainer" comment\.) +. +.IP +In XML files, only comments are checked for the keywords and comments required\. +. .TP -.BR Duplicates -Check for several types of duplicates in the Metadata: duplicate -groups; duplicate clients; and multiple default groups. - +\fBDuplicates\fR +Check for several types of duplicates in the Metadata: duplicate groups; duplicate clients; and multiple default groups\. +. .TP -.BR InfoXML -Check that certain attributes are specified in -.I info.xml -files. By default, requires that -.I owner -, -.I group -, and -.I perms -are specified. Can also require that an -.I info.xml -exists for all Cfg files, and that paranoid mode be enabled for all -files. - +\fBInfoXML\fR +Check that certain attributes are specified in \fBinfo\.xml\fR files\. By default, requires that \fIowner\fR, \fIgroup\fR, and \fIperms\fR are specified\. Can also require that an \fBinfo\.xml\fR 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. - +\fBMergeFiles\fR +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. - +\fBPkgmgr\fR +Check for duplicate packages specified in Pkgmgr\. +. .TP -.BR RequiredAttrs -Check that all -.I <Path> -and -.I <BoundPath> -tags have the attributes that are required by their type. (E.g., a -path of type -.I "symlink" -must have -.I name -and -.I to -specified to be valid. This sort of validation is beyond the scope of -an XML schema. - +\fBRequiredAttrs\fR +Check that all \fIPath\fR and \fIBoundPath\fR tags have the attributes that are required by their type (e\.g\., a path of type symlink must have name and to specified to be valid)\. This sort of validation is beyond the scope of an XML schema\. +. .TP -.BR Validate -Validate the Bcfg2 specification against the XML schemas. - -Property files are freeform XML, but if a -.I .xsd -file with a matching filename is provided, then schema validation will -be performed on property files individually as well. For instance, if -you have a property file named -.I ntp.xml -then by placing a schema for that file in -.I ntp.xsd -schema validation will be performed on -.I ntp.xml -. - - -.SH "SEE ALSO" -.BR bcfg2(1), -.BR bcfg2-server(8), -.BR bcfg2-lint.conf(5) - +\fBValidate\fR +Validate the Bcfg2 specification against the XML schemas\. +. +.IP +Property files are freeform XML, but if a \fB\.xsd\fR file with a matching filename is provided, then schema validation will be performed on property files individually as well\. For instance, if you have a property file named \fBntp\.xml\fR then by placing a schema for that file in \fBntp\.xsd\fR schema validation will be performed on \fBntp\.xml\fR\. +. .SH "BUGS" - -bcfg2-lint may not handle some older plugins as well as it handles -newer ones. For instance, there may be some places where it expects -all of your configuration files to be handled by Cfg rather than by a -mix of Cfg and TGenshi or TCheetah. +\fBbcfg2\-lint\fR may not handle some older plugins as well as it handles newer ones\. For instance, there may be some places where it expects all of your configuration files to be handled by Cfg rather than by a mix of Cfg and TGenshi or TCheetah\. +. +.SH "SEE ALSO" +bcfg2(1), bcfg2\-server(8), bcfg2\-lint\.conf(5) diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index 10a812874..467a717b0 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -1,174 +1,99 @@ -.TH bcfg2-lint.conf 5 - -.SH NAME -bcfg2-lint.conf - configuration parameters for bcfg2-lint - -.SH DESCRIPTION -.TP -bcfg2-lint.conf includes configuration parameters for -.I bcfg2-lint - -.SH FILE FORMAT -The file is INI-style and consists of sections and options. A section -begins with the name of the sections in square brackets and continues -until the next section begins. - -Options are specified in the form 'name = value'. - -The file is line-based each newline-terminated line represents either -a comment, a section name or an option. - -Any line beginning with a hash (#) is ignored, as are lines containing -only whitespace. - -The file consists of one -.I [lint] -section, up to one -.I [errors] -section, and then any number of plugin-specific sections, documented below. (Note that this makes it quite feasible to combine your -.B bcfg2-lint.conf -into your -.B bcfg2.conf(5) -file, if you so desire.) - -.SH GLOBAL OPTIONS -These options apply to -.I bcfg2-lint -generally, and must be in the -.I [lint] -section. - -.TP -.BR plugins -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(8) -for a list of the available plugins. - -.SH ERROR HANDLING -Error handling is configured in the -.I [errors] -section. Each option should be the name of an error and one of -.I "error" -, -.I "warning" -, or -.I "silent" -, which tells -.B bcfg2-lint(8) -how to handle the warning. Error names and their defaults can be -displayed by running -.B bcfg2-lint(8) -with the -.B --list-errors -option. - -.SH PLUGIN OPTIONS - -These options apply only to a single plugin. Each option should be in -a section named for its plugin; for instance, options for the InfoXML -plugin would be in a section called -.I [InfoXML] -. - -If a plugin is not listed below, then it has no configuration. - -In many cases, the behavior of a plugin can be configured by modifying -how errors from it are handled. See -.B ERROR HANDLING -, above. - +. +.TH "BCFG2\-LINT\.CONF" "5" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-lint\.conf\fR \- configuration parameters for bcfg2\-lint +. +.SH "DESCRIPTION" +\fBbcfg2\-lint\.conf\fR includes configuration parameters for \fBbcfg2\-lint\fR\. +. +.SH "FILE FORMAT" +The file is INI\-style and consists of sections and options\. A section begins with the name of the sections in square brackets and continues until the next section begins\. +. +.P +Options are specified in the form "name=value"\. +. +.P +The file is line\-based each newline\-terminated line represents either a comment, a section name or an option\. +. +.P +Any line beginning with a hash (#) is ignored, as are lines containing only whitespace\. +. +.P +The file consists of one \fB[lint]\fR section, up to one \fB[errors]\fR section, and then any number of plugin\-specific sections, documented below\. (Note that this makes it quite feasible to combine your \fBbcfg2\-lint\.conf\fR into your \fBbcfg2\.conf\fR(5) file, if you so desire)\. +. +.SH "GLOBAL OPTIONS" +These options apply to \fBbcfg2\-lint\fR generally, and must be in the \fB[lint]\fR section\. +. .TP -.BR Comments - -The -.I Comments -plugin configuration specifies which VCS keywords and comments are -required for which file types. The valid types of file are -.I "global" -(all file types), -.I "bundler" -(non-templated bundle files), -.I "sgenshi" -(templated bundle files), -.I "properties" -(property files), -.I "cfg" -(non-templated Cfg files), -.I "tgenshi" -(templated Cfg files), -.I "infoxml" -(info.xml files), and -.I "probe" -(probe files). - -The specific types (i.e., types other than "global") all supplement -global; they do not override it. The exception is if you specify an -empty option, e.g.: - -.nf +\fBplugins\fR +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 \fBbcfg2\-lint\fR(8) for a list of the available plugins\. +. +.SH "ERROR HANDLING" +Error handling is configured in the \fB[errors]\fR section\. Each option should be the name of an error and one of \fIerror\fR, \fIwarning\fR, or \fIsilent\fR, which tells \fBbcfg2\-lint\fR(8) how to handle the warning\. Error names and their defaults can be displayed by running \fBbcfg2\-lint\fR(8) with the \fB\-\-list\-errors\fR option\. +. +.SH "PLUGIN OPTIONS" +These options apply only to a single plugin\. Each option should be in a section named for its plugin; for instance, options for the InfoXML plugin would be in a section called \fB[InfoXML]\fR\. +. +.P +If a plugin is not listed below, then it has no configuration\. +. +.P +In many cases, the behavior of a plugin can be configured by modifying how errors from it are handled\. See \fI\fBERROR HANDLING\fR\fR, above\. +. +.SS "Comments" +The \fBComments\fR plugin configuration specifies which VCS keywords and comments are required for which file types\. The valid types of file are \fIglobal\fR (all file types), \fIbundler\fR (non\-templated bundle files), \fIsgenshi\fR (templated bundle files), \fIproperties\fR (property files), \fIcfg\fR (non\-templated Cfg files), \fItgenshi\fR (templated Cfg files), \fIinfoxml\fR (info\.xml files), and \fIprobe\fR (probe files)\. +. +.P +The specific types (i\.e\., types other than "global") all supplement global; they do not override it\. The exception is if you specify an empty option, e\.g\.: +. +.P cfg_keywords = -.fi - -By default, the -.I $Id$ -keyword is checked for and nothing else. - -Multiple keywords or comments should be comma-delimited. - -\(bu -.B <type>_keywords - -Ensure that files of the specified type have the given VCS keyword. -Do -.I not -include the dollar signs. I.e.: - -.nf +. +.P +By default, the \fI$Id$\fR keyword is checked for and nothing else\. +. +.P +Multiple keywords or comments should be comma\-delimited\. +. +.P +· \fB<type>_keywords\fR +. +.P +Ensure that files of the specified type have the given VCS keyword\. Do \fInot\fR include the dollar signs\. I\.e\.: +. +.P infoxml_keywords = Revision -.fi - -.I not: - -.nf +. +.P +\fInot\fR: +. +.P infoxml_keywords = $Revision$ -.fi - -\(bu -.B <type>_comments - -Ensure that files of the specified type have a comment containing the -given string. In XML files, only comments are checked. In plain text -files, all lines are checked since comment characters may vary. - +. +.P +\fB· <type>_comments\fR +. +.P +Ensure that files of the specified type have a comment containing the given string\. In XML files, only comments are checked\. In plain text files, all lines are checked since comment characters may vary\. +. +.SS "InfoXML" +. .TP -.BR InfoXML - -\(bu -.B required_attrs -A comma-delimited list of attributes to require on -.I <Info> -tags. Default is "owner,group,perms". - +\fBrequired_attrs\fR +A comma\-delimited list of attributes to require on \fB<Info>\fR tags\. Default is "owner,group,perms"\. +. +.SS "MergeFiles" +. .TP -.BR MergeFiles - -\(bu -.B threshold -The threshold at which MergeFiles will suggest merging config files -and probes. Default is 75% similar. - +\fBthreshold\fR +The threshold at which MergeFiles will suggest merging config files and probes\. Default is 75% similar\. +. +.SS "Validate" +. .TP -.BR Validate - -\(bu -.B schema -The full path to the XML Schema files. Default is -"/usr/share/bcfg2/schema". This can be overridden with the -.I --schema -command-line option - -.SH SEE ALSO -.BR bcfg2-lint(8) - +\fBschema\fR +The full path to the XML Schema files\. Default is \fB/usr/share/bcfg2/schema\fR\. This can be overridden with the \fI\-\-schema\fR command\-line option +. +.SH "SEE ALSO" +bcfg2\-lint(8) diff --git a/man/bcfg2-ping-sweep.8 b/man/bcfg2-ping-sweep.8 index 54eaa8e76..709f0eed6 100644 --- a/man/bcfg2-ping-sweep.8 +++ b/man/bcfg2-ping-sweep.8 @@ -1,20 +1,14 @@ -.TH "bcfg2-ping-sweep" 8 -.SH NAME -bcfg2-ping-sweep \- Update pingable and pingtime attributes in -clients.xml -.SH SYNOPSIS -.B bcfg2-ping-sweep +. +.TH "BCFG2\-PING\-SWEEP" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-ping\-sweep\fR \- Update pingable and pingtime attributes in clients\.xml +. +.SH "SYNOPSIS" +\fBbcfg2\-ping\-sweep\fR +. .SH "DESCRIPTION" -.PP -\fBbcfg2-ping-sweep\fR traverses the list of clients in -Metadata/clients.xml and updates their pingable/pingtime attributes. The -pingtime value is set to the last time the client was pinged (not the -RTT value). -.SH OPTIONS -.PP -.B None +\fBbcfg2\-ping\-sweep\fR traverses the list of clients in Metadata/clients\.xml and updates their pingable/pingtime attributes\. The pingtime value is set to the last time the client was pinged (not the RTT value)\. +. .SH "SEE ALSO" -.BR bcfg(1), -.BR bcfg2-server(8) -.SH "BUGS" -None currently known +bcfg2(1), bcfg2\-server(8) diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index 51399e1c9..f1091eb31 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -1,94 +1,76 @@ -.TH "bcfg2-reports" 8 -.SH NAME -bcfg2-reports \- Query reporting system for client status -.SH SYNOPSIS -.B bcfg2-reports -.I [-v] -.SH DESCRIPTION -.PP -\fBbcfg2-reports\fR allows you to retrieve data from the database about -clients, and the states of their current interactions. It also allows -you to change the expired/unexpired states. -The utility runs as a standalone application. It does, however, use -the models from /src/lib/Server/Reports/reports/models.py. -.SH OPTIONS -.PP -.B "\-a" -.RS -Shows all hosts, including expired hosts. -.RE -.B "\-b NAME" -.RS -Single-host mode \- shows bad entries from the current interaction of -NAME. NAME is the name of the entry. -.RE -.B "-c\" -.RS -Shows only clean hosts. -.RE -.B "\-d" -.RS -Shows only dirty hosts. -.RE -.B "\-e NAME" -.RS -Single host mode \- shows extra entries from the current interaction -of NAME. NAME is the name of the entry. -.RE -.B "\-h" -.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, modified, and extra entries from the -current interaction of NAME. NAME is the name of the entry. -.RE -.B "\-x NAME" -.RS -Toggles expired/unexpired state of NAME. NAME is the name of the entry. -.RE -.B "\-\-badentry=KIND,NAME" -.RS -Shows only hosts whose current interaction has bad 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 "\-\-extraentry=KIND,NAME" -.RS -Shows only hosts whose current interaction has extra 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 "\-\-fields=ARG1,ARG2,..." -.RS -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, total, good, bad) -.RE -.B "\-\-stale" -.RS -Shows hosts which haven't run in the last 24 hours -.RE +. +.TH "BCFG2\-REPORTS" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-reports\fR \- Query reporting system for client status +. +.SH "SYNOPSIS" +\fBbcfg2\-reports\fR [\-a] [\-b \fINAME\fR] [\-c] [\-d] [\-e \fINAME\fR] [\-h] [\-m \fINAME\fR] [\-s \fINAME\fR] [\-x \fINAME\fR] [\-\-badentry=\fIKIND,NAME\fR] [\-\-extraentry=\fIKIND,NAME\fR] [\-\-fields=<ARG1,ARG2,\.\.\.>] [\-\-modifiedentry=\fIKIND,NAME\fR] [\-\-sort=<ARG1,ARG2,\.\.\.>] [\-\-stale] [\-v] +. +.SH "DESCRIPTION" +\fBbcfg2\-reports\fR allows you to retrieve data from the database about clients, and the states of their current interactions\. It also allows you to change the expired/unexpired states\. The utility runs as a standalone application\. It does, however, use the models from \fB/src/lib/Server/Reports/reports/models\.py\fR\. +. +.SH "OPTIONS" +. +.TP +\fB\-a\fR +Specify alternate bcfg2\.conf location +. +.TP +\fB\-b\fR \fIhostname\fR +Single host mode \- shows bad entries from the current interaction of \fIhostname\fR\. +. +.TP +\fB\-c\fR +Shows only clean hosts\. +. +.TP +\fB\-d\fR +Shows only dirty hosts\. +. +.TP +\fB\-e\fR \fIhostname\fR +Single host mode \- shows extra entries from the current interaction of \fIhostname\fR\. +. +.TP +\fB\-h\fR +Shows help and usage info about \fBbcfg2\-reports\fR\. +. +.TP +\fB\-m\fR \fIhostname\fR +Single host mode \- shows modified entries from the current interaction of \fIhostname\fR\. +. +.TP +\fB\-s\fR \fIhostname\fR +Single host mode \- shows bad, modified, and extra entries from the current interaction of \fIhostname\fR\. +. +.TP +\fB\-x\fR \fIhostname\fR +Toggles expired/unexpired state of \fIhostname\fR\. +. +.TP +\fB\-\-badentry=\fR\fIentry type, entry name\fR +Shows only hosts whose current interaction has bad entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\. +. +.TP +\fB\-\-extraentry=\fR\fIentry type, entry name\fR +Shows only hosts whose current interaction has extra entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\. +. +.TP +\fB\-\-fields=\fR<ARG1,ARG2,\.\.\.> +Only displays the fields \fIARG1,ARG2,\.\.\.\fR (name, time, state, total, good, bad)\. +. +.TP +\fB\-\-modifiedentry=\fR\fIentry type, entry name\fR +Shows only hosts whose current interaction has modified entries of type \fIentry type\fR and name \fIentry name\fR\. If a single argument ARG1 is given, then \fIentry type\fR,\fIentry name\fR pairs will be read from a file of name ARG1\. +. +.TP +\fB\-\-sort=\fR<ARG1,ARG2,\.\.\.> +Sorts output on ARG1,ARG2,\.\.\. (name, time, state, total, good, bad)\. +. +.TP +\fB\-\-stale\fR +Shows hosts which haven’t run in the last 24 hours\. +. .SH "SEE ALSO" -.BR bcfg2(1), -.BR bcfg2-server(8) -.SH "BUGS" -None currently known +bcfg2(1), bcfg2\-server(8) diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index 2d132ce6d..b1a3a7703 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -1,58 +1,48 @@ -.TH "bcfg2-server" 8 -.SH NAME -bcfg2-server \- Server for client configuration specifications -.SH SYNOPSIS -.B bcfg2-server -.I [-D <pidfile>] [-d] [-v] [-C <Client>] -.SH DESCRIPTION -.PP -.B bcfg2-server -This daemon serves configurations to clients based on the data in its -repository. -.SH OPTIONS -.PP -.B \-d -.RS -Run bcfg2 in debug mode. -.RE -.B \-v -.RS -Run bcfg2 in verbose mode. -.RE -.B "\-C <ConfigFile Path>" -.RS -Use an alternative path for bcfg2.conf. The default is /etc/bcfg2.conf -.RE -.B \-D -.RS -Daemonize, placing the program pid in the specified pidfile. -.RE -.B \-o <LogFile Path> -.RS -Writes a log to the specified path. -.RE -.B \-E <encoding> -.RS -Unicode encoding of config files. -.RE -.B \-x <password> -.RS -Set server password. -.RE -.B \-S <server url> -.RS -Set server address. -.RE -.B \-Q <repo path> -.RS -Set repository path. -.RE -.B \-\-ssl\-key=<ssl key> -.RS -Set path to SSL key. -.RE +. +.TH "BCFG2\-SERVER" "8" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\-server\fR \- Server for client configuration specifications +. +.SH "SYNOPSIS" +\fBbcfg2\-server\fR [\-d] [\-v] [\-C \fIconfigfile\fR] [\-D \fIpidfile\fR] [\-E \fIencoding\fR] [\-Q \fIrepo path\fR] [\-S \fIserver url\fR] [\-o \fIlogfile\fR] [\-x \fIpassword\fR] [\-\-ssl\-key=\fIssl key\fR] +. +.SH "DESCRIPTION" +\fBbcfg2\-server\fR is the daemon component of Bcfg2 which serves configurations to clients based on the data in its repository\. +. +.SH "OPTIONS" +. +.TP +\fB\-C\fR \fIconfigfile\fR +Specify alternate bcfg2\.conf location\. +. +.TP +\fB\-D\fR \fIpidfile\fR +Daemonize, placing the program pid in the specified pidfile\. +. +.TP +\fB\-E\fR \fIencoding\fR +Specify alternate encoding (default is UTF\-8)\. +. +.TP +\fB\-Q\fR \fIrepo path\fR +Set repository path\. +. +.TP +\fB\-S\fR \fIserver url\fR +Set server address\. +. +.TP +\fB\-d\fR +Run \fBbcfg2\-server\fR in debug mode\. +. +.TP +\fB\-v\fR +Run \fBbcfg2\-server\fR in verbose mode\. +. +.TP +\fB\-\-ssl\-key=\fR\fIssl key\fR +Set path to SSL key\. +. .SH "SEE ALSO" -.BR bcfg2(1), -.BR bcfg2-lint(8) -.SH "BUGS" -None currently known +bcfg2(1), bcfg2\-lint(8) diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 661153a15..d0f0e0062 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -1,180 +1,167 @@ -.TH "bcfg2" 1 -.SH NAME -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] [\-z] [\-b bundle] [\-r removal mode] [\-\-ca\-cert=file] [\-\-ssl\-cns=list] [\-\-ssl\-cert=file] [\-\-ssl\-key=file] -.SH DESCRIPTION -.TP -.BR bcfg2 -Runs the Bcfg2 configuration process on the current host. This process -consists of first fetching and executing probes, uploading probe -results, fetching the client configuration, checking the current -client state, attempting to install the desired configuration, and -finally uploading statistics about the Bcfg2 execution and client -state. - -.SH OPTIONS -.TP -.BR "\-C <configfile>" -Specify alternate bcfg2.conf location. - -.TP -.BR "\-D <driver1>,<driver2>" -Specify a set of Bcfg2 tool drivers. NOTE: only drivers listed will be -loaded. (IE, if you don't include POSIX, you will be unable to -verify/install ConfigFiles, etc). - -.TP -.BR "\-E <encoding>" -Specify the encoding of Cfg files. - -.TP -.BR "\-I" -Run bcfg2 in interactive mode. The user will be prompted before each -change. - -.TP -.BR "\-O" -Omit lock check. - -.TP -.BR "\-P" -Run bcfg2 in paranoid mode. Diffs will be logged for -configuration files marked as paranoid by the Bcfg2 server. - -.TP -.BR "\-R <retry count>" -Specify the number of times that the client will attempt to retry -network communication. - -.TP -.BR "\-S https://server:port" -Manually specify the server location (as opposed to using the value in -bcfg2.conf). - -.TP -.BR "\-b <bundle1>:<bundle2>" -Run bcfg2 against one or multiple bundles in the configuration. - -.TP -.BR "\-c <cachefile>" -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. - -.TP -.BR "\-e" -When in verbose mode, display extra entry information (temporary until -verbosity rework). - -.TP -.BR "\-f <specification path>" -Configure from a file rather than querying the server. - -.TP -.BR "\-h" -Print Usage information. - -.TP -.BR "\-k" -Run in bulletproof mode. This currently only affects behavior in the -debian toolset; it calls apt\-get update and clean and -dpkg \-\-configure \-\-pending. - -.TP -.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 -administrators and much configuration variety. (This setting will be -ignored if the -f option is also specified.) - -.TP -.BR "\-n" -Run bcfg2 in dry\-run mode. No changes will be made to the -system. - -.TP -.BR "\-o <LogFile Path>" -Writes a log to the specified path. - -.TP -.BR "\-p <profile>" -Assert a profile for the current client. - -.TP -.BR "\-q" -Run bcfg2 in quick mode. Package checksum verification won't be -performed. This mode relaxes the constraints of correctness, and thus -should only be used in safe conditions. - -.TP -.BR "\-Q" -Run bcfg2 in "bundle quick" mode, where only entries in a bundle are -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. - -.TP -.BR "\-r <mode>" -Cause bcfg2 to remove extra configuration elements it detects. Mode is -one of all, Services, or Packages. All removes all entries. Likewise, -Services and Packages remove only the extra configuration elements of -the respective type. - -.TP -.BR "\-s <service mode>" -Set bcfg2 interaction level for services. Default behavior is to -modify all services affected by reconfiguration. build mode attempts -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. - -.TP -.BR "\-u <user>" -Attempt to authenticate as 'user'. - -.TP -.BR "\-x <password>" -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 +. +.TH "BCFG2" "1" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\fR \- Bcfg2 client tool +. +.SH "SYNOPSIS" +\fBbcfg2\fR [\fIoptions\fR][\fI\.\.\.\fR] +. +.SH "DESCRIPTION" +\fBbcfg2\fR runs the Bcfg2 configuration process on the current host\. This process consists of the following steps\. +. +.IP "\(bu" 4 +Fetch and execute probes +. +.IP "\(bu" 4 +Upload probe results +. +.IP "\(bu" 4 +Fetch the client configuration +. +.IP "\(bu" 4 +Check the current client state +. +.IP "\(bu" 4 +Attempt to install the desired configuration +. +.IP "\(bu" 4 +Upload statistics about the Bcfg2 execution and client state +. +.IP "" 0 +. +.SH "OPTIONS" +. +.TP +\fB\-C\fR \fIconfigfile\fR +Specify alternate bcfg2\.conf location +. +.TP +\fB\-D\fR [\fIdriver1\fR,\fIdriver2\fR] +Specify a set of Bcfg2 tool drivers\. +. +.IP +\fINOTE: only drivers listed will be loaded\. (e\.g\., if you do not include POSIX, you will be unable to verify/install Path entries)\.\fR +. +.TP +\fB\-E\fR \fIencoding\fR +Specify the encoding of Cfg files\. +. +.TP +\fB\-I\fR +Run bcfg2 in interactive mode\. The user will be prompted before each change\. +. +.TP +\fB\-O\fR +Omit lock check +. +.TP +\fB\-P\fR +Run bcfg2 in paranoid mode\. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server\. +. +.TP +\fB\-R\fR \fIretry count\fR +Specify the number of times that the client will attempt to retry network communication\. +. +.TP +\fB\-S\fR \fIhttps://server:port\fR +Manually specify the server location (as opposed to using the value in bcfg2\.conf)\. +. +.TP +\fB\-b\fR [\fIbundle1:bundle2\fR] +Run bcfg2 against one or multiple bundles in the configuration\. +. +.TP +\fB\-c\fR \fIcachefile\fR +Cache a copy of the configuration in cachefile\. +. +.TP +\fB\-\-ca\-cert=\fR\fIca cert\fR +Specifiy the path to the SSL CA certificate\. +. +.TP +\fB\-d\fR +Run bcfg2 in debug mode\. +. +.TP +\fB\-e\fR +When in verbose mode, display extra entry information (temporary until verbosity rework)\. +. +.TP +\fB\-f\fR \fIspecification path\fR +Configure from a file rather than querying the server\. +. +.TP +\fB\-h\fR +Print Usage information\. +. +.TP +\fB\-k\fR +Run in bulletproof mode\. This currently only affects behavior in the debian toolset; it calls apt\-get update and clean and dpkg \-\-configure \-\-pending\. +. +.TP +\fB\-l\fR \fIwhitelist|blacklist|none\fR +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 administrators and much configuration variety\. (This setting will be ignored if the \-f option is also specified)\. +. +.TP +\fB\-n\fR +Run bcfg2 in dry\-run mode\. No changes will be made to the system\. +. +.TP +\fB\-o\fR \fIlogfile path\fR +Writes a log to the specified path\. +. +.TP +\fB\-p\fR \fIprofile\fR +Assert a profile for the current client\. +. +.TP +\fB\-q\fR +Run bcfg2 in quick mode\. Package checksum verification won’t be performed\. This mode relaxes the constraints of correctness, and thus should only be used in safe conditions\. +. +.TP +\fB\-Q\fR +Run bcfg2 in "bundle quick" mode, where only entries in a bundle are 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\. +. +.TP +\fB\-r\fR \fImode\fR +Cause bcfg2 to remove extra configuration elements it detects\. Mode is one of all, Services, or Packages\. All removes all entries\. Likewise, Services and Packages remove only the extra configuration elements of the respective type\. +. +.TP +\fB\-s\fR \fIservice mode\fR +Set bcfg2 interaction level for services\. Default behavior is to modify all services affected by reconfiguration\. build mode attempts to stop all services started\. disabled suppresses all attempts to modify services +. +.TP +\fB\-\-ssl\-cert=\fR\fIssl cert\fR +Specifiy the path to the SSL certificate\. +. +.TP +\fB\-\-ssl\-cns=\fR[\fICN1:CN2\fR] +List of acceptable SSL server Common Names\. +. +.TP +\fB\-\-ssl\-key=\fR\fIssl key\fR +Specifiy the path to the SSL key\. +. +.TP +\fB\-u\fR \fIuser\fR +Attempt to authenticate as ’user’\. +. +.TP +\fB\-x\fR \fIpassword\fR +Use ’password’ for client communication\. +. +.TP +\fB\-t\fR \fItimeout\fR +Set the timeout (in seconds) for client communication\. Default is 90 seconds\. +. +.TP +\fB\-v\fR +Run bcfg2 in verbose mode\. +. +.TP +\fB\-z\fR +Only configure independent entries, ignore bundles\. +. .SH "SEE ALSO" -.BR bcfg2-server(8), -.BR bcfg2-info(8) -.SH "BUGS" +bcfg2\-server(8), bcfg2\-info(8) diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index 812a86c76..2cb387cad 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -1,458 +1,395 @@ -.TH bcfg2.conf 5 - -.SH NAME -bcfg2.conf - configuration parameters for Bcfg2 - -.SH DESCRIPTION -.TP -bcfg2.conf includes configuration parameters for the Bcfg2 server and -client. - -.SH FILE FORMAT -The file is INI-style and consists of sections and options. A section -begins with the name of the sections in square brackets and continues -until the next section begins. - -Options are specified in the form 'name = value'. - -The file is line-based each newline-terminated line represents either -a comment, a section name or an option. - -Any line beginning with a hash (#) is ignored, as are lines containing -only whitespace. - - -.SH SERVER OPTIONS -These options are only necessary on the Bcfg2 server. They are -specified in the [server] section of the configuration file. - -.TP -.B repository -Specifies the path to the Bcfg2 repository containing all of the -configuration specifications. The repository should be created -using the 'bcfg2-admin init' command. - -.TP -.B filemonitor -The file monitor used to watch for changes in the repository. -Values of 'inotify', 'gamin', 'fam', or 'pseudo' are valid. The -default is the best available monitor. - -.TP -.B ignore_files -A comma-separated list of globs that should be ignored by the file -monitor. Default: '*~,.#*,*#,*.swp,SCCS,.svn,4913,.gitignore' - -.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: - -\(bu -.B Account -The account plugin manages authentication data, including: - - * /etc/passwd - * /etc/group - * /etc/security/limits.conf - * /etc/sudoers - * /root/.ssh/authorized_keys - -\(bu -.B Actions - -Action entries are commands that are executed either before bundle -installation, after bundle installation or both. If exit status is -observed, a failing pre-action will cause no modification of the -enclosing bundle to be performed; all entries included in that bundle -will not be modified. Failing actions are reported through Bcfg2's -reporting system, so they can be centrally observed. - -\(bu -.B BB -The BB plugin maps users to machines and metadata to machines. -(experimental) - -\(bu -.B Base -A structure plugin that provides the ability to add lists of unrelated -entries into client configuration entry inventories. Base works much -like Bundler in its file format. This structure plugin is good for -the pile of independent configs needed for most actual systems. - -\(bu -.B Bundler -Bundler is used to describe groups of inter-dependent configuration -entries, such as the combination of packages, configuration files, -and service activations that comprise typical Unix daemons. Bundles -are used to add groups of configuration entries to the inventory of -client configurations, as opposed to describing particular versions -of those -entries. - -\(bu -.B Bzr -The Bzr plugin allows you to track changes to your Bcfg2 repository -using a GNU Bazaar version control backend. Currently, it enables -you to get revision information out of your repository for reporting -purposes. - -\(bu -.B Cfg -The Cfg plugin provides a repository to describe configuration file -contents for clients. In its simplest form, the Cfg repository is -just a directory tree modeled off of the directory tree on your client -machines. - -\(bu -.B Cvs -The Cvs plugin allows you to track changes to your Bcfg2 repository -using a Concurrent version control backend. Currently, it enables you -to get revision information out of your repository for reporting -purposes. (experimental) - -\(bu -.B Darcs -The Darcs plugin allows you to track changes to your Bcfg2 repository -using a Darcs version control backend. Currently, it enables you to -get revision information out of your repository for reporting purposes. -(experimental) - -\(bu -.B DBStats -Direct to database statistics plugin. (0.9.6 and later) - -\(bu -.B Decisions -The Decisions plugin has support for a centralized set of per-entry -installation decisions. This approach is needed when particular -changes are deemed "high risk"; this gives the ability to centrally -specify these changes, but only install them on clients when -administrator supervision is available. (0.9.6 and later) - -\(bu -.B Deps -The Deps plugin allows you to make a series of assertions like -"Package X requires Package Y (and optionally also Package Z etc.)" - -\(bu -.B Editor -The Editor plugin allows you to partially manage configuration for -a file. Its use is not recommended and not well documented. - -\(bu -.B Fossil -The Fossil plugin allows you to track changes to your Bcfg2 repository -using a Fossil SCM version control backend. Currently, it enables -you to get revision information out of your repository for reporting -purposes. - -\(bu -.B Git -The Git plugin allows you to track changes to your Bcfg2 repository -using a Git version control backend. Currently, it enables you to -get revision information out of your repository for reporting purposes. - -\(bu -.B GroupPatterns -The GroupPatterns plugin is a connector that can assign clients group -membership based on patterns in client hostnames. - -\(bu -.B Hg -The Hg plugin allows you to track changes to your Bcfg2 repository -using a Mercurial version control backend. Currently, it enables you -to get revision information out of your repository for reporting -purposes. (experimental) - -\(bu -.B Hostbase -The Hostbase plugin is an IP management system built on top of Bcfg2. - -\(bu -.B Metadata -The Metadata plugin is the primary method of specifying Bcfg2 server -metadata. - -\(bu -.B NagiosGen -NagiosGen is a Bcfg2 plugin that dynamically generates Nagios -configuration files based on Bcfg2 data. - -\(bu -.B Ohai -The Ohai plugin is used to detect information about the client -operating system. The data is reported back to the server using -JSON. (experimental) - -\(bu -.B POSIXCompat -The POSIXCompat plugin provides a compatibility layer which turns -new-style (1.0) POSIX entries into old-style entries which are -compatible with previous releases. - -\(bu -.B Packages -The Packages plugin is an alternative to Pkgmgr for specifying -package entries for clients. Where Pkgmgr explicitly specifies -package entry information, Packages delegates control of package -version information to the underlying package manager, installing -the latest version available from through those channels. - -\(bu -.B Pkgmgr -The Pkgmgr plugin resolves the Abstract Configuration Entity -"Package" to a package specification that the client can use to -detect, verify and install the specified package. - -\(bu -.B Probes -The Probes plugin gives you the ability to gather information from a -client machine before you generate its configuration. This information -can be used with the various templating systems to generate -configuration based on the results. - -\(bu -.B Properties -The Properties plugin is a connector plugin that adds information -from properties files into client metadata instances. (1.0 and later) - -\(bu -.B Rules -The Rules plugin resolves Abstract Configuration Entities to literal -configuration entries suitable for the client drivers to consume. - -\(bu -.B SGenshi (Deprecated) -See Bundler. - -\(bu -.B Snapshots -The Snapshots plugin stores various aspects of a client's state when -the client checks in to the server. - -\(bu -.B SSHbase -The SSHbase generator plugin manages ssh host keys (both v1 and v2) -for hosts. It also manages the ssh_known_hosts file. It can integrate -host keys from other management domains and similarly export its keys. - -\(bu -.B Svn -The Svn plugin allows you to track changes to your Bcfg2 repository -using a Subversion backend. Currently, it enables you to get revision -information out of your repository for reporting purposes. - -\(bu -.B TCheetah -The TCheetah plugin allows you to use the cheetah templating system -to create files. It also allows you to include the results of probes -executed on the client in the created files. - -\(bu -.B TGenshi -The TGenshi plugin allows you to use the Genshi templating system to -create files. It also allows you to include the results of probes -executed on the client in the created files. - -\(bu -.B Trigger -Trigger is a plugin that calls external scripts when clients are -configured. - -.TP -.B prefix -Specifies a prefix if the Bcfg2 installation isn't placed in the -default location (eg. /usr/local). - -.SH MDATA OPTIONS -These options affect the default metadata settings for Paths with -type='file'. - -.TP -.B owner +. +.TH "BCFG2\.CONF" "5" "June 2012" "" "" +. +.SH "NAME" +\fBbcfg2\.conf\fR \- configuration parameters for Bcfg2 +. +.SH "DESCRIPTION" +\fBbcfg2\.conf\fR includes configuration parameters for the Bcfg2 server and client\. +. +.SH "FILE FORMAT" +The file is INI\-style and consists of sections and options\. A section begins with the name of the sections in square brackets and continues until the next section begins\. +. +.P +Options are specified in the form "name=value"\. +. +.P +The file is line\-based each newline\-terminated line represents either a comment, a section name or an option\. +. +.P +Any line beginning with a hash (#) is ignored, as are lines containing only whitespace\. +. +.SH "SERVER OPTIONS" +These options are only necessary on the Bcfg2 server\. They are specified in the \fB[server]\fR section of the configuration file\. +. +.TP +\fBrepository\fR +Specifies the path to the Bcfg2 repository containing all of the configuration specifications\. The repository should be created using the \fBbcfg2\-admin init\fR command\. +. +.TP +\fBfilemonitor\fR +The file monitor used to watch for changes in the repository\. The default is the best available monitor\. The following values are valid: +. +.IP +\fBinotify\fR, \fBgamin\fR, \fBfam\fR, \fBpseudo\fR +. +.TP +\fBignore_files\fR +A comma\-separated list of globs that should be ignored by the file monitor\. Default values are: +. +.IP +\fB*~\fR, \fB*#\fR, \fB\.#*\fR, \fB*\.swp\fR, \fB\.*\.swx\fR, \fBSCCS\fR, \fB\.svn\fR, \fB4913\fR, \fB\.gitignore\fR +. +.TP +\fBlisten_all\fR +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 \fBbcfg2\.conf\fR\. +. +.TP +\fBplugins\fR +A comma\-delimited list of enabled server plugins\. Currently available plugins are: +. +.IP +\fBAccount\fR, \fBActions\fR, \fBBB\fR, \fBBase\fR, \fBBundler\fR, \fBBzr\fR, \fBCfg\fR, \fBCvs\fR, \fBDarcs\fR, \fBDBStats\fR, \fBDecisions\fR, \fBDeps\fR, \fBEditor\fR, \fBFossil\fR, \fBGit\fR, \fBGroupPatterns\fR, \fBHg\fR, \fBHostbase\fR, \fBMetadata\fR, \fBNagiosGen\fR, \fBOhai\fR, \fBPackages\fR, \fBPkgmgr\fR, \fBProbes\fR, \fBProperties\fR, \fBRules\fR, \fBSGenshi\fR, \fBSnapshots\fR, \fBSSHbase\fR, \fBSvn\fR, \fBSvn2\fR, \fBTCheetah\fR, \fBTGenshi\fR, \fBTrigger\fR +. +.IP +Descriptions of each plugin can be found in their respective sections below\. +. +.TP +\fBprefix\fR +Specifies a prefix if the Bcfg2 installation isn’t placed in the default location (e\.g\. /usr/local)\. +. +.SS "Account Plugin" +The account plugin manages authentication data, including the following\. +. +.IP "\(bu" 4 +\fB/etc/passwd\fR +. +.IP "\(bu" 4 +\fB/etc/group\fR +. +.IP "\(bu" 4 +\fB/etc/security/limits\.conf\fR +. +.IP "\(bu" 4 +\fB/etc/sudoers\fR +. +.IP "\(bu" 4 +\fB/root/\.ssh/authorized_keys\fR +. +.IP "" 0 +. +.SS "BB Plugin" +The BB plugin maps users to machines and metadata to machines\. +. +.SS "Base Plugin" +A structure plugin that provides the ability to add lists of unrelated entries into client configuration entry inventories\. Base works much like Bundler in its file format\. This structure plugin is good for the pile of independent configs needed for most actual systems\. +. +.SS "Bundler Plugin" +Bundler is used to describe groups of inter\-dependent configuration entries, such as the combination of packages, configuration files, and service activations that comprise typical Unix daemons\. Bundles are used to add groups of configuration entries to the inventory of client configurations, as opposed to describing particular versions of those entries\. +. +.SS "Bzr Plugin" +The Bzr plugin allows you to track changes to your Bcfg2 repository using a GNU Bazaar version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "Cfg Plugin" +The Cfg plugin provides a repository to describe configuration file contents for clients\. In its simplest form, the Cfg repository is just a directory tree modeled off of the directory tree on your client machines\. +. +.SS "Cvs Plugin (experimental)" +The Cvs plugin allows you to track changes to your Bcfg2 repository using a Concurrent version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "Darcs Plugin (experimental)" +The Darcs plugin allows you to track changes to your Bcfg2 repository using a Darcs version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "DBStats Plugin" +Direct to database statistics plugin\. +. +.SS "Decisions Plugin" +The Decisions plugin has support for a centralized set of per\-entry installation decisions\. This approach is needed when particular changes are deemed "\fIhigh risk\fR"; this gives the ability to centrally specify these changes, but only install them on clients when administrator supervision is available\. +. +.SS "Deps Plugin" +The Deps plugin allows you to make a series of assertions like "Package X requires Package Y (and optionally also Package Z etc\.)" +. +.SS "Editor Plugin" +The Editor plugin attempts to allow you to partially manage configuration for a file\. Its use is not recommended and not well documented\. +. +.SS "Fossil Plugin" +The Fossil plugin allows you to track changes to your Bcfg2 repository using a Fossil SCM version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "Git Plugin" +The Git plugin allows you to track changes to your Bcfg2 repository using a Git version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "GroupPatterns Plugin" +The GroupPatterns plugin is a connector that can assign clients group membership based on patterns in client hostnames\. +. +.SS "Hg Plugin (experimental)" +The Hg plugin allows you to track changes to your Bcfg2 repository using a Mercurial version control backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "Hostbase Plugin" +The Hostbase plugin is an IP management system built on top of Bcfg2\. +. +.SS "Metadata Plugin" +The Metadata plugin is the primary method of specifying Bcfg2 server metadata\. +. +.SS "NagiosGen Plugin" +NagiosGen is a Bcfg2 plugin that dynamically generates Nagios configuration files based on Bcfg2 data\. +. +.SS "Ohai Plugin (experimental)" +The Ohai plugin is used to detect information about the client operating system\. The data is reported back to the server using JSON\. +. +.SS "Packages Plugin" +The Packages plugin is an alternative to Pkgmgr for specifying package entries for clients\. Where Pkgmgr explicitly specifies package entry information, Packages delegates control of package version information to the underlying package manager, installing the latest version available from through those channels\. +. +.SS "Pkgmgr Plugin" +The Pkgmgr plugin resolves the Abstract Configuration Entity "Package" to a package specification that the client can use to detect, verify and install the specified package\. +. +.SS "Probes Plugin" +The Probes plugin gives you the ability to gather information from a client machine before you generate its configuration\. This information can be used with the various templating systems to generate configuration based on the results\. +. +.SS "Properties Plugin" +The Properties plugin is a connector plugin that adds information from properties files into client metadata instances\. +. +.SS "Rules Plugin" +The Rules plugin provides literal configuration entries that resolve the abstract configuration entries normally found in the Bundler and Base plugins\. The literal entries in Rules are suitable for consumption by the appropriate client drivers\. +. +.SS "Snapshots Plugin" +The Snapshots plugin stores various aspects of a client’s state when the client checks in to the server\. +. +.SS "SSHbase Plugin" +The SSHbase generator plugin manages ssh host keys (both v1 and v2) for hosts\. It also manages the ssh_known_hosts file\. It can integrate host keys from other management domains and similarly export its keys\. +. +.SS "Svn Plugin" +The Svn plugin allows you to track changes to your Bcfg2 repository using a Subversion backend\. Currently, it enables you to get revision information out of your repository for reporting purposes\. +. +.SS "Svn2 Plugin" +The Svn2 plugin extends on the capabilities in the Svn plugin\. It provides Update and Commit methods which provide hooks for modifying subversion\-backed Bcfg2 repositories\. +. +.SS "TCheetah Plugin" +The TCheetah plugin allows you to use the cheetah templating system to create files\. It also allows you to include the results of probes executed on the client in the created files\. +. +.SS "TGenshi Plugin" +The TGenshi plugin allows you to use the Genshi templating system to create files\. It also allows you to include the results of probes executed on the client in the created files\. +. +.SS "Trigger Plugin" +The Trigger plugin provides a method for calling external scripts when clients are configured\. +. +.SH "CLIENT OPTIONS" +These options only affect client functionality, specified in the \fB[client]\fR section\. +. +.TP +\fBdecision\fR +Specify the server decision list mode (whitelist or blacklist)\. (This settiing will be ignored if the client is called with the \-f option\.) +. +.TP +\fBdrivers\fR +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\. +. +.TP +\fBparanoid\fR +Run the client in paranoid mode\. +. +.SH "COMMUNICATION OPTIONS" +Specified in the \fB[communication]\fR section\. These options define settings used for client\-server communication\. +. +.TP +\fBca\fR +The path to a file containing the CA certificate\. This file is required on the server, and optional on clients\. However, if the cacert is not present on clients, the server cannot be verified\. +. +.TP +\fBcertificate\fR +The path to a file containing a PEM formatted certificate which signs the key with the ca certificate\. This setting is required on the server in all cases, and required on clients if using client certificates\. +. +.TP +\fBkey\fR +Specifies the path to a file containing the SSL Key\. This is required on the server in all cases, and required on clients if using client certificates\. +. +.TP +\fBpassword\fR +Required on both the server and clients\. On the server, sets the password clients need to use to communicate\. On a client, sets the password to use to connect to the server\. +. +.TP +\fBprotocol\fR +Communication protocol to use\. Defaults to xmlrpc/ssl\. +. +.TP +\fBretries\fR +A client\-only option\. Number of times to retry network communication\. +. +.TP +\fBserverCommonNames\fR +A client\-only option\. A colon\-separated list of Common Names the client will accept in the SSL certificate presented by the server\. +. +.TP +\fBuser\fR +A client\-only option\. The UUID of the client\. +. +.SH "COMPONENT OPTIONS" +Specified in the \fB[components]\fR section\. +. +.TP +\fBbcfg2\fR +URL of the server\. On the server this specifies which interface and port the server listens on\. On the client, this specifies where the client will attempt to contact the server\. +. +.IP +e\.g\. \fBbcfg2 = https://10\.3\.1\.6:6789\fR +. +.TP +\fBencoding\fR +Text encoding of configuration files\. Defaults to UTF\-8\. +. +.SH "LOGGING OPTIONS" +Specified in the \fB[logging]\fR section\. These options control the server logging functionality\. +. +.TP +\fBpath\fR +Server log file path\. +. +.SH "MDATA OPTIONS" +These options affect the default metadata settings for Paths with type=’file’\. +. +.TP +\fBowner\fR Global owner for Paths (defaults to root) - +. .TP -.B group +\fBgroup\fR Global group for Paths (defaults to root) - +. .TP -.B perms +\fBperms\fR Global permissions for Paths (defaults to 644) - +. .TP -.B paranoid +\fBparanoid\fR Global paranoid settings for Paths (defaults to false) - +. .TP -.B sensitive +\fBsensitive\fR Global sensitive settings for Paths (defaults to false) - - -.SH CLIENT OPTIONS -These options only affect client functionality, specified in the -[client] section. - -.TP -.B decision -Specify the server decision list mode (whitelist or blacklist). (This -setting will be ignored if the client is called with the -f option.) - -.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. - -.TP -.B paranoid -Run the client in paranoid mode. - - -.SH STATISTICS OPTIONS -Server-only, specified in the [statistics] section. These options -control the statistics collection functionality of the server. - -.TP -.B database_engine -The database engine used by the statistics module. One of either -\[oq]postgresql\[cq], \[oq]mysql\[cq], \[oq]sqlite3\[cq], or -\[oq]ado_mssql\[cq]. - -.TP -.B database_name -The name of the database to use for statistics data. If -\[oq]database_engine\[cq] is set to \[oq]sqlite3\[cq] this is a file -path to sqlite file and defaults to $REPOSITORY_DIR/etc/brpt.sqlite - -.TP -.B database_user -User for database connections. Not used for sqlite3. - -.TP -.B database_password -Password for database connections. Not used for sqlite3. - -.TP -.B database_host -Host for database connections. Not used for sqlite3. - -.TP -.B database_port -Port for database connections. Not used for sqlite3. - -.TP -.B time_zone -Specify a time zone other than that used on the system. (Note that this -will cause the bcfg2 server to log messages in this time zone as well). - - -.SH COMMUNICATION OPTIONS -Specified in the [communication] section. These options define -settings used for client-server communication. - -.TP -.B ca -The path to a file containing the CA certificate. This file is -required on the server, and optional on clients. However, if the -cacert is not present on clients, the server cannot be verified. - -.TP -.B certificate -The path to a file containing a PEM formatted certificate which -signs the key with the ca certificate. This setting is required on -the server in all cases, and required on clients if using client -certificates. - -.TP -.B key -Specifies the path to a file containing the SSL Key. This is required -on the server in all cases, and required on clients if using client -certificates. - -.TP -.B password -Required on both the server and clients. On the server, sets the -password clients need to use to communicate. On a client, sets the -password to use to connect to the server. - -.TP -.B protocol -Communication protocol to use. Defaults to xmlrpc/ssl. - -.TP -.B retries -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. - -.SH PARANOID OPTIONS -These options allow for finer-grained control of the paranoid mode -on the Bcfg2 client. They are specified in the [paranoid] section -of the configuration file. - -.TP -.B path -Custom path for backups created in paranoid mode. The default is in -/var/cache/bcfg2. - -.TP -.B max_copies -Specify a maximum number of copies for the server to keep when running -in paranoid mode. Only the most recent versions of these copies will -be kept. - -.SH COMPONENT OPTIONS -Specified in the [components] section. - -.TP -.B bcfg2 -URL of the server. On the server this specifies which interface and -port the server listens on. On the client, this specifies where the -client will attempt to contact the server. -eg: bcfg2 = https://10.3.1.6:6789 - -.TP -.B encoding -Text encoding of configuration files. Defaults to UTF-8. - -.SH LOGGING OPTIONS -Specified in the [logging] section. These options control the server -logging functionality. - -.B path -Server log file path. - -.SH SNAPSHOTS OPTIONS -Specified in the [snapshots] section. These options control the server -snapshots functionality. - -.B driver +. +.SH "PACKAGES OPTIONS" +The following options are specified in the \fB[packages]\fR section of the configuration file\. +. +.TP +\fBresolver\fR +Enable dependency resolution\. Default is 1 (true)\. +. +.TP +\fBmetadata\fR +Enable metadata processing\. Default is 1 (true)\. If metadata is disabled, it’s implied that resolver is also disabled\. +. +.TP +\fByum_config\fR +The path at which to generate Yum configs\. No default\. +. +.TP +\fBapt_config\fR +The path at which to generate APT configs\. No default\. +. +.TP +\fBgpg_keypath\fR +The path on the client where RPM GPG keys will be copied before they are imported on the client\. Default is \fB/etc/pki/rpm\-gpg\fR\. +. +.TP +\fBversion\fR +Set the version attribute used when binding Packages\. Default is auto\. +. +.P +The following options are specified in the \fB[packages:yum]\fR section of the configuration file\. +. +.TP +\fBuse_yum_libraries\fR +By default, Bcfg2 uses an internal implementation of Yum’s dependency resolution and other routines so that the Bcfg2 server can be run on a host that does not support Yum itself\. If you run the Bcfg2 server on a machine that does have Yum libraries, however, you can enable use of those native libraries in Bcfg2 by setting this to 1\. +. +.TP +\fBhelper\fR +Path to bcfg2\-yum\-helper\. By default, Bcfg2 looks first in $PATH and then in \fB/usr/sbin/bcfg2\-yum\-helper\fR for the helper\. +. +.P +All other options in the \fB[packages:yum]\fR section will be passed along verbatim to the Yum configuration if you are using the native Yum library support\. +. +.P +The following options are specified in the \fB[packages:pulp]\fR section of the configuration file\. +. +.TP +\fBusername\fR +The username of a Pulp user that will be used to register new clients and bind them to repositories\. +. +.TP +\fBpassword\fR +The password of a Pulp user that will be used to register new clients and bind them to repositories\. +. +.SH "PARANOID OPTIONS" +These options allow for finer\-grained control of the paranoid mode on the Bcfg2 client\. They are specified in the \fB[paranoid]\fR section of the configuration file\. +. +.TP +\fBpath\fR +Custom path for backups created in paranoid mode\. The default is in \fB/var/cache/bcfg2\fR\. +. +.TP +\fBmax_copies\fR +Specify a maximum number of copies for the server to keep when running in paranoid mode\. Only the most recent versions of these copies will be kept\. +. +.SH "SNAPSHOTS OPTIONS" +Specified in the \fB[snapshots]\fR section\. These options control the server snapshots functionality\. +. +.TP +\fBdriver\fR sqlite - -.B database -The name of the database to use for statistics data. -eg: $REPOSITORY_DIR/etc/bcfg2.sqlite - -.SH PLUGIN-SPECIFIC OPTIONS - -Many plugins specify their own options in bcfg2.conf; see the online -documentation about each plugin for more information on these. - -.SH SEE ALSO -.BR bcfg2(1), -.BR bcfg2-server(8) - +. +.TP +\fBdatabase\fR +The name of the database to use for statistics data\. +. +.IP +eg: \fB$REPOSITORY_DIR/etc/bcfg2\.sqlite\fR +. +.SH "SSLCA OPTIONS" +These options are necessary to configure the SSLCA plugin and can be found in the \fB[sslca_default]\fR section of the configuration file\. +. +.TP +\fBconfig\fR +Specifies the location of the openssl configuration file for your CA\. +. +.TP +\fBpassphrase\fR +Specifies the passphrase for the CA’s private key (if necessary)\. If no passphrase exists, it is assumed that the private key is stored unencrypted\. +. +.TP +\fBchaincert\fR +Specifies the location of your ssl chaining certificate\. This is used when pre\-existing certifcate hostfiles are found, so that they can be validated and only regenerated if they no longer meet the specification\. If you’re using a self signing CA this would be the CA cert that you generated\. +. +.SH "STATISTICS OPTIONS" +Server\-only, specified in the \fB[statistics]\fR section\. These options control the statistics collection functionality of the server\. +. +.TP +\fBdatabase_engine\fR +The database engine used by the statistics module\. One of the following: +. +.IP +\fBpostgresql\fR, \fBmysql\fR, \fBsqlite3\fR, \fBado_mssql\fR +. +.TP +\fBdatabase_name\fR +The name of the database to use for statistics data\. If ‘database_engine’ is set to ‘sqlite3’ this is a file path to sqlite file and defaults to \fB$REPOSITORY_DIR/etc/brpt\.sqlite\fR\. +. +.TP +\fBdatabase_user\fR +User for database connections\. Not used for sqlite3\. +. +.TP +\fBdatabase_password\fR +Password for database connections\. Not used for sqlite3\. +. +.TP +\fBdatabase_host\fR +Host for database connections\. Not used for sqlite3\. +. +.TP +\fBdatabase_port\fR +Port for database connections\. Not used for sqlite3\. +. +.TP +\fBtime_zone\fR +Specify a time zone other than that used on the system\. (Note that this will cause the Bcfg2 server to log messages in this time zone as well)\. +. +.SH "SEE ALSO" +bcfg2(1), bcfg2\-server(8) |