diff options
author | Narayan Desai <desai@mcs.anl.gov> | 2011-05-10 11:24:28 -0500 |
---|---|---|
committer | Narayan Desai <desai@mcs.anl.gov> | 2011-05-10 11:24:28 -0500 |
commit | 0e75875e9bd9900a6a3c7ab118c448e48829eaef (patch) | |
tree | 391204747f48598c4e978d3724afbd5b8aa1d12c /man | |
parent | f2d218ccd2de93ef639347933ba127ef081b4401 (diff) | |
parent | 91634f9a3b888eee3cd5f9a777fcb075fc666c9a (diff) | |
download | bcfg2-0e75875e9bd9900a6a3c7ab118c448e48829eaef.tar.gz bcfg2-0e75875e9bd9900a6a3c7ab118c448e48829eaef.tar.bz2 bcfg2-0e75875e9bd9900a6a3c7ab118c448e48829eaef.zip |
Merge branch 'master' of git.mcs.anl.gov:bcfg2
Diffstat (limited to 'man')
-rw-r--r-- | man/bcfg2-admin.8 | 4 | ||||
-rw-r--r-- | man/bcfg2-lint.8 | 169 | ||||
-rw-r--r-- | man/bcfg2-lint.conf.5 | 166 | ||||
-rw-r--r-- | man/bcfg2-ping-sweep.8 | 20 | ||||
-rw-r--r-- | man/bcfg2-repo-validate.8 | 22 | ||||
-rw-r--r-- | man/bcfg2-reports.8 | 163 | ||||
-rw-r--r-- | man/bcfg2-server.8 | 2 |
7 files changed, 439 insertions, 107 deletions
diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8 index 0b3829b7e..829d00f03 100644 --- a/man/bcfg2-admin.8 +++ b/man/bcfg2-admin.8 @@ -55,7 +55,7 @@ Build structure entries based on client statistics extra entries. Install configuration information into repo based on client bad entries. .RE -.B report [init|load_stats|purge|scrub|update] +.B reports [init|load_stats|purge|scrub|update] .RS Interact with the dynamic reporting system. .RE @@ -154,7 +154,7 @@ Specify the type of the entry to pull. .RS Specify the name of the entry to pull. .RE -.SH REPORT OPTIONS +.SH REPORTS OPTIONS .PP .B init .RS diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 new file mode 100644 index 000000000..b1fa9244b --- /dev/null +++ b/man/bcfg2-lint.8 @@ -0,0 +1,169 @@ +.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 + +.TP +.BR "-v" +Be verbose. + +.TP +.BR "-C" +Specify path to bcfg2.conf (default /etc/bcfg2.conf) + +.TP +.BR "--lint-config" +Specify path to bcfg2-lint.conf (default /etc/bcfg2-lint.conf) + +.TP +.BR "-Q" +Specify path to Bcfg2 repository (default /var/lib/bcfg2) + +.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. + +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. + +.TP +.BR "--require-schema" +Require property files to have matching schema files + +.RE + +.SH "PLUGINS" + +See +.BR bcfg-lint.conf(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). + +.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. + +.TP +.BR Duplicates +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. + +.TP +.BR Pkgmgr +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. + +.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) + +.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. diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 new file mode 100644 index 000000000..0ae7a27ac --- /dev/null +++ b/man/bcfg2-lint.conf.5 @@ -0,0 +1,166 @@ +.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(1) +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(1) +how to handle the warning. Error names and their defaults can be +displayed by running +.B bcfg2-lint(1) +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. + +.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 +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 +infoxml_keywords = Revision +.fi + +.I not: + +.nf +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. + +.TP +.BR InfoXML + +\(bu +.B required_attrs +A comma-delimited list of attributes to require on +.I <Info> +tags. Default is "owner,group,perms". + +.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(1) + diff --git a/man/bcfg2-ping-sweep.8 b/man/bcfg2-ping-sweep.8 new file mode 100644 index 000000000..54eaa8e76 --- /dev/null +++ b/man/bcfg2-ping-sweep.8 @@ -0,0 +1,20 @@ +.TH "bcfg2-ping-sweep" 8 +.SH NAME +bcfg2-ping-sweep \- Update pingable and pingtime attributes in +clients.xml +.SH SYNOPSIS +.B bcfg2-ping-sweep +.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 +.SH "SEE ALSO" +.BR bcfg(1), +.BR bcfg2-server(8) +.SH "BUGS" +None currently known diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 deleted file mode 100644 index d00885313..000000000 --- a/man/bcfg2-repo-validate.8 +++ /dev/null @@ -1,22 +0,0 @@ -.TH "bcfg2-repo-validate" 8 -.SH NAME -bcfg2-repo-validate \- Check Bcfg2 repository data against data schemas -.SH SYNOPSIS -.B bcfg2-repo-validate -.I [-v] -.SH DESCRIPTION -.PP -.B bcfg2-repo-validate -This script checks data against schemas, and it quite helpful in -finding typos or malformed data. -.SH OPTIONS -.PP -.B "\-C" -.RS -Specify path to bcfg2.conf (default /etc/bcfg2.conf) -.RE -.SH "SEE ALSO" -.BR bcfg2(1), -.BR bcfg2-server(8) -.SH "BUGS" -None currently known diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index b8b4cccee..bc4c9344b 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -1,82 +1,81 @@ -.TH "bcfg2-reports" 8
-.SH NAME
-bcfg2-reports \- Query reporting system for client status
-.SH SYNOPSIS
-.B bcfg2-reports
-.I [-v]
-.SH DESCRIPTION
-.PP
-.B bcfg2-reports
-bcfg2-reports 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 "\-s NAME"
-.RS
-Single host mode \- shows bad 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)
-.RE
-.B "\-\-sort=ARG1,ARG2,..."
-.RS
-Sorts output on ARG1,ARG2,... (name, time, state)
-.RE
-.B "\-\-stale"
-.RS
-Shows hosts which haven't run in the last 24 hours
-.RE
-.SH "SEE ALSO"
-.BR bcfg2(1),
-.BR bcfg2-server(8)
-.SH "BUGS"
-None currently known
+.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 "\-s NAME" +.RS +Single host mode \- shows bad 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) +.RE +.B "\-\-sort=ARG1,ARG2,..." +.RS +Sorts output on ARG1,ARG2,... (name, time, state) +.RE +.B "\-\-stale" +.RS +Shows hosts which haven't run in the last 24 hours +.RE +.SH "SEE ALSO" +.BR bcfg2(1), +.BR bcfg2-server(8) +.SH "BUGS" +None currently known diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index a6bffc1fa..2d132ce6d 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -53,6 +53,6 @@ Set path to SSL key. .RE .SH "SEE ALSO" .BR bcfg2(1), -.BR bcfg2-repo-validate(8) +.BR bcfg2-lint(8) .SH "BUGS" None currently known |