From 5819d7182ac703c9f830df1ea2b940fbfa976db7 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 13 Apr 2011 13:29:48 -0400 Subject: A property file can now have a matching .xsd file (e.g., "Properties/foo.xml" and "Properties/foo.xsd") which specifies a schema for that property file. bcfg2-repo-validate will check the property file against its schema. Updated bcfg2-repo-validate man page with several new options. --- man/bcfg2-repo-validate.8 | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) (limited to 'man') diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 index d00885313..0fb61e991 100644 --- a/man/bcfg2-repo-validate.8 +++ b/man/bcfg2-repo-validate.8 @@ -3,7 +3,7 @@ bcfg2-repo-validate \- Check Bcfg2 repository data against data schemas .SH SYNOPSIS .B bcfg2-repo-validate -.I [-v] +.I [OPTIONS] .SH DESCRIPTION .PP .B bcfg2-repo-validate @@ -11,10 +11,39 @@ This script checks data against schemas, and it quite helpful in finding typos or malformed data. .SH OPTIONS .PP +.B "\-v" +.RS +Be verbose about checks that have succeeded. This also enables +checking for missing bundles. +.RE .B "\-C" .RS Specify path to bcfg2.conf (default /etc/bcfg2.conf) .RE +.B "\-Q" +.RS +Specify path to Bcfg2 repository (default /var/lib/bcfg2) +.RE +.B "\--schema" +.RS +Specify path to Bcfg2 XML Schemas (default /usr/share/bcfg2/schema) +.RE +.B "\--stdin" +.RS +Rather than validating all XML files in the Bcfg2 specification, only +validate a list of files supplied on stdin. This makes a few +assumptions: + +Files included using XInclude will only be validated if they are +included on stdin; XIncludes will not be followed. + +Property files will only be validated if both the property file itself +and its matching schema are included on stdin. +.RE +.B "\--require-schema" +.RS +Require property files to have matching schema files +.RE .SH "SEE ALSO" .BR bcfg2(1), .BR bcfg2-server(8) -- cgit v1.2.3-1-g7c22 From 1add5c6332fb8f59abf377d4167099ae9c5f1125 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 13 Apr 2011 14:14:07 -0500 Subject: man: Update the bcfg2-reports man page Signed-off-by: Sol Jerome --- man/bcfg2-repo-validate.8 | 29 +++++++++++++++++++++++------ man/bcfg2-reports.8 | 6 +++--- man/bcfg2-server.8 | 10 +++++----- man/bcfg2.1 | 42 +++++++++++++++++++++--------------------- man/bcfg2.conf.5 | 10 +++++----- 5 files changed, 57 insertions(+), 40 deletions(-) (limited to 'man') diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 index d00885313..81ba61099 100644 --- a/man/bcfg2-repo-validate.8 +++ b/man/bcfg2-repo-validate.8 @@ -3,18 +3,35 @@ bcfg2-repo-validate \- Check Bcfg2 repository data against data schemas .SH SYNOPSIS .B bcfg2-repo-validate -.I [-v] +.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. +finding typos or malformed data. .SH OPTIONS -.PP -.B "\-C" -.RS + +.TP +.BR "-Q " +Server repository path + +.TP +.BR "-C " Specify path to bcfg2.conf (default /etc/bcfg2.conf) -.RE + +.TP +.BR "--stdin" +Operate on a list of files supplied on stdin + +.TP +.BR "-v" +Enable verbose output + +.TP +.BR "--schema=" +Path to XML Schema files + +.RE .SH "SEE ALSO" .BR bcfg2(1), .BR bcfg2-server(8) diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index bc4c9344b..7597818cd 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -3,7 +3,7 @@ bcfg2-reports \- Query reporting system for client status .SH SYNOPSIS .B bcfg2-reports -.I [-v] +.I [-v] .SH DESCRIPTION .PP \fBbcfg2-reports\fR allows you to retrieve data from the database about @@ -53,14 +53,14 @@ Toggles expired/unexpired state of NAME. NAME is the name of the entry. 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. +(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. +(Package, Path, Service, etc). NAME is the name of the entry. .RE .B "\-\-fields=ARG1,ARG2,..." .RS diff --git a/man/bcfg2-server.8 b/man/bcfg2-server.8 index a6bffc1fa..9f99ee8b7 100644 --- a/man/bcfg2-server.8 +++ b/man/bcfg2-server.8 @@ -7,11 +7,11 @@ bcfg2-server \- Server for client configuration specifications .SH DESCRIPTION .PP .B bcfg2-server -This daemon serves configurations to clients based on the data in its -repository. +This daemon serves configurations to clients based on the data in its +repository. .SH OPTIONS .PP -.B \-d +.B \-d .RS Run bcfg2 in debug mode. .RE @@ -19,11 +19,11 @@ Run bcfg2 in debug mode. .RS Run bcfg2 in verbose mode. .RE -.B "\-C " +.B "\-C " .RS Use an alternative path for bcfg2.conf. The default is /etc/bcfg2.conf .RE -.B \-D +.B \-D .RS Daemonize, placing the program pid in the specified pidfile. .RE diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 938d41dfe..14398fdab 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -31,15 +31,15 @@ Specify the encoding of Cfg files. .TP .BR "\-I" -Run bcfg2 in interactive mode. The user will be prompted before each +Run bcfg2 in interactive mode. The user will be prompted before each change. .TP -.BR "\-O" +.BR "\-O" Omit lock check. -.TP -.BR "\-P" +.TP +.BR "\-P" Run bcfg2 in paranoid mode. Diffs will be logged for configuration files marked as paranoid by the Bcfg2 server. @@ -62,24 +62,24 @@ Run bcfg2 against one or multiple bundles in the configuration. Cache a copy of the configuration in cachefile. .TP -.BR "\-d" +.BR "\-d" Run bcfg2 in debug mode. -.TP -.BR "\-e" +.TP +.BR "\-e" When in verbose mode, display extra entry information (temporary until verbosity rework). .TP -.BR "\-f " +.BR "\-f " Configure from a file rather than querying the server. -.TP -.BR "\-h" +.TP +.BR "\-h" Print Usage information. -.TP -.BR "\-k" +.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. @@ -97,14 +97,14 @@ administrators and much configuration variety. .TP .BR "\-n" Run bcfg2 in dry\-run mode. No changes will be made to the -system. +system. .TP .BR "\-o " Writes a log to the specified path. .TP -.BR "\-p " +.BR "\-p " Assert a profile for the current client. .TP @@ -112,16 +112,16 @@ Assert a profile for the current client. 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 -or installed. This runs much faster than -q, but doesn't provide +Run bcfg2 in "bundle quick" mode, where only entries in a bundle are +or installed. This runs much faster than -q, but doesn't provide 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. +-b option must also be provided. This option is incompatible with -r. .TP -.BR "\-r " +.BR "\-r " 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 @@ -139,11 +139,11 @@ modify services. Specifiy the path to the SSL key. .TP -.BR "\-u " +.BR "\-u " Attempt to authenticate as 'user'. .TP -.BR "\-x " +.BR "\-x " Use 'password' for client communication. .TP diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index f2e47b7ac..c32ccde16 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -64,7 +64,7 @@ reporting system, so they can be centrally observed. \(bu .B BB -The BB plugin maps users to machines and metadata to machines. +The BB plugin maps users to machines and metadata to machines. (experimental) \(bu @@ -339,20 +339,20 @@ settings used for client-server communication. .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. +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. +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. +certificates. .TP .B password @@ -379,7 +379,7 @@ of the configuration file. .TP .B path -Custom path for backups created in paranoid mode. The default is in +Custom path for backups created in paranoid mode. The default is in /var/cache/bcfg2. .TP -- cgit v1.2.3-1-g7c22 From 6da7d24710fe67c80c4a71f227cd01675eebca88 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 21 Apr 2011 08:50:06 -0400 Subject: Lots of cleanup for bcfg2-repo-validate rewrite: * Changed all references to bcfg2-repo-validate in the documentation to bcfg2-lint * Wrote man pages for bcfg2-lint and bcfg2-lint.conf * Cleaned up straggling references to bcfg2-repo-validate in Makefiles, spec files, and the POSIX tool * A few minor bug fixes --- man/bcfg2-lint.8 | 169 ++++++++++++++++++++++++++++++++++++++++++++++ man/bcfg2-lint.conf.5 | 155 ++++++++++++++++++++++++++++++++++++++++++ man/bcfg2-repo-validate.8 | 52 -------------- man/bcfg2-server.8 | 2 +- 4 files changed, 325 insertions(+), 53 deletions(-) create mode 100644 man/bcfg2-lint.8 create mode 100644 man/bcfg2-lint.conf.5 delete mode 100644 man/bcfg2-repo-validate.8 (limited to 'man') diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 new file mode 100644 index 000000000..624082960 --- /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 [ [...]] + +.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 +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 duplicatesin 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 +and +.I +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..2c89a1161 --- /dev/null +++ b/man/bcfg2-lint.conf.5 @@ -0,0 +1,155 @@ +.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. + +.SH GLOBAL OPTIONS +These options apply to +.I bcfg2-lint +generally, and must be in the +.I [main] +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 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. + +.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 _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 _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 +tags. Default is "owner,group,perms". + +\(bu +.B require_paranoid +Ensure that paranoid mode is on for all files. This can be +accomplished by either setting the global paranoid value (and not +overriding it. Default is false. + +\(bu +.B require +Require an +.I info.xml +file for all Cfg files. Default is false. + +.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 + +\(bu +.B properties_schema +If set to +.I "warn" +, will warn if a property files does not have a matching schema file. +If set to +.I "require" +, will produce an error if a property files does not have a matching +schema file. Default is to neither warn nor require. + +.SH SEE ALSO +.BR bcfg2-lint(1) + diff --git a/man/bcfg2-repo-validate.8 b/man/bcfg2-repo-validate.8 deleted file mode 100644 index 1bf74a206..000000000 --- a/man/bcfg2-repo-validate.8 +++ /dev/null @@ -1,52 +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 [OPTIONS] -.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 - -.TP -.BR "-v" -Be verbose about checks that have succeeded. This also enables -checking for missing bundles. - -.TP -.BR "-C" -Specify path to bcfg2.conf (default /etc/bcfg2.conf) - -.TP -.BR "-Q" -Specify path to Bcfg2 repository (default /var/lib/bcfg2) - -.TP -.BR "--schema" -Specify path to Bcfg2 XML Schemas (default /usr/share/bcfg2/schema) - -.TP -.BR "--stdin" -Rather than validating all XML files in the Bcfg2 specification, only -validate a list of files supplied on stdin. This makes a few -assumptions: - -Files included using XInclude will only be validated if they are -included on stdin; XIncludes will not be followed. - -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 "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 -- cgit v1.2.3-1-g7c22 From 66642f84fd71e9230245b11718bf9a7e96ba0c7f Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Mon, 25 Apr 2011 08:40:26 -0400 Subject: changed [main] section of bcfg2-lint.conf to [lint] to make it possible to combine config files get full stack trace from failed plugins for easier troubleshooting --- man/bcfg2-lint.conf.5 | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'man') diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index 2c89a1161..e2b8e79fa 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -21,11 +21,19 @@ 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, 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 [main] +.I [lint] section. .TP -- cgit v1.2.3-1-g7c22 From 23ae3d201af82292ad4e939569a50f2e32c689a3 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 5 May 2011 08:16:51 -0400 Subject: made bcfg2-lint error handling configurable on a much more granular level --- man/bcfg2-lint.conf.5 | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) (limited to 'man') diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index e2b8e79fa..0ae7a27ac 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -23,6 +23,8 @@ 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 @@ -44,6 +46,24 @@ 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 @@ -54,6 +74,11 @@ plugin would be in a section called 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 @@ -126,18 +151,6 @@ A comma-delimited list of attributes to require on .I tags. Default is "owner,group,perms". -\(bu -.B require_paranoid -Ensure that paranoid mode is on for all files. This can be -accomplished by either setting the global paranoid value (and not -overriding it. Default is false. - -\(bu -.B require -Require an -.I info.xml -file for all Cfg files. Default is false. - .TP .BR Validate @@ -148,16 +161,6 @@ The full path to the XML Schema files. Default is .I --schema command-line option -\(bu -.B properties_schema -If set to -.I "warn" -, will warn if a property files does not have a matching schema file. -If set to -.I "require" -, will produce an error if a property files does not have a matching -schema file. Default is to neither warn nor require. - .SH SEE ALSO .BR bcfg2-lint(1) -- cgit v1.2.3-1-g7c22 From be0849b2c66a6e52611f4f14a605fae977c8c48d Mon Sep 17 00:00:00 2001 From: Raul Cuza Date: Thu, 5 May 2011 11:14:38 -0400 Subject: Correct minor typo in man page. --- man/bcfg2-lint.8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'man') diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 index 624082960..b1fa9244b 100644 --- a/man/bcfg2-lint.8 +++ b/man/bcfg2-lint.8 @@ -101,7 +101,7 @@ required. .TP .BR Duplicates -Check for several types of duplicatesin the Metadata: duplicate +Check for several types of duplicates in the Metadata: duplicate groups; duplicate clients; and multiple default groups. .TP -- cgit v1.2.3-1-g7c22 From 91634f9a3b888eee3cd5f9a777fcb075fc666c9a Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Tue, 10 May 2011 09:46:40 -0500 Subject: man: Fix typos reported by emias on IRC Signed-off-by: Sol Jerome --- man/bcfg2-admin.8 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'man') 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 -- cgit v1.2.3-1-g7c22 From e51bcb3562731d5000977a6aa74f6f6f1fb068fe Mon Sep 17 00:00:00 2001 From: Tim Laszlo Date: Wed, 11 May 2011 10:35:24 -0500 Subject: man: Fix incorrect purge/scrub command parameters --- man/bcfg2-admin.8 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'man') diff --git a/man/bcfg2-admin.8 b/man/bcfg2-admin.8 index 829d00f03..4f6528e0e 100644 --- a/man/bcfg2-admin.8 +++ b/man/bcfg2-admin.8 @@ -164,11 +164,11 @@ Initialize the database. .RS Load statistics data. .RE -.B purge +.B purge [--client [n]] [--days [n]] [--expired] .RS -Purge records. +Purge historic and expired data. .RE -.B scrub [--client [n]] [--days [n]] [--expired] +.B scrub .RS Scrub the database for duplicate reasons and orphaned entries. .RE -- cgit v1.2.3-1-g7c22 From 3529657365033cfcb1c0fb4b881b68535b169e22 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Sat, 14 May 2011 16:12:27 -0500 Subject: man: Point to the correct sections Signed-off-by: Sol Jerome --- man/bcfg2-lint.conf.5 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'man') diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index 0ae7a27ac..49a32bb22 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -43,7 +43,7 @@ section. A comma-delimited list of plugins to run. By default, all plugins are run. This can be overridden by listing plugins on the command line. See -.B bcfg2-lint(1) +.B bcfg2-lint(8) for a list of the available plugins. .SH ERROR HANDLING @@ -56,10 +56,10 @@ section. Each option should be the name of an error and one of , or .I "silent" , which tells -.B bcfg2-lint(1) +.B bcfg2-lint(8) how to handle the warning. Error names and their defaults can be displayed by running -.B bcfg2-lint(1) +.B bcfg2-lint(8) with the .B --list-errors option. @@ -162,5 +162,5 @@ The full path to the XML Schema files. Default is command-line option .SH SEE ALSO -.BR bcfg2-lint(1) +.BR bcfg2-lint(8) -- cgit v1.2.3-1-g7c22 From 783ff2f7d1cc5d9f88404e62a9f114a36971dede Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Tue, 17 May 2011 15:46:57 -0400 Subject: added bcfg2-lint MergeFiles plugin to suggest config files and probes that are very similar and could be merged added text wrapping to bcfg2-lint error handling --- man/bcfg2-lint.8 | 5 +++++ man/bcfg2-lint.conf.5 | 8 ++++++++ 2 files changed, 13 insertions(+) (limited to 'man') diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 index b1fa9244b..f2d4f9e88 100644 --- a/man/bcfg2-lint.8 +++ b/man/bcfg2-lint.8 @@ -119,6 +119,11 @@ are specified. Can also require that an exists for all Cfg files, and that paranoid mode be enabled for all files. +.TP +.BR MergeFiles +Suggest that similar probes and config files be merged into single +probes or TGenshi templates. + .TP .BR Pkgmgr Check for duplicate packages specified in Pkgmgr. diff --git a/man/bcfg2-lint.conf.5 b/man/bcfg2-lint.conf.5 index 49a32bb22..10a812874 100644 --- a/man/bcfg2-lint.conf.5 +++ b/man/bcfg2-lint.conf.5 @@ -151,6 +151,14 @@ A comma-delimited list of attributes to require on .I tags. Default is "owner,group,perms". +.TP +.BR MergeFiles + +\(bu +.B threshold +The threshold at which MergeFiles will suggest merging config files +and probes. Default is 75% similar. + .TP .BR Validate -- cgit v1.2.3-1-g7c22 From 5d558eff1d9fcb9fd4c4b67841a9b63043e390f8 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Fri, 20 May 2011 09:16:02 -0400 Subject: fixed typo in bcfg2-lint man page (thanks jsbillings) --- man/bcfg2-lint.8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'man') diff --git a/man/bcfg2-lint.8 b/man/bcfg2-lint.8 index f2d4f9e88..25fa30f9e 100644 --- a/man/bcfg2-lint.8 +++ b/man/bcfg2-lint.8 @@ -71,7 +71,7 @@ Require property files to have matching schema files .SH "PLUGINS" See -.BR bcfg-lint.conf(5) +.BR bcfg2-lint.conf(5) for more information on the configuration of the plugins listed below. .TP -- cgit v1.2.3-1-g7c22 From 927f5d957d76f8743b1ae812b5f915588fcb8de6 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 1 Jun 2011 09:50:25 -0400 Subject: added -t option to set client timeout --- man/bcfg2.1 | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'man') diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 938d41dfe..7f108ed8f 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -146,6 +146,11 @@ Attempt to authenticate as 'user'. .BR "\-x " Use 'password' for client communication. +.TP +.BR "\-t " +Set the timeout (in seconds) for client communication. Default is 90 +seconds. + .TP .BR "\-v" Run bcfg2 in verbose mode. -- cgit v1.2.3-1-g7c22 From 5a31e049ee342ec5874447796bc3978310306afb Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Fri, 3 Jun 2011 13:28:46 -0500 Subject: bcfg2-server: Add the ability to listen on specific interfaces (#1013) Signed-off-by: Sol Jerome --- man/bcfg2.conf.5 | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'man') diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index f2e47b7ac..b1acce7c3 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -37,6 +37,12 @@ using the 'bcfg2-admin init' command. The file monitor used to watch for changes in the repository. Values of 'gamin', 'fam', or 'pseudo' are valid. +.TP +.B listen_all +This setting tells the server to listen on all available interfaces. The +default is to only listen on those interfaces specified by the bcfg2 +setting in the components section of bcfg2.conf. + .TP .B plugins A comma-delimited list of enabled server plugins. Currently available -- cgit v1.2.3-1-g7c22 From 437f61a1bf60bd884b9bcfd177e60922df596fb2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Holger=20Wei=C3=9F?= Date: Sat, 4 Jun 2011 23:52:02 +0200 Subject: Document the "decision" option in bcfg2.conf(5) Add documentation for the "decision" option to the bcfg2.conf(5) man page. Also, note that it can be overridden using "-l none" on the bcfg2(1) command line. --- man/bcfg2.1 | 10 ++++++---- man/bcfg2.conf.5 | 4 ++++ 2 files changed, 10 insertions(+), 4 deletions(-) (limited to 'man') diff --git a/man/bcfg2.1 b/man/bcfg2.1 index 7f108ed8f..49fd1e208 100644 --- a/man/bcfg2.1 +++ b/man/bcfg2.1 @@ -85,10 +85,12 @@ debian toolset; it calls apt\-get update and clean and dpkg \-\-configure \-\-pending. .TP -.BR "\-l " -Run the client in the server decision list mode. This approach is needed -when particular changes are deemed "high risk". It gives the ability to -centrally specify these changes, but only install them on clients when +.BR "\-l " +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 diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index b1acce7c3..44d8beb50 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -290,6 +290,10 @@ Global paranoid settings for Paths (defaults to false) These options only affect client functionality, specified in the [client] section. +.TP +.B decision +Specify the server decision list mode (whitelist or blacklist). + .TP .B drivers Specify tool driver set to use. This option can be used to explicitly -- cgit v1.2.3-1-g7c22 From 3fdaa9f7baf648ed6e4fa70e892605147cf9252e Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Mon, 6 Jun 2011 18:30:46 -0500 Subject: =?UTF-8?q?Options:=20Set=20default=20encoding=20to=20UTF-8=20(as?= =?UTF-8?q?=20per=20Holger=20Wei=C3=9F's=20suggestion)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sol Jerome --- man/bcfg2.conf.5 | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'man') diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index 44d8beb50..786f69f9a 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -410,9 +410,7 @@ eg: bcfg2 = https://10.3.1.6:6789 .TP .B encoding -Text encoding of configuration files. Defaults to the system default -encoding. - +Text encoding of configuration files. Defaults to UTF-8. .SH LOGGING OPTIONS Specified in the [logging] section. These options control the server -- cgit v1.2.3-1-g7c22 From 716182d04c7ff55ff1f275de9f31a170acf9dc23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Holger=20Wei=C3=9F?= Date: Tue, 7 Jun 2011 13:22:00 +0200 Subject: bcfg2-reports: Show modified entries bcfg2-reports now shows modified entries if it's called with --modifiedentry, -m, or -s. --- man/bcfg2-reports.8 | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'man') diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index bc4c9344b..284298a69 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -39,10 +39,15 @@ of NAME. NAME is the name of the entry. .RS Shows help and usage info about bcfg2-reports. .RE +.B "\-m NAME" +.RS +Single-host mode \- shows modified entries from the current interaction +of NAME. NAME is the name of the entry. +.RE .B "\-s NAME" .RS -Single host mode \- shows bad and extra entries from the current -interaction of NAME. NAME is the name of the entry. +Single host mode \- shows bad, modified, and extra entries from the +current interaction of NAME. NAME is the name of the entry. .RE .B "\-x NAME" .RS @@ -66,6 +71,13 @@ pairs will be read from a file of name ARG1. KIND is the type of entry .RS Only displays the fields ARG1,ARG2,... (name, time, state) .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) -- cgit v1.2.3-1-g7c22 From bfd6b1bc1e842b2be66c72e385d1d4556746a375 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Holger=20Wei=C3=9F?= Date: Wed, 8 Jun 2011 17:16:44 +0200 Subject: bcfg2-reports: Show total numbers of entries Add a "-t NAME" option which reports the total (and good) number of managed entries on the host NAME. Also, allow for specifying "total", "good", and "bad" fields via --fields and --sort. --- man/bcfg2-reports.8 | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'man') diff --git a/man/bcfg2-reports.8 b/man/bcfg2-reports.8 index 284298a69..51399e1c9 100644 --- a/man/bcfg2-reports.8 +++ b/man/bcfg2-reports.8 @@ -69,7 +69,8 @@ pairs will be read from a file of name ARG1. KIND is the type of entry .RE .B "\-\-fields=ARG1,ARG2,..." .RS -Only displays the fields ARG1,ARG2,... (name, time, state) +Only displays the fields ARG1,ARG2,... (name, time, state, total, good, +bad) .RE .B "\-\-modifiedentry=KIND,NAME" .RS @@ -80,7 +81,7 @@ of entry (Package, Path, Service, etc). NAME is the name of the entry. .RE .B "\-\-sort=ARG1,ARG2,..." .RS -Sorts output on ARG1,ARG2,... (name, time, state) +Sorts output on ARG1,ARG2,... (name, time, state, total, good, bad) .RE .B "\-\-stale" .RS -- cgit v1.2.3-1-g7c22