summaryrefslogtreecommitdiffstats
path: root/doc/client
diff options
context:
space:
mode:
authorFabian Affolter <fabian@bernewireless.net>2010-11-09 00:15:43 +0100
committerFabian Affolter <fabian@bernewireless.net>2010-11-09 00:15:43 +0100
commit391406c85d86dc931f3fdb2483a14d0f1e7e6355 (patch)
tree97fe00f6a9dcf5d821139766b213418d57b5d31b /doc/client
parent553c693618321fad2a88030b16d42d3253befaec (diff)
downloadbcfg2-391406c85d86dc931f3fdb2483a14d0f1e7e6355.tar.gz
bcfg2-391406c85d86dc931f3fdb2483a14d0f1e7e6355.tar.bz2
bcfg2-391406c85d86dc931f3fdb2483a14d0f1e7e6355.zip
doc: Massive update
Diffstat (limited to 'doc/client')
-rw-r--r--doc/client/tools/blast.txt10
-rw-r--r--doc/client/tools/chkconfig.txt15
-rw-r--r--doc/client/tools/debinit.txt9
-rw-r--r--doc/client/tools/encap.txt9
-rw-r--r--doc/client/tools/freebsdinit.txt9
-rw-r--r--doc/client/tools/freebsdpackage.txt10
-rw-r--r--doc/client/tools/index.txt171
-rw-r--r--doc/client/tools/launchd.txt13
-rw-r--r--doc/client/tools/portage.txt9
-rw-r--r--doc/client/tools/posix.txt10
-rw-r--r--doc/client/tools/rcupdate.txt10
-rw-r--r--doc/client/tools/rpm.txt11
-rw-r--r--doc/client/tools/rpmng.txt11
-rw-r--r--doc/client/tools/smf.txt15
-rw-r--r--doc/client/tools/sysv.txt9
-rw-r--r--doc/client/tools/upstart.txt11
-rw-r--r--doc/client/tools/yum.txt11
17 files changed, 196 insertions, 147 deletions
diff --git a/doc/client/tools/blast.txt b/doc/client/tools/blast.txt
new file mode 100644
index 000000000..14eb53124
--- /dev/null
+++ b/doc/client/tools/blast.txt
@@ -0,0 +1,10 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-blast:
+
+=====
+Blast
+=====
+
+Blastwave Packages. This tool driver is for blastwave packages on
+solaris.
diff --git a/doc/client/tools/chkconfig.txt b/doc/client/tools/chkconfig.txt
new file mode 100644
index 000000000..35cc0969e
--- /dev/null
+++ b/doc/client/tools/chkconfig.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-chkconfig:
+
+=========
+Chkconfig
+=========
+
+Tool to manage services (primarily on Red Hat based distros).
+
+.. note:: 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 `restart` property in Service tags. Example:
+ ``<Service name="ftp" restart="condrestart" status="on"
+ type="chkconfig">``
diff --git a/doc/client/tools/debinit.txt b/doc/client/tools/debinit.txt
new file mode 100644
index 000000000..33d20f89c
--- /dev/null
+++ b/doc/client/tools/debinit.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-debinit:
+
+=======
+DebInit
+=======
+
+Debian Service Support; exec's update-rc.d to configure services.
diff --git a/doc/client/tools/encap.txt b/doc/client/tools/encap.txt
new file mode 100644
index 000000000..40508ac7a
--- /dev/null
+++ b/doc/client/tools/encap.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-encap:
+
+=====
+Encap
+=====
+
+`Encap <http://www.encap.org>`_ Packages.
diff --git a/doc/client/tools/freebsdinit.txt b/doc/client/tools/freebsdinit.txt
new file mode 100644
index 000000000..7df2518bc
--- /dev/null
+++ b/doc/client/tools/freebsdinit.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-freebsdinit:
+
+===========
+FreeBSDInit
+===========
+
+FreeBSD Service Support. Only bundle updates will work.
diff --git a/doc/client/tools/freebsdpackage.txt b/doc/client/tools/freebsdpackage.txt
new file mode 100644
index 000000000..a460fb41c
--- /dev/null
+++ b/doc/client/tools/freebsdpackage.txt
@@ -0,0 +1,10 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-freebsdpackage:
+
+==============
+FreeBSDPackage
+==============
+
+FreeBSD Packages. Verifies packages and their version numbers but can't
+install packages.
diff --git a/doc/client/tools/index.txt b/doc/client/tools/index.txt
index 878a221ee..7f6e6b667 100644
--- a/doc/client/tools/index.txt
+++ b/doc/client/tools/index.txt
@@ -2,154 +2,31 @@
.. _client-tools-index:
-Client Tool Drivers
-===================
-
-Client tool drivers allow Bcfg2 to execute configuration operations by
-interfacing with platform and distribution specific tools.
-
-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.
-
-To write your own tool driver, to handle a new packaging format, or new
-service architecture see :ref:`development-index-writingtooldrivers`
-
-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 -D
-flag. This flag takes a colon delimited list of drivers to use on
-the system.
+Available client tools
+======================
+
+Client tool drivers allow Bcfg2 to execute configuration operations
+by interfacing with platform and distribution specific tools.
+
+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. To write your own tool driver,
+to handle a new packaging format, or new service architecture see
+:ref:`development-client-driver`.
+
+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 ``-D`` flag. This flag takes a colon
+delimited list of drivers to use on the system.
Currently these are the tool drivers that are distributed with Bcfg2:
-Action
-------
-
-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.
-
-APT
----
-
-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 :ref:`client-tools-apt`.
-
-Blast
------
-
-Blastwave Packages. This tool driver is for blastwave packages on solaris
-
-Chkconfig
----------
-
-Tool to manage services (primarily on Redhat based distros).
-
-.. note:: 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 `restart` property in Service tags. Example:
- ``<Service name="ftp" restart="condrestart" status="on"
- type="chkconfig">``
-
-DebInit
--------
-
-Debian Service Support; exec's update-rc.d to configure services.
-
-Encap
------
-
-`Encap <http://www.encap.org>`_ Packages.
-
-FreeBSDInit
------------
-
-FreeBSD Service Support. Only bundle updates will work.
-
-FreeBSDPackage
---------------
-
-FreeBSD Packages. Verifies packages and their version numbers but can't
-install packages.
-
-launchd
--------
-
-Mac OS X Services. To use this tool, you must maintain a standard launch
-daemon .plist file in ``/Library/LaunchDaemons/`` (example ssh.plist)
-and setup a ``<Service name="com.openssh.sshd" type="launchd" status="on"
-/>`` entry in your config to load or unload the service. Note the name
-is the ''Label'' specified inside of the .plist file
-
-Portage
--------
-
-Support for Gentoo Packages.
-
-POSIX
------
-
-Files and Permissions are handled by the POSIX driver. Usage well
-documented other places.
-
-RcUpdate
---------
-
-Uses the rc-update executable to manage services on distributions such
-as Gentoo.
-
-RPM
----
-
-.. warning:: Deprecated in favor of :ref:`RPMng <client-tools-yumng>`
-
-Executes rpm to manage packages most often on redhat based systems.
-
-RPMng
------
-
-Next-generation RPM tool, will be default in upcoming release. Handles
-RPM sublties like epoch and prelinking and 64-bit platforms better than
-RPM client tool. :ref:`client-tools-yumng`
-
-SMF
----
-
-Solaris Service Support.
-
-Example legacy run service (lrc):
-
-.. code-block:: xml
-
- <BoundService name='/etc/rc2_d/S47pppd' FMRI='lrc:/etc/rc2_d/S47pppd' status='off' type='smf'/>
-
-SYSV
-----
-
-Handles System V Packaging format that is available on Solaris.
-
-Upstart
--------
-
-Upstart service support. Uses `Upstart`_ to configure services.
-
-.. _Upstart: http://upstart.ubuntu.com/
-
-Yum
----
-
-.. warning:: Deprecated in favor of :ref:`YUMng <client-tools-yumng>`
-
-Handles RPMs using the YUM package manager.
-
-YUMng
------
+.. toctree::
+ :maxdepth: 1
+ :glob:
-Handles RPMs using the YUM package manager. Handles sublties better than
-the Yum client tool. :ref:`client-tools-yumng`
+ *
diff --git a/doc/client/tools/launchd.txt b/doc/client/tools/launchd.txt
new file mode 100644
index 000000000..59a872297
--- /dev/null
+++ b/doc/client/tools/launchd.txt
@@ -0,0 +1,13 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-launchd:
+
+=======
+launchd
+=======
+
+Mac OS X Services. To use this tool, you must maintain a standard launch
+daemon .plist file in ``/Library/LaunchDaemons/`` (example ssh.plist)
+and setup a ``<Service name="com.openssh.sshd" type="launchd" status="on"
+/>`` entry in your config to load or unload the service. Note the name
+is the ''Label'' specified inside of the .plist file
diff --git a/doc/client/tools/portage.txt b/doc/client/tools/portage.txt
new file mode 100644
index 000000000..7a91408b1
--- /dev/null
+++ b/doc/client/tools/portage.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-portage:
+
+=======
+Portage
+=======
+
+Support for Gentoo Packages.
diff --git a/doc/client/tools/posix.txt b/doc/client/tools/posix.txt
new file mode 100644
index 000000000..c4da38332
--- /dev/null
+++ b/doc/client/tools/posix.txt
@@ -0,0 +1,10 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-posix:
+
+=====
+POSIX
+=====
+
+Files and Permissions are handled by the POSIX driver. Usage well
+documented other places.
diff --git a/doc/client/tools/rcupdate.txt b/doc/client/tools/rcupdate.txt
new file mode 100644
index 000000000..4547d3b39
--- /dev/null
+++ b/doc/client/tools/rcupdate.txt
@@ -0,0 +1,10 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-rcupdate:
+
+========
+RcUpdate
+========
+
+Uses the rc-update executable to manage services on distributions such
+as Gentoo.
diff --git a/doc/client/tools/rpm.txt b/doc/client/tools/rpm.txt
new file mode 100644
index 000000000..17d367b55
--- /dev/null
+++ b/doc/client/tools/rpm.txt
@@ -0,0 +1,11 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-rpm:
+
+===
+RPM
+===
+
+.. warning:: Deprecated in favor of :ref:`RPMng <client-tools-yumng>`
+
+Executes rpm to manage packages most often on redhat based systems.
diff --git a/doc/client/tools/rpmng.txt b/doc/client/tools/rpmng.txt
new file mode 100644
index 000000000..c6d6cddf1
--- /dev/null
+++ b/doc/client/tools/rpmng.txt
@@ -0,0 +1,11 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-rpmng:
+
+=====
+RPMng
+=====
+
+Next-generation RPM tool, will be default in upcoming release. Handles
+RPM sublties like epoch and prelinking and 64-bit platforms better than
+RPM client tool.
diff --git a/doc/client/tools/smf.txt b/doc/client/tools/smf.txt
new file mode 100644
index 000000000..4829a14ed
--- /dev/null
+++ b/doc/client/tools/smf.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-smf:
+
+===
+SMF
+===
+
+Solaris Service Support.
+
+Example legacy run service (lrc):
+
+.. code-block:: xml
+
+ <BoundService name='/etc/rc2_d/S47pppd' FMRI='lrc:/etc/rc2_d/S47pppd' status='off' type='smf'/>
diff --git a/doc/client/tools/sysv.txt b/doc/client/tools/sysv.txt
new file mode 100644
index 000000000..c08614c52
--- /dev/null
+++ b/doc/client/tools/sysv.txt
@@ -0,0 +1,9 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-sysv:
+
+====
+SYSV
+====
+
+Handles System V Packaging format that is available on Solaris.
diff --git a/doc/client/tools/upstart.txt b/doc/client/tools/upstart.txt
new file mode 100644
index 000000000..60d0cf4ef
--- /dev/null
+++ b/doc/client/tools/upstart.txt
@@ -0,0 +1,11 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-upstart:
+
+=======
+Upstart
+=======
+
+Upstart service support. Uses `Upstart`_ to configure services.
+
+.. _Upstart: http://upstart.ubuntu.com/
diff --git a/doc/client/tools/yum.txt b/doc/client/tools/yum.txt
new file mode 100644
index 000000000..fcb5244df
--- /dev/null
+++ b/doc/client/tools/yum.txt
@@ -0,0 +1,11 @@
+.. -*- mode: rst -*-
+
+.. _client-tools-yum:
+
+===
+Yum
+===
+
+.. warning:: Deprecated in favor of :ref:`YUMng <client-tools-yumng>`
+
+Handles RPMs using the YUM package manager.