<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Plugins — Bcfg2 1.3.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/sidebar.js"></script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="top" title="Bcfg2 1.3.0 documentation" href="../../index.html" />
<link rel="up" title="The Bcfg2 Server" href="../index.html" />
<link rel="next" title="GroupPatterns" href="grouping/grouppatterns.html" />
<link rel="prev" title="The Bcfg2 Server" href="../index.html" />
<link rel="stylesheet" href="../../_static/bcfg2.css" type=""/>
</head>
<body>
<div style="text-align: left; padding: 10px 10px 15px 15px">
<a href="../../index.html"><img src="../../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="grouping/grouppatterns.html" title="GroupPatterns"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../index.html" title="The Bcfg2 Server"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a> | </li>
<!--<li><a href="../../search.html">search</a> | </li>-->
<li><a href="../../help/index.html">help</a> | </li>
<li><a href="../../contents.html">documentation </a> »</li>
<li><a href="../../contents.html" >Bcfg2 documentation 1.3.0</a> »</li>
<li><a href="../index.html" accesskey="U">The Bcfg2 Server</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="plugins">
<span id="server-plugins-index"></span><h1>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h1>
<p>Plugins are the source of all logic used in building a config. They can
perform one of several tasks:</p>
<ol class="arabic simple">
<li>Generating configuration inventory lists for clients</li>
<li>Generating configuration entry contents for clients</li>
<li>Probing client-side state (like hardware inventory, etc)
– the generic client probing mechanism is described at
<a class="reference internal" href="probes/index.html#server-plugins-probes-index"><em>Probes</em></a>.</li>
<li>Automating administrative tasks
(e.g. <a class="reference internal" href="generators/sshbase.html#server-plugins-generators-sshbase"><em>SSHbase</em></a> which automates ssh
key management)</li>
<li>Generating client per-entry installation decision-lists</li>
</ol>
<div class="section" id="enabling-plugins">
<h2>Enabling Plugins<a class="headerlink" href="#enabling-plugins" title="Permalink to this headline">¶</a></h2>
<p>In order for the Bcfg2 server to use a plugin, it needs to be listed on
the <em>plugins</em> line in <tt class="docutils literal"><span class="pre">bcfg2.conf</span></tt>.</p>
</div>
<div class="section" id="default-plugins">
<h2>Default Plugins<a class="headerlink" href="#default-plugins" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference external" href="http://trac.mcs.anl.gov/projects/bcfg2/browser/src/lib/Server/Plugins">Bcfg2 repository</a> contains the all plugins currently distributed
with Bcfg2.</p>
<div class="section" id="metadata-grouping">
<h3>Metadata (Grouping)<a class="headerlink" href="#metadata-grouping" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="grouping/grouppatterns.html">GroupPatterns</a></li>
<li class="toctree-l1"><a class="reference internal" href="grouping/ldap.html">Ldap</a></li>
<li class="toctree-l1"><a class="reference internal" href="grouping/metadata.html">Metadata</a></li>
</ul>
</div>
<p>Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.</p>
</div>
<div class="section" id="abstract-configuration-structures">
<h3>Abstract Configuration (Structures)<a class="headerlink" href="#abstract-configuration-structures" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="structures/bundler/index.html">Bundler</a></li>
<li class="toctree-l1"><a class="reference internal" href="structures/altsrc.html">altsrc</a></li>
<li class="toctree-l1"><a class="reference internal" href="structures/base.html">Base</a></li>
<li class="toctree-l1"><a class="reference internal" href="structures/defaults.html">Defaults</a></li>
<li class="toctree-l1"><a class="reference internal" href="structures/deps.html">Deps</a></li>
</ul>
</div>
<p>Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.</p>
</div>
<div class="section" id="literal-configuration-generators">
<h3>Literal Configuration (Generators)<a class="headerlink" href="#literal-configuration-generators" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="generators/account.html">Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/cfg.html">Cfg</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/decisions.html">Decisions</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/hostbase.html">Hostbase</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/nagiosgen.html">NagiosGen</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/packages.html">Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/pkgmgr.html">Pkgmgr</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/rules.html">Rules</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/semodules.html">SEModules</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/sshbase.html">SSHbase</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/sslca.html">SSLCA</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/tcheetah.html">TCheetah</a></li>
<li class="toctree-l1"><a class="reference internal" href="generators/tgenshi.html">TGenshi</a></li>
</ul>
</div>
<p>Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.</p>
</div>
<div class="section" id="connector-plugins">
<h3>Connector Plugins<a class="headerlink" href="#connector-plugins" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="connectors/properties.html">Properties</a></li>
<li class="toctree-l1"><a class="reference internal" href="connectors/puppetenc.html">PuppetENC</a></li>
<li class="toctree-l1"><a class="reference internal" href="connectors/templatehelper.html">TemplateHelper</a></li>
</ul>
</div>
</div>
<div class="section" id="statistics-plugins">
<h3>Statistics Plugins<a class="headerlink" href="#statistics-plugins" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="statistics/reporting.html">Reporting</a></li>
<li class="toctree-l1"><a class="reference internal" href="statistics/statistics.html">Statistics</a></li>
</ul>
</div>
<p>Reporting can be enabled by adding it to the plugins line in
<tt class="docutils literal"><span class="pre">/etc/bcfg2.conf</span></tt>.</p>
</div>
<div class="section" id="version-plugins">
<h3>Version Plugins<a class="headerlink" href="#version-plugins" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="version/bzr.html">Bzr</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/cvs.html">CVS</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/darcs.html">Darcs</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/fossil.html">Fossil</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/git.html">Git</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/hg.html">Mercurial (Hg)</a></li>
<li class="toctree-l1"><a class="reference internal" href="version/svn.html">Svn</a></li>
</ul>
</div>
</div>
<div class="section" id="miscellaneous-plugins">
<h3>Miscellaneous Plugins<a class="headerlink" href="#miscellaneous-plugins" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="misc/guppy.html">Guppy</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc/trigger.html">Trigger</a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="plugin-roles-in-1-0">
<h2>Plugin Roles (in 1.0)<a class="headerlink" href="#plugin-roles-in-1-0" title="Permalink to this headline">¶</a></h2>
<p>In version 1.0, plugins have been refactored into a series of roles. This
are fine-grained plugin capabilities that govern how the server core
interacts with plugins.</p>
<p>More details can be found in <a class="reference internal" href="plugin-roles.html#server-plugins-plugin-roles"><em>Plugin Roles</em></a></p>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Plugins</a><ul>
<li><a class="reference internal" href="#enabling-plugins">Enabling Plugins</a></li>
<li><a class="reference internal" href="#default-plugins">Default Plugins</a><ul>
<li><a class="reference internal" href="#metadata-grouping">Metadata (Grouping)</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#abstract-configuration-structures">Abstract Configuration (Structures)</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#literal-configuration-generators">Literal Configuration (Generators)</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#connector-plugins">Connector Plugins</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#statistics-plugins">Statistics Plugins</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#version-plugins">Version Plugins</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#miscellaneous-plugins">Miscellaneous Plugins</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#plugin-roles-in-1-0">Plugin Roles (in 1.0)</a><ul>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
title="previous chapter">The Bcfg2 Server</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="grouping/grouppatterns.html"
title="next chapter">GroupPatterns</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/server/plugins/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="grouping/grouppatterns.html" title="GroupPatterns"
>next</a> |</li>
<li class="right" >
<a href="../index.html" title="The Bcfg2 Server"
>previous</a> |</li>
<li><a href="../../index.html">home</a> | </li>
<!--<li><a href="../../search.html">search</a> | </li>-->
<li><a href="../../help/index.html">help</a> | </li>
<li><a href="../../contents.html">documentation </a> »</li>
<li><a href="../../contents.html" >Bcfg2 documentation 1.3.0</a> »</li>
<li><a href="../index.html" >The Bcfg2 Server</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2013, Narayan Desai.
Last updated on Mar 20, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
b50d8ee6d7871fcc13c0677a9364ed59
>
files
>
476
