Changes between Version 1 and Version 2 of 5+bcfg2.conf

Show
Ignore:
Timestamp:
11/06/09 09:31:45 (2 weeks ago)
Author:
dclark (IP: 72.255.66.205)
Comment:

Update to 1.0.0

Legend:

Unmodified
Added
Removed
Modified

  • 5+bcfg2.conf

    v1 v2  
    1515 
    1616<DL COMPACT> 
    17 <DT>bcfg2.conf includes configuration parameters for the bcfg2 server and client. <DD> 
     17<DT>bcfg2.conf includes configuration parameters for the bcfg2 server and client.<DD> 
    1818<P> 
    1919</DL> 
    … …  
    2121<H2>FILE FORMAT</H2> 
    2222 
    23 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.  
     23The 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. 
    2424<P> 
    2525Options are specified in the form 'name = value'. 
    … …  
    2828<P> 
    2929Any line beginning with a hash (#) is ignored, as are lines containing only whitespace. 
     30<P> 
    3031<P> 
    3132<A NAME="lbAE">&nbsp;</A> 
    … …  
    4041Specifies the path to the Bcfg2 repository containing all of the configuration specifications. The repository should be created using the bcfg2-init command. 
    4142<P> 
    42 <DT><B>svn</B> 
    43  
    44 <DD> 
    45 Set this to yes if the repository is SVN managed. 
    46 <P> 
    47 <DT><B>structures</B> 
    48  
    49 <DD> 
    50 A comma-delimited list of all the enabled structures plugins. Currently available plugins are Base, Bundler, and SGenshi. Defaults to Bundler and Base. 
    51 <P> 
    52 <DT><B>generators</B> 
    53  
    54 <DD> 
    55 A comma-delimited list of all enabled generator plugins. Currently available plugins are Actions, Cfg, Deps, Hostbase, Pkgmgr, Rules, SSHbase, TCheetah, and TGenshi. Defaults to SSHbase, Cfg, Pkgmgr, and Rules. 
     43<DT><B>key</B> 
     44 
     45<DD> 
     46Specifies 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.  
     47<P> 
     48<DT><B>certificate</B> 
     49 
     50<DD> 
     51The 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.  
     52<P> 
     53<DT><B>ca</B> 
     54 
     55<DD> 
     56The 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.  
     57<P> 
     58<DT><B>filemonitor</B> 
     59 
     60<DD> 
     61The file monitor used to watch for changes in the repository. Values of 'gamin', 'fam', or 'pseudo' are valid. 
    5662<P> 
    5763<DT><B>plugins</B> 
    5864 
    5965<DD> 
    60 A comma-delimited list of enabled server plugins. Currently available plugins are DBStats. 
    61 <P> 
    62 <DT><B>bundles</B> 
    63  
    64 <DD> 
    65 A list of enabled bundles 
    66 <P> 
    67 <DT><B>filemonitor</B> 
    68  
    69 <DD> 
    70 The file monitor used to watch for changes in the repository. Values of 'gamin', 'fam', or 'pseudo' are valid. 
     66A comma-delimited list of enabled server plugins. Currently available plugins are: 
     67<P> 
     68&bull; 
     69<B>Account</B> 
     70 
     71The account plugin manages authentication data, including: 
     72<P> 
     73<BR>&nbsp;*&nbsp;/etc/passwd 
     74<BR>&nbsp;*&nbsp;/etc/group 
     75<BR>&nbsp;*&nbsp;/etc/security/limits.conf 
     76<BR>&nbsp;*&nbsp;/etc/sudoers 
     77<BR>&nbsp;*&nbsp;/root/.ssh/authorized_keys 
     78<P> 
     79&bull; 
     80<B>Actions</B> 
     81 
     82<P> 
     83Action 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. 
     84<P> 
     85&bull; 
     86<B>BB</B> 
     87 
     88<P> 
     89&bull; 
     90<B>Base</B> 
     91 
     92A 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. 
     93<P> 
     94&bull; 
     95<B>Bundler</B> 
     96 
     97Bundler 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 
     98entries. 
     99<P> 
     100&bull; 
     101<B>Bzr</B> 
     102 
     103The 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. 
     104<P> 
     105&bull; 
     106<B>Cfg</B> 
     107 
     108The 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. 
     109<P> 
     110&bull; 
     111<B>DBStats</B> 
     112 
     113Direct to database statistics plugin (0.9.6 and later). 
     114<P> 
     115&bull; 
     116<B>Decisions</B> 
     117 
     118The Decisions plugin has support for a centralized set of per-entry installation decisions. This approach is needed when particular changes are deemed &quot;high risk&quot;; 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) 
     119<P> 
     120&bull; 
     121<B>Deps</B> 
     122 
     123The Deps plugin allows you to make a series of assertions like &quot;Package X requires Package Y (and optionally also Package Z etc.) 
     124<P> 
     125&bull; 
     126<B>Editor</B> 
     127 
     128The Editor plugin allows you to partially manage configuration for a file. Its use is not recommended and not well documented. 
     129<P> 
     130&bull; 
     131<B>Fossil</B> 
     132 
     133The 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. 
     134<P> 
     135&bull; 
     136<B>Git</B> 
     137 
     138The 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. 
     139<P> 
     140&bull; 
     141<B>GroupPatterns</B> 
     142 
     143The GroupPatterns plugin is a connector that can assign clients group membership pased on patterns in client hostnames. 
     144<P> 
     145&bull; 
     146<B>Hostbase</B> 
     147 
     148The Hostbase plugin is an IP management system built on top of Bcfg2. 
     149<P> 
     150&bull; 
     151<B>Metadata</B> 
     152 
     153The Metadata plugin is the primary method of specifying Bcfg2 server metadata. 
     154<P> 
     155&bull; 
     156<B>NagiosGen</B> 
     157 
     158NagiosGen is a Bcfg2 plugin that dynamically generates Nagios configuration files based on Bcfg2 data. 
     159<P> 
     160&bull; 
     161<B>Ohai</B> 
     162 
     163<P> 
     164&bull; 
     165<B>POSIXCompat</B> 
     166 
     167The POSIXCompat plugin provides a compatibility layer which turns new-style (1.0) POSIX entries into old-style entries which are compatible with previous releases. 
     168<P> 
     169&bull; 
     170<B>Packages</B> 
     171 
     172The 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. 
     173<P> 
     174&bull; 
     175<B>Pkgmgr</B> 
     176 
     177The Pkgmgr plugin resolves the Abstract Configuration Entity &quot;Package&quot; to a package specification that the client can use to detect, verify and install the specified package. 
     178<P> 
     179&bull; 
     180<B>Probes</B> 
     181 
     182The 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. 
     183<P> 
     184&bull; 
     185<B>Properties</B> 
     186 
     187The Properties plugin is a connector plugin that adds information from properties files into client metadata instances. (1.0 and later) 
     188<P> 
     189&bull; 
     190<B>Rules</B> 
     191 
     192The Rules plugin resolves Abstract Configuration Entities to literal configuration entries suitable for the client drivers to consume. 
     193<P> 
     194&bull; 
     195<B>SGenshi (Deprecated)</B> 
     196 
     197See Bundler. 
     198<P> 
     199&bull; 
     200<B>Snapshots</B> 
     201 
     202The Snapshots plugin stores various aspects of a client's state when the client checks in to the server. 
     203<P> 
     204&bull; 
     205<B>SSHbase</B> 
     206 
     207The 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. 
     208<P> 
     209&bull; 
     210<B>Svn</B> 
     211 
     212The 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. 
     213<P> 
     214&bull; 
     215<B>TCheetah</B> 
     216 
     217The 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. 
     218<P> 
     219&bull; 
     220<B>TGenshi</B> 
     221 
     222The 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. 
     223<P> 
     224&bull; 
     225<B>Trigger</B> 
     226 
     227Trigger is a plugin that calls external scripts when clients are configured. 
     228<P> 
    71229<P> 
    72230</DL> 
    73231<A NAME="lbAF">&nbsp;</A> 
     232<H2>MDATA OPTIONS</H2> 
     233 
     234These options affect the default metadata settings for ConfigFiles. 
     235<P> 
     236<DL COMPACT> 
     237<DT><B>owner</B> 
     238 
     239<DD> 
     240Global owner for ConfigFiles (defaults to root) 
     241<P> 
     242<DT><B>group</B> 
     243 
     244<DD> 
     245Global group for ConfigFiles (defaults to root) 
     246<P> 
     247<DT><B>perms</B> 
     248 
     249<DD> 
     250Global permissions for ConfigFiles (defaults to 644) 
     251<P> 
     252<DT><B>paranoid</B> 
     253 
     254<DD> 
     255Global paranoid settings for ConfigFiles (defaults to false) 
     256<P> 
     257<P> 
     258</DL> 
     259<A NAME="lbAG">&nbsp;</A> 
     260<H2>CLIENT OPTIONS</H2> 
     261 
     262These options only affect client functionality, specified in the [client] section. 
     263<P> 
     264<DL COMPACT> 
     265<DT><B>drivers</B> 
     266 
     267<DD> 
     268Specify 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. 
     269<P> 
     270<DT><B>paranoid</B> 
     271 
     272<DD> 
     273Run the client in paranoid mode. 
     274<P> 
     275<P> 
     276</DL> 
     277<A NAME="lbAH">&nbsp;</A> 
    74278<H2>STATISTICS OPTIONS</H2> 
    75279 
    … …  
    107311Port for database connections. Not used for sqlite3. 
    108312<P> 
    109 </DL> 
    110 <A NAME="lbAG">&nbsp;</A> 
     313<P> 
     314</DL> 
     315<A NAME="lbAI">&nbsp;</A> 
    111316<H2>COMMUNICATION OPTIONS</H2> 
    112317 
    … …  
    144349A client-only option. The UUID of the client. 
    145350<P> 
    146 <DT><B>fingerprint</B> 
    147  
    148 <DD> 
    149 A client-only option. The fingerprint of the server's SSL certificate. Obtainable by running 'bcfg2-admin fingerprint'. 
    150 <P> 
    151 </DL> 
    152 <A NAME="lbAH">&nbsp;</A> 
     351</DL> 
     352<A NAME="lbAJ">&nbsp;</A> 
     353<H2>PARANOID OPTIONS</H2> 
     354 
     355These 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. 
     356<P> 
     357<DL COMPACT> 
     358<DT><B>path</B> 
     359 
     360<DD> 
     361Custom path for backups created in paranoid mode. The default is in /var/cache/bcfg2. 
     362<P> 
     363<DT><B>max_copies</B> 
     364 
     365<DD> 
     366Specify 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. 
     367<P> 
     368</DL> 
     369<A NAME="lbAK">&nbsp;</A> 
    153370<H2>COMPONENT OPTIONS</H2> 
    154371 
    … …  
    159376 
    160377<DD> 
    161 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 = <A HREF="https://10.3.1.6:6789">https://10.3.1.6:6789</A>  
     378URL 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 = <A HREF="https://10.3.1.6:6789">https://10.3.1.6:6789</A> 
    162379<P> 
    163380<DT><B>encoding</B> 
    … …  
    166383Text encoding of configuration files. Defaults to the system default encoding. 
    167384<P> 
    168 </DL> 
    169 <A NAME="lbAI">&nbsp;</A> 
     385<P> 
     386</DL> 
     387<A NAME="lbAL">&nbsp;</A> 
    170388<H2>LOGGING OPTIONS</H2> 
    171389 
    … …  
    176394Server log file path. 
    177395<P> 
    178 <A NAME="lbAJ">&nbsp;</A> 
     396<P> 
     397<A NAME="lbAM">&nbsp;</A> 
     398<H2>SNAPSHOTS OPTIONS</H2> 
     399 
     400Specified in the [snapshots] section. These options control the server snapshots functionality. 
     401<P> 
     402<B>driver</B> 
     403 
     404sqlite 
     405<P> 
     406<B>database</B> 
     407 
     408The name of the database to use for statistics data. eg: $REPOSITORY_DIR/etc/bcfg2.sqlite 
     409<P> 
     410<A NAME="lbAN">&nbsp;</A> 
    179411<H2>SEE ALSO</H2> 
    180412 
    … …  
    193425<DT><A HREF="#lbAD">FILE FORMAT</A><DD> 
    194426<DT><A HREF="#lbAE">SERVER OPTIONS</A><DD> 
    195 <DT><A HREF="#lbAF">STATISTICS OPTIONS</A><DD> 
    196 <DT><A HREF="#lbAG">COMMUNICATION OPTIONS</A><DD> 
    197 <DT><A HREF="#lbAH">COMPONENT OPTIONS</A><DD> 
    198 <DT><A HREF="#lbAI">LOGGING OPTIONS</A><DD> 
    199 <DT><A HREF="#lbAJ">SEE ALSO</A><DD> 
     427<DT><A HREF="#lbAF">MDATA OPTIONS</A><DD> 
     428<DT><A HREF="#lbAG">CLIENT OPTIONS</A><DD> 
     429<DT><A HREF="#lbAH">STATISTICS OPTIONS</A><DD> 
     430<DT><A HREF="#lbAI">COMMUNICATION OPTIONS</A><DD> 
     431<DT><A HREF="#lbAJ">PARANOID OPTIONS</A><DD> 
     432<DT><A HREF="#lbAK">COMPONENT OPTIONS</A><DD> 
     433<DT><A HREF="#lbAL">LOGGING OPTIONS</A><DD> 
     434<DT><A HREF="#lbAM">SNAPSHOTS OPTIONS</A><DD> 
     435<DT><A HREF="#lbAN">SEE ALSO</A><DD> 
    200436</DL> 
    201437<HR> 
    … …  
    203439<A HREF="/projects/bcfg2/wiki">man2html</A>, 
    204440using the manual pages.<BR> 
    205 Time: 21:15:34 GMT, January 23, 2009 
     441Time: 15:26:32 GMT, November 06, 2009 
    206442}}}