diff options
| -rw-r--r-- | man/bcfg2.conf.5 | 62 | ||||
| -rw-r--r-- | src/lib/Bcfg2/Options.py | 10 | ||||
| -rwxr-xr-x | src/sbin/bcfg2-info | 1 | ||||
| -rw-r--r-- | tools/manpagegen/bcfg2.conf.5.ronn | 66 |
4 files changed, 106 insertions, 33 deletions
diff --git a/man/bcfg2.conf.5 b/man/bcfg2.conf.5 index 3fcf9ffb7..ebb5b0702 100644 --- a/man/bcfg2.conf.5 +++ b/man/bcfg2.conf.5 @@ -58,6 +58,16 @@ Descriptions of each plugin can be found in their respective sections below\. \fBprefix\fR Specifies a prefix if the Bcfg2 installation isn’t placed in the default location (e\.g\. /usr/local)\. . +.TP +\fBbackend\fR +Specifies which server core backend to use\. Current available options are: +. +.IP +\fBcherrypy\fR, \fBbuiltin\fR, \fBbest\fR +. +.IP +The default is \fBbest\fR, which is currently an alias for \fBbuiltin\fR\. More details on the backends can be found in the official documentation\. +. .SS "Account Plugin" The account plugin manages authentication data, including the following\. . @@ -212,13 +222,21 @@ Communication protocol to use\. Defaults to xmlrpc/ssl\. . .TP \fBretries\fR -A client\-only option\. Number of times to retry network communication\. +A client\-only option\. Number of times to retry network communication\. Default is 3 retries\. +. +.TP +\fBretry_delay\fR +A client\-only option\. Number of seconds to wait in between retrying network communication\. Default is 1 second\. . .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 +\fBtimeout\fR +A client\-only option\. The network communication timeout\. +. +.TP \fBuser\fR A client\-only option\. The UUID of the client\. . @@ -236,15 +254,31 @@ e\.g\. \fBbcfg2 = https://10\.3\.1\.6:6789\fR \fBencoding\fR Text encoding of configuration files\. Defaults to UTF\-8\. . +.TP +\fBlockfile\fR +The path to the client lock file, which is used to ensure that only one Bcfg2 client runs at a time on a single client\. +. .SH "LOGGING OPTIONS" Specified in the \fB[logging]\fR section\. These options control the server logging functionality\. . .TP +\fBdebug\fR +Whether or not to enable debug\-level log output\. Default is false\. +. +.TP \fBpath\fR Server log file path\. . +.TP +\fBsyslog\fR +Whether or not to send logging data to syslog\. Default is true\. +. +.TP +\fBverbose\fR +Whether or not to enable verbose log output\. Default is false\. +. .SH "MDATA OPTIONS" -These options affect the default metadata settings for Paths with type=’file’\. +Specified in the \fB[mdata]\fR section\. These options affect the default metadata settings for Paths with type=’file’\. . .TP \fBowner\fR @@ -259,6 +293,10 @@ Global group for Paths (defaults to root) Global permissions for Paths (defaults to 644) . .TP +\fBsecontext\fR +Global SELinux context for Path entries (defaults to \fB__default__\fR, which restores the expected context) +. +.TP \fBparanoid\fR Global paranoid settings for Paths (defaults to false) . @@ -266,6 +304,10 @@ Global paranoid settings for Paths (defaults to false) \fBsensitive\fR Global sensitive settings for Paths (defaults to false) . +.TP +\fBimportant\fR +Global important settings for Paths\. Defaults to false, and anything else is probably not a good idea\. +. .SH "PACKAGES OPTIONS" The following options are specified in the \fB[packages]\fR section of the configuration file\. . @@ -358,34 +400,34 @@ Specifies the passphrase for the CA’s private key (if necessary)\. If no passp \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\. +.SH "DATABASE OPTIONS" +Server\-only, specified in the \fB[database]\fR section\. These options control the database connection of the server\. . .TP -\fBdatabase_engine\fR +\fBengine\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 +\fBname\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 +\fBuser\fR User for database connections\. Not used for sqlite3\. . .TP -\fBdatabase_password\fR +\fBpassword\fR Password for database connections\. Not used for sqlite3\. . .TP -\fBdatabase_host\fR +\fBhost\fR Host for database connections\. Not used for sqlite3\. . .TP -\fBdatabase_port\fR +\fBport\fR Port for database connections\. Not used for sqlite3\. . .TP diff --git a/src/lib/Bcfg2/Options.py b/src/lib/Bcfg2/Options.py index a5436dbd0..f1bc54d49 100644 --- a/src/lib/Bcfg2/Options.py +++ b/src/lib/Bcfg2/Options.py @@ -467,11 +467,6 @@ SERVER_PLUGINS = \ 'SSHbase'], cf=('server', 'plugins'), cook=list_split) -SERVER_MCONNECT = \ - Option('Server Metadata Connector list', - default=['Probes'], - cf=('server', 'connectors'), - cook=list_split) SERVER_FILEMONITOR = \ Option('Server file monitor', default='default', @@ -496,10 +491,6 @@ SERVER_LOCATION = \ cmd='-S', odesc='https://server:port', cf=('components', 'bcfg2')) -SERVER_STATIC = \ - Option('Server runs on static port', - default=False, - cf=('components', 'bcfg2')) SERVER_KEY = \ Option('Path to SSL key', default=None, @@ -996,7 +987,6 @@ SERVER_COMMON_OPTIONS = dict(repo=SERVER_REPOSITORY, filemonitor=SERVER_FILEMONITOR, ignore=SERVER_FAM_IGNORE, location=SERVER_LOCATION, - static=SERVER_STATIC, key=SERVER_KEY, cert=SERVER_CERT, ca=SERVER_CA, diff --git a/src/sbin/bcfg2-info b/src/sbin/bcfg2-info index 44379ee89..f67850587 100755 --- a/src/sbin/bcfg2-info +++ b/src/sbin/bcfg2-info @@ -497,7 +497,6 @@ class infoCore(cmd.Cmd, Bcfg2.Server.Core.BaseCore): ('Server Metadata Connector', setup['mconnect']), ('Filemonitor', setup['filemonitor']), ('Server address', setup['location']), - ('Static', setup['static']), ('Path to key', setup['key']), ('Path to SSL certificate', setup['cert']), ('Path to SSL CA certificate', setup['ca']), diff --git a/tools/manpagegen/bcfg2.conf.5.ronn b/tools/manpagegen/bcfg2.conf.5.ronn index d5e3e64fc..3687e4c74 100644 --- a/tools/manpagegen/bcfg2.conf.5.ronn +++ b/tools/manpagegen/bcfg2.conf.5.ronn @@ -104,6 +104,18 @@ specified in the `[server]` section of the configuration file. Specifies a prefix if the Bcfg2 installation isn’t placed in the default location (e.g. /usr/local). + * `backend`: + Specifies which server core backend to use. Current available + options are: + + `cherrypy`, + `builtin`, + `best` + + The default is `best`, which is currently an alias for `builtin`. + More details on the backends can be found in the official + documentation. + ### Account Plugin The account plugin manages authentication data, including the following. @@ -345,12 +357,19 @@ settings used for client-server communication. * `retries`: A client-only option. Number of times to retry network - communication. + communication. Default is 3 retries. + + * `retry_delay`: + A client-only option. Number of seconds to wait in between + retrying network communication. Default is 1 second. * `serverCommonNames`: A client-only option. A colon-separated list of Common Names the client will accept in the SSL certificate presented by the server. + * `timeout`: + A client-only option. The network communication timeout. + * `user`: A client-only option. The UUID of the client. @@ -368,18 +387,32 @@ Specified in the `[components]` section. * `encoding`: Text encoding of configuration files. Defaults to UTF-8. + * `lockfile`: + The path to the client lock file, which is used to ensure that + only one Bcfg2 client runs at a time on a single client. + ## LOGGING OPTIONS Specified in the `[logging]` section. These options control the server logging functionality. + * `debug`: + Whether or not to enable debug-level log output. Default is + false. + * `path`: Server log file path. + * `syslog`: + Whether or not to send logging data to syslog. Default is true. + + * `verbose`: + Whether or not to enable verbose log output. Default is false. + ## MDATA OPTIONS -These options affect the default metadata settings for Paths with -type=’file’. +Specified in the `[mdata]` section. These options affect the default +metadata settings for Paths with type=’file’. * `owner`: Global owner for Paths (defaults to root) @@ -390,11 +423,20 @@ type=’file’. * `perms`: Global permissions for Paths (defaults to 644) + * `secontext`: + Global SELinux context for Path entries (defaults to + `__default__`, which restores the expected context) + * `paranoid`: Global paranoid settings for Paths (defaults to false) * `sensitive`: Global sensitive settings for Paths (defaults to false) + + * `important`: + Global important settings for Paths. Defaults to false, and + anything else is probably not a good idea. + ## PACKAGES OPTIONS @@ -501,12 +543,12 @@ found in the `[sslca_default]` section of the configuration file. specification. If you’re using a self signing CA this would be the CA cert that you generated. -## STATISTICS OPTIONS +## DATABASE OPTIONS -Server-only, specified in the `[statistics]` section. These options -control the statistics collection functionality of the server. +Server-only, specified in the `[database]` section. These options +control the database connection of the server. - * `database_engine`: + * `engine`: The database engine used by the statistics module. One of the following: @@ -515,21 +557,21 @@ control the statistics collection functionality of the server. `sqlite3`, `ado_mssql` - * `database_name`: + * `name`: 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 `$REPOSITORY_DIR/etc/brpt.sqlite`. - * `database_user`: + * `user`: User for database connections. Not used for sqlite3. - * `database_password`: + * `password`: Password for database connections. Not used for sqlite3. - * `database_host`: + * `host`: Host for database connections. Not used for sqlite3. - * `database_port`: + * `port`: Port for database connections. Not used for sqlite3. * `time_zone`: |