<!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>Client Tool Drivers — 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 Client" href="index.html" />
<link rel="next" title="Actions" href="tools/actions.html" />
<link rel="prev" title="Client modes" href="modes.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="tools/actions.html" title="Actions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="modes.html" title="Client modes"
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 Client</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="client-tool-drivers">
<span id="client-tools"></span><h1>Client Tool Drivers<a class="headerlink" href="#client-tool-drivers" title="Permalink to this headline">¶</a></h1>
<p>Client tool drivers allow Bcfg2 to execute configuration operations by
interfacing with platform and distribution specific tools.</p>
<p>Tool drivers handle any reconfiguration or verification operation. So
far we have tools that primarily deal with packaging systems and service
management. The POSIX tool also handles file system and permissions/groups
operations.</p>
<p>To write your own tool driver, to handle a new packaging format, or new
service architecture see <a class="reference internal" href="../development/client-driver.html#development-client-driver"><em>Writing A Client Tool Driver</em></a></p>
<p>When the Bcfg2 client is run, it attempts to instantiate each of these
drivers. The succeeding list of drivers are printed as a debug message
after this process has completed. Drivers can supercede one another,
for example, the Yum driver conflicts (and unloads) the RPM driver. This
behavior can be overridden by running the Bcfg2 client with the <tt class="docutils literal"><span class="pre">-D</span></tt>
flag. This flag takes a colon delimited list of drivers to use on
the system.</p>
<p>Currently these are the tool drivers that are distributed with Bcfg2:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tools/actions.html">Actions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tools/actions.html#example-action-add-apt-keys">Example Action (add APT keys)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tools/apt.html">APT Client Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools/posixusers.html">POSIXUsers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tools/posixusers.html#primary-group-creation">Primary group creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools/posixusers.html#managed-uid-gid-ranges">Managed UID/GID Ranges</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools/posixusers.html#creating-a-baseline-configuration">Creating a baseline configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tools/vcs.html">VCS Client Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools/yum.html">Bcfg2 RPM/YUM Client Drivers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tools/yum.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools/yum.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="tools/yum.html#configuration-and-usage">Configuration and Usage</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="action">
<h2>Action<a class="headerlink" href="#action" title="Permalink to this headline">¶</a></h2>
<p>Pre and post-install tests and actions. This driver executes commands
and supplies status information to the Bcfg2 server via the statistics
mechanism. It can also be used to prevent bundle installation when
pre-conditions are not met. See the UsingActions page for more details.</p>
</div>
<div class="section" id="apk">
<h2>APK<a class="headerlink" href="#apk" title="Permalink to this headline">¶</a></h2>
<p>This tool driver is used to handle packages on apk based systems like Alpine
Linux and employs the “apk” executable. Extra information can be
found at <a class="reference external" href="http://apk-tools.sourceforge.net/">apk-tools</a>.</p>
</div>
<div class="section" id="apt">
<h2>APT<a class="headerlink" href="#apt" title="Permalink to this headline">¶</a></h2>
<p>Debian Packages. This tool driver is used to handle packages on dpkg
based systems and employs the “apt” executable. Extra information can be
found at <a class="reference internal" href="tools/apt.html#client-tools-apt"><em>APT Client Tool</em></a>.</p>
</div>
<div class="section" id="blast">
<h2>Blast<a class="headerlink" href="#blast" title="Permalink to this headline">¶</a></h2>
<p>Blastwave Packages. This tool driver is for blastwave packages on solaris</p>
</div>
<div class="section" id="chkconfig">
<h2>Chkconfig<a class="headerlink" href="#chkconfig" title="Permalink to this headline">¶</a></h2>
<p>Tool to manage services (primarily on Redhat based distros).</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Start and stop are standard arguments, but the one for reload
isn’t consistent across services. You can specify which argument
to use with the <tt class="docutils literal"><span class="pre">target</span></tt> attribute in Service tags. Example:</p>
<div class="last highlight-xml"><div class="highlight"><pre><span class="nt"><Service</span> <span class="na">name=</span><span class="s">"ftp"</span> <span class="na">target=</span><span class="s">"condrestart"</span> <span class="na">status=</span><span class="s">"on"</span> <span class="na">type=</span><span class="s">"chkconfig"</span><span class="nt">/></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="debinit">
<h2>DebInit<a class="headerlink" href="#debinit" title="Permalink to this headline">¶</a></h2>
<p>Debian Service Support; exec’s update-rc.d to configure services.</p>
</div>
<div class="section" id="encap">
<h2>Encap<a class="headerlink" href="#encap" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="http://www.encap.org">Encap</a> Packages.</p>
</div>
<div class="section" id="freebsdinit">
<h2>FreeBSDInit<a class="headerlink" href="#freebsdinit" title="Permalink to this headline">¶</a></h2>
<p>FreeBSD Service Support. Only bundle updates will work.</p>
</div>
<div class="section" id="freebsdpackage">
<h2>FreeBSDPackage<a class="headerlink" href="#freebsdpackage" title="Permalink to this headline">¶</a></h2>
<p>FreeBSD Packages. Verifies packages and their version numbers but can’t
install packages.</p>
</div>
<div class="section" id="launchd">
<h2>launchd<a class="headerlink" href="#launchd" title="Permalink to this headline">¶</a></h2>
<p>Mac OS X Services. To use this tool, you must maintain a standard launch
daemon .plist file in <tt class="docutils literal"><span class="pre">/Library/LaunchDaemons/</span></tt> (example ssh.plist)
and setup an entry in your config to load or unload the service.</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt"><Service</span> <span class="na">name=</span><span class="s">"com.openssh.sshd"</span> <span class="na">type=</span><span class="s">"launchd"</span> <span class="na">status=</span><span class="s">"on"</span><span class="nt">/></span>
</pre></div>
</div>
<p>Note the name is the <em>Label</em> specified inside of the .plist file</p>
</div>
<div class="section" id="portage">
<h2>Portage<a class="headerlink" href="#portage" title="Permalink to this headline">¶</a></h2>
<p>Support for Gentoo Packages.</p>
</div>
<div class="section" id="posix">
<h2>POSIX<a class="headerlink" href="#posix" title="Permalink to this headline">¶</a></h2>
<p>Files and Permissions are handled by the POSIX driver. Usage well
documented other places.</p>
</div>
<div class="section" id="rcupdate">
<h2>RcUpdate<a class="headerlink" href="#rcupdate" title="Permalink to this headline">¶</a></h2>
<p>Uses the rc-update executable to manage services on distributions such
as Gentoo.</p>
</div>
<div class="section" id="rpm">
<h2>RPM<a class="headerlink" href="#rpm" title="Permalink to this headline">¶</a></h2>
<p>Executes RPM to manage packages on Redhat-based and similar systems.
Consider using the <a class="reference internal" href="tools/yum.html#client-tools-yum"><em>YUM</em></a> tool instead if possible.</p>
<p>Formerly called <tt class="docutils literal"><span class="pre">RPMng</span></tt>, but was renamed for the 1.3 release.</p>
</div>
<div class="section" id="smf">
<h2>SMF<a class="headerlink" href="#smf" title="Permalink to this headline">¶</a></h2>
<p>Solaris Service Support.</p>
<p>Example legacy run service (lrc):</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt"><Service</span> <span class="na">name=</span><span class="s">'/etc/rc2_d/S47pppd'</span> <span class="na">FMRI=</span><span class="s">'lrc:/etc/rc2_d/S47pppd'</span> <span class="na">status=</span><span class="s">'off'</span> <span class="na">type=</span><span class="s">'smf'</span><span class="nt">/></span>
</pre></div>
</div>
</div>
<div class="section" id="systemd">
<h2>Systemd<a class="headerlink" href="#systemd" title="Permalink to this headline">¶</a></h2>
<p>Systemd service support.</p>
</div>
<div class="section" id="sysv">
<h2>SYSV<a class="headerlink" href="#sysv" title="Permalink to this headline">¶</a></h2>
<p>Handles System V Packaging format that is available on Solaris.</p>
</div>
<div class="section" id="upstart">
<h2>Upstart<a class="headerlink" href="#upstart" title="Permalink to this headline">¶</a></h2>
<p>Upstart service support. Uses <a class="reference external" href="http://upstart.ubuntu.com/">Upstart</a> to configure services.</p>
</div>
<div class="section" id="yum">
<h2>YUM<a class="headerlink" href="#yum" title="Permalink to this headline">¶</a></h2>
<p>Handles RPMs using the YUM package manager. Renamed from <tt class="docutils literal"><span class="pre">YUMng</span></tt> for
the 1.3 release. See <a class="reference internal" href="tools/yum.html#client-tools-yum"><em>Bcfg2 RPM/YUM Client Drivers</em></a> for more details.</p>
</div>
<div class="section" id="yum24">
<h2>YUM24<a class="headerlink" href="#yum24" title="Permalink to this headline">¶</a></h2>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Deprecated in favor of <a class="reference internal" href="tools/yum.html#client-tools-yum"><em>YUM</em></a></p>
</div>
<p>Handles RPMs using older versions of the YUM package manager.</p>
</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="#">Client Tool Drivers</a><ul>
<li><a class="reference internal" href="#action">Action</a></li>
<li><a class="reference internal" href="#apk">APK</a></li>
<li><a class="reference internal" href="#apt">APT</a></li>
<li><a class="reference internal" href="#blast">Blast</a></li>
<li><a class="reference internal" href="#chkconfig">Chkconfig</a></li>
<li><a class="reference internal" href="#debinit">DebInit</a></li>
<li><a class="reference internal" href="#encap">Encap</a></li>
<li><a class="reference internal" href="#freebsdinit">FreeBSDInit</a></li>
<li><a class="reference internal" href="#freebsdpackage">FreeBSDPackage</a></li>
<li><a class="reference internal" href="#launchd">launchd</a></li>
<li><a class="reference internal" href="#portage">Portage</a></li>
<li><a class="reference internal" href="#posix">POSIX</a></li>
<li><a class="reference internal" href="#rcupdate">RcUpdate</a></li>
<li><a class="reference internal" href="#rpm">RPM</a></li>
<li><a class="reference internal" href="#smf">SMF</a></li>
<li><a class="reference internal" href="#systemd">Systemd</a></li>
<li><a class="reference internal" href="#sysv">SYSV</a></li>
<li><a class="reference internal" href="#upstart">Upstart</a></li>
<li><a class="reference internal" href="#yum">YUM</a></li>
<li><a class="reference internal" href="#yum24">YUM24</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="modes.html"
title="previous chapter">Client modes</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="tools/actions.html"
title="next chapter">Actions</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/client/tools.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="tools/actions.html" title="Actions"
>next</a> |</li>
<li class="right" >
<a href="modes.html" title="Client modes"
>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 Client</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
>
346
