path: root/man/bcfg2.conf.5

.\" Man page generated from reStructuredText.
.
.TH "BCFG2.CONF" "5" "November 04, 2014" "1.4" "Bcfg2"
.SH NAME
bcfg2.conf \- Configuration parameters for Bcfg2
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH DESCRIPTION
.sp
bcfg2.conf includes configuration parameters for the Bcfg2 server and
client.
.SH FILE FORMAT
.sp
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.
.sp
Options are specified in the form "name=value".
.sp
The file is line\-based each newline\-terminated line represents either a
comment, a section name or an option.
.sp
Any line beginning with a hash (#) is ignored, as are lines containing
only whitespace.
.SH SERVER OPTIONS
.sp
These options are only necessary on the Bcfg2 server. They are specified
in the \fB[server]\fP section of the configuration file.
.INDENT 0.0
.TP
.B repository
Specifies the path to the Bcfg2 repository containing all of the
configuration specifications. The repository should be created using
the \fIbcfg2\-admin init\fP command.
.TP
.B filemonitor
The file monitor used to watch for changes in the repository. The
default is the best available monitor. The following values are
valid:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
inotify
gamin
pseudo
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B fam_blocking
Whether the server should block at startup until the file monitor
backend has processed all events. This can cause a slower startup,
but ensure that all files are recognized before the first client
is handled. Defaults to True.
.TP
.B ignore_files
A comma\-separated list of globs that should be ignored by the file
monitor. Default values are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
*~
*#
#*
*.swp
*.swpx
*.swx
SCCS
\&.svn
4913
\&.gitignore
.ft P
.fi
.UNINDENT
.UNINDENT
.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 \fBbcfg2.conf\fP\&.
.TP
.B plugins
A comma\-delimited list of enabled server plugins. Currently
available plugins are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
ACL
Bundler
Bzr
Cfg
Cvs
Darcs
Decisions
Defaults
Deps
FileProbes
Fossil
Git
GroupLogic
GroupPatterns
Guppy
Hg
Ldap
Metadata
NagiosGen
Ohai
Packages
Pkgmgr
POSIXCompat
Probes
Properties
PuppetENC
Reporting
Rules
SEModules
ServiceCompat
SSHbase
Svn
TemplateHelper
Trigger
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Descriptions of each plugin can be found in their respective
sections below.
.TP
.B prefix
Specifies a prefix if the Bcfg2 installation isn\(aqt placed in the
default location (e.g. \fB/usr/local\fP).
.TP
.B backend
Specifies which server core backend to use. Current available
options are:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
cherrypy
builtin
best
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The default is \fIbest\fP, which is currently an alias for \fIbuiltin\fP\&.
More details on the backends can be found in the official
documentation.
.TP
.B user
The username or UID to run the daemon as. Default is \fI0\fP\&.
.TP
.B group
The group name or GID to run the daemon as. Default is \fI0\fP\&.
.TP
.B vcs_root
Specifies the path to the root of the VCS working copy that holds
your Bcfg2 specification, if it is different from \fIrepository\fP\&.
E.g., if the VCS repository does not hold the bcfg2 data at the top
level, you may need to set this option.
.TP
.B umask
The umask to set for the server.  Default is \fI0077\fP\&.
.UNINDENT
.SH SERVER PLUGINS
.sp
This section has a listing of all the plugins currently provided with
Bcfg2.
.SS ACL Plugin
.sp
The ACL plugin controls which hosts can make which XML\-RPC calls.
.SS Bundler Plugin
.sp
The Bundler plugin 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
.sp
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
.sp
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
.sp
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
.sp
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 Decisions Plugin
.sp
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\fP"; this gives the ability to centrally specify
these changes, but only install them on clients when administrator
supervision is available.
.SS Defaults Plugin
.sp
The Defaults plugin can be used to populate default attributes for
entries. Defaults is \fInot\fP a Generator plugin, so it does not actually
bind an entry; Defaults are applied after an entry has been bound,
and only populate attributes that are not yet set.
.SS Deps Plugin
.sp
The Deps plugin allows you to make a series of assertions like "Package
X requires Package Y (and optionally also Package Z etc.)"
.SS FileProbes Plugin
.sp
The FileProbes plugin allows you to probe a client for a file, which is
then added to the Cfg specification. If the file changes on the client,
FileProbes can either update it in the specification or allow Cfg to
replace it.
.SS Fossil Plugin
.sp
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
.sp
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 GroupLogic Plugin
.sp
The GroupLogic plugin lets you flexibly assign group membership with a
Genshi template.
.SS GroupPatterns Plugin
.sp
The GroupPatterns plugin is a connector that can assign clients group
membership based on patterns in client hostnames.
.SS Guppy Plugin
.sp
The Guppy plugin is used to trace memory leaks within the bcfg2\-server
process using Guppy.
.SS Hg Plugin
.sp
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 Ldap Plugin
.sp
The Ldap plugin makes it possible to fetch data from a LDAP directory,
process it and attach it to your metadata.
.SS Metadata Plugin
.sp
The Metadata plugin is the primary method of specifying Bcfg2 server
metadata.
.SS NagiosGen Plugin
.sp
The NagiosGen plugin dynamically generates Nagios configuration files
based on Bcfg2 data.
.SS Ohai Plugin
.sp
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
.sp
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
.sp
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 POSIXCompat Plugin
.sp
The POSIXCompat plugin provides a compatibility layer for 1.3 POSIX
Entries so that they are compatible with older clients.
.SS Probes Plugin
.sp
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
.sp
The Properties plugin is a connector plugin that adds information from
properties files into client metadata instances.
.SS PuppetENC Plugin
.sp
The PuppetENC plugin is a connector plugin that adds support for Puppet
External Node Classifiers.
.SS Reporting Plugin
.sp
The Reporting plugin enables the collection of data for use with Bcfg2\(aqs
dynamic reporting system.
.SS Rules Plugin
.sp
The Rules plugin provides literal configuration entries that resolve
the abstract configuration entries normally found in Bundler. The
literal entries in Rules are suitable for consumption by the
appropriate client drivers.
.SS SEModules Plugin
.sp
The SEModules plugin provides a way to distribute SELinux modules via
Bcfg2.
.SS ServiceCompat Plugin
.sp
The ServiceCompat plugin converts service entries for older clients.
.SS SSHbase Plugin
.sp
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
.sp
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 Trigger Plugin
.sp
The Trigger plugin provides a method for calling external scripts when
clients are configured.
.SH CACHING OPTIONS
.sp
These options are specified in the \fB[caching]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B client_metadata
The following four caching modes are available for client
metadata:
.INDENT 7.0
.IP \(bu 2
off: No caching of client metadata objects is performed. This
is the default.
.IP \(bu 2
initial: Only initial metadata objects are cached. Initial
metadata objects are created only from the data in the
Metadata plugin, before additional groups from other plugins
are merged in.
.IP \(bu 2
cautious: Final metadata objects are cached, but each client’s
cache is cleared at the start of each client run, immediately
after probe data is received. Cache is also cleared as in
aggressive mode. \fIon\fP is a synonym for cautious.
.IP \(bu 2
aggressive: Final metadata objects are cached. Each plugin is
responsible for clearing cache when appropriate.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH CLIENT OPTIONS
.sp
These options only affect client functionality. They can be specified in
the \fB[client]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B decision
Specify the server decision list mode (whitelist or blacklist).
(This settiing 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.
.TP
.B profile
Assert the given profile for the host.
.UNINDENT
.UNINDENT
.UNINDENT
.SH COMMUNICATION OPTIONS
.sp
Specified in the \fB[communication]\fP section. These options define
settings used for client\-server communication.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.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/tlsv1.
.TP
.B retries
A client\-only option. Number of times to retry network
communication. Default is 3 retries.
.TP
.B retry_delay
A client\-only option. Number of seconds to wait in between
retrying network communication. Default is 1 second.
.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 timeout
A client\-only option. The network communication timeout.
.TP
.B user
A client\-only option. The UUID of the client.
.UNINDENT
.UNINDENT
.UNINDENT
.SH COMPONENT OPTIONS
.sp
Specified in the \fB[components]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.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.
.sp
e.g. \fIbcfg2 = https://10.3.1.6:6789\fP
.TP
.B encoding
Text encoding of configuration files. Defaults to UTF\-8.
.TP
.B 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.
.UNINDENT
.UNINDENT
.UNINDENT
.SH LOGGING OPTIONS
.sp
Specified in the \fB[logging]\fP section. These options control the server
logging functionality.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B debug
Whether or not to enable debug\-level log output. Default is false.
.TP
.B path
Server log file path.
.TP
.B syslog
Whether or not to send logging data to syslog. Default is true.
.TP
.B verbose
Whether or not to enable verbose log output. Default is false.
.UNINDENT
.UNINDENT
.UNINDENT
.SH MDATA OPTIONS
.sp
Specified in the \fB[mdata]\fP section. These options affect the default
metadata settings for Paths with type=\(aqfile\(aq.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B owner
Global owner for Paths (defaults to root)
.TP
.B group
Global group for Paths (defaults to root)
.TP
.B mode
Global permissions for Paths (defaults to 644)
.TP
.B secontext
Global SELinux context for Path entries (defaults to
\fI__default__\fP, which restores the expected context)
.TP
.B paranoid
Global paranoid settings for Paths (defaults to false)
.TP
.B sensitive
Global sensitive settings for Paths (defaults to false)
.TP
.B important
Global important settings for Paths. Defaults to false.
.UNINDENT
.UNINDENT
.UNINDENT
.SH PACKAGES OPTIONS
.sp
The following options are specified in the \fB[packages]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B backends
Comma separated list of backends for the dependency resolution.
Default is "Yum,Apt,Pac,Pkgng".
.TP
.B resolver
Enable dependency resolution. Default is 1 (true).
.TP
.B metadata
Enable metadata processing. Default is 1 (true). If metadata is
disabled, it’s implied that resolver is also disabled.
.TP
.B yum_config
The path at which to generate Yum configs. No default.
.TP
.B apt_config
The path at which to generate APT configs. No default.
.TP
.B gpg_keypath
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\fP\&.
.TP
.B version
Set the version attribute used when binding Packages. Default is
auto.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The following options are specified in the \fB[packages:yum]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B use_yum_libraries
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
.B helper
Path to bcfg2\-yum\-helper. By default, Bcfg2 looks first in $PATH
and then in \fB/usr/sbin/bcfg2\-yum\-helper\fP for the helper.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The following options are specified in the \fB[packages:pulp]\fP section.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B username
The username of a Pulp user that will be used to register new
clients and bind them to repositories.
.TP
.B password
The password of a Pulp user that will be used to register new
clients and bind them to repositories.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
All other options in the \fB[packages:yum]\fP section will be passed along
verbatim to the Yum configuration if you are using the native Yum
library support.
.SH PARANOID OPTIONS
.sp
These options allow for finer\-grained control of the paranoid mode on
the Bcfg2 client. They are specified in the \fB[paranoid]\fP section of
the configuration file.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B path
Custom path for backups created in paranoid mode. The default is
in \fB/var/cache/bcfg2\fP\&.
.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.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SSL CA OPTIONS
.sp
These options are necessary to configure the SSL CA feature of the Cfg
plugin and can be found in the \fB[sslca_default]\fP section of the
configuration file.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B config
Specifies the location of the openssl configuration file for
your CA.
.TP
.B passphrase
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
.B chaincert
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.
.UNINDENT
.UNINDENT
.UNINDENT
.SH DATABASE OPTIONS
.sp
Server\-only, specified in the \fB[database]\fP section. These options
control the database connection of the server.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B engine
The database engine used by server plugins. One of the
following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
postgresql
mysql
sqlite3
ado_mssql
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B name
The name of the database to use for server data. If
\(aqdatabase_engine\(aq is set to \(aqsqlite3\(aq this is a file path to
the sqlite file and defaults to \fB$REPOSITORY_DIR/etc/bcfg2.sqlite\fP\&.
.TP
.B user
User for database connections. Not used for sqlite3.
.TP
.B password
Password for database connections. Not used for sqlite3.
.TP
.B host
Host for database connections. Not used for sqlite3.
.TP
.B port
Port for database connections. Not used for sqlite3.
.TP
.B options
Various options for the database connection. The value expected
is the literal value of the django OPTIONS setting.
.TP
.B reporting_engine
The database engine used by the Reporting plugin. One of the
following:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
   postgresql
   mysql
   sqlite3
   ado_mssql

If reporting_engine is not specified, the Reporting plugin uses
the same database as the other server plugins.
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B reporting_name
The name of the database to use for reporting data. If
\(aqdatabase_engine\(aq is set to \(aqsqlite3\(aq this is a file path to
the sqlite file and defaults to
\fB$REPOSITORY_DIR/etc/reporting.sqlite\fP.
.TP
.B reporting_user
User for reporting database connections. Not used for sqlite3.
.TP
.B reporting_password
Password for reporting database connections. Not used for sqlite3.
.TP
.B reporting_host
Host for reporting database connections. Not used for sqlite3.
.TP
.B reporting_port
Port for reporting database connections. Not used for sqlite3.
.TP
.B reporting_options
Various options for the reporting database connection. The value
expected is the literal value of the django OPTIONS setting.
.UNINDENT
.UNINDENT
.UNINDENT
.SH REPORTING OPTIONS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B config
Specifies the location of the reporting configuration (default
is /etc/bcfg2\-web.conf.
.TP
.B time_zone
Specifies 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).
.TP
.B web_debug
Turn on Django debugging.
.TP
.B max_children
Maximum number of children for the reporting collector. Use 0 to
disable the limit. (default is 0)
.TP
.B django_settings
Arbitrary options for the Django installation. The value expected
is a literal python dictionary, that is merged with the already set
django settings.
.UNINDENT
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fIbcfg2(1)\fP, \fIbcfg2\-server(8)\fP
.\" Generated by docutils manpage writer.
.