From 477c0fc85218cba12597cf3daf7728b127b0fd64 Mon Sep 17 00:00:00 2001 From: Sol Jerome Date: Wed, 8 Dec 2010 19:43:54 -0600 Subject: doc: Finish merging remaining documentation updates Signed-off-by: Sol Jerome --- doc/client/tools/blast.txt | 10 --- doc/client/tools/chkconfig.txt | 15 ---- doc/client/tools/debinit.txt | 9 -- doc/client/tools/encap.txt | 9 -- doc/client/tools/freebsdinit.txt | 9 -- doc/client/tools/freebsdpackage.txt | 10 --- doc/client/tools/index.txt | 171 +++++++++++++++++++++++++++++++----- doc/client/tools/launchd.txt | 13 --- doc/client/tools/portage.txt | 9 -- doc/client/tools/posix.txt | 10 --- doc/client/tools/rcupdate.txt | 10 --- doc/client/tools/rpm.txt | 11 --- doc/client/tools/rpmng.txt | 11 --- doc/client/tools/smf.txt | 15 ---- doc/client/tools/sysv.txt | 9 -- doc/client/tools/upstart.txt | 11 --- doc/client/tools/yum.txt | 11 --- 17 files changed, 147 insertions(+), 196 deletions(-) delete mode 100644 doc/client/tools/blast.txt delete mode 100644 doc/client/tools/chkconfig.txt delete mode 100644 doc/client/tools/debinit.txt delete mode 100644 doc/client/tools/encap.txt delete mode 100644 doc/client/tools/freebsdinit.txt delete mode 100644 doc/client/tools/freebsdpackage.txt delete mode 100644 doc/client/tools/launchd.txt delete mode 100644 doc/client/tools/portage.txt delete mode 100644 doc/client/tools/posix.txt delete mode 100644 doc/client/tools/rcupdate.txt delete mode 100644 doc/client/tools/rpm.txt delete mode 100644 doc/client/tools/rpmng.txt delete mode 100644 doc/client/tools/smf.txt delete mode 100644 doc/client/tools/sysv.txt delete mode 100644 doc/client/tools/upstart.txt delete mode 100644 doc/client/tools/yum.txt (limited to 'doc/client') diff --git a/doc/client/tools/blast.txt b/doc/client/tools/blast.txt deleted file mode 100644 index 14eb53124..000000000 --- a/doc/client/tools/blast.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 35cc0969e..000000000 --- a/doc/client/tools/chkconfig.txt +++ /dev/null @@ -1,15 +0,0 @@ -.. -*- 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: - ```` diff --git a/doc/client/tools/debinit.txt b/doc/client/tools/debinit.txt deleted file mode 100644 index 33d20f89c..000000000 --- a/doc/client/tools/debinit.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 40508ac7a..000000000 --- a/doc/client/tools/encap.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-encap: - -===== -Encap -===== - -`Encap `_ Packages. diff --git a/doc/client/tools/freebsdinit.txt b/doc/client/tools/freebsdinit.txt deleted file mode 100644 index 7df2518bc..000000000 --- a/doc/client/tools/freebsdinit.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. -*- 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 deleted file mode 100644 index a460fb41c..000000000 --- a/doc/client/tools/freebsdpackage.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. -*- 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 7f6e6b667..9bec46316 100644 --- a/doc/client/tools/index.txt +++ b/doc/client/tools/index.txt @@ -2,31 +2,154 @@ .. _client-tools-index: -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. +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. Currently these are the tool drivers that are distributed with Bcfg2: -.. toctree:: - :maxdepth: 1 - :glob: +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: + ```` + +DebInit +------- + +Debian Service Support; exec's update-rc.d to configure services. + +Encap +----- + +`Encap `_ 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 ```` 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 ` + +Executes rpm to manage packages most often on redhat based systems. + +RPMng +----- + +Next-generation RPM tool. Handles RPM sublties like epoch and +prelinking and 64-bit platforms better than the RPM client +tool. :ref:`client-tools-yumng` + +SMF +--- + +Solaris Service Support. + +Example legacy run service (lrc): + +.. code-block:: xml + + + +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 ` + +Handles RPMs using the YUM package manager. + +YUMng +----- - * +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 deleted file mode 100644 index 59a872297..000000000 --- a/doc/client/tools/launchd.txt +++ /dev/null @@ -1,13 +0,0 @@ -.. -*- 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 ```` 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 deleted file mode 100644 index 7a91408b1..000000000 --- a/doc/client/tools/portage.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-portage: - -======= -Portage -======= - -Support for Gentoo Packages. diff --git a/doc/client/tools/posix.txt b/doc/client/tools/posix.txt deleted file mode 100644 index c4da38332..000000000 --- a/doc/client/tools/posix.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 4547d3b39..000000000 --- a/doc/client/tools/rcupdate.txt +++ /dev/null @@ -1,10 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 17d367b55..000000000 --- a/doc/client/tools/rpm.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-rpm: - -=== -RPM -=== - -.. warning:: Deprecated in favor of :ref:`RPMng ` - -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 deleted file mode 100644 index c6d6cddf1..000000000 --- a/doc/client/tools/rpmng.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 4829a14ed..000000000 --- a/doc/client/tools/smf.txt +++ /dev/null @@ -1,15 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-smf: - -=== -SMF -=== - -Solaris Service Support. - -Example legacy run service (lrc): - -.. code-block:: xml - - diff --git a/doc/client/tools/sysv.txt b/doc/client/tools/sysv.txt deleted file mode 100644 index c08614c52..000000000 --- a/doc/client/tools/sysv.txt +++ /dev/null @@ -1,9 +0,0 @@ -.. -*- 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 deleted file mode 100644 index 60d0cf4ef..000000000 --- a/doc/client/tools/upstart.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. -*- 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 deleted file mode 100644 index fcb5244df..000000000 --- a/doc/client/tools/yum.txt +++ /dev/null @@ -1,11 +0,0 @@ -.. -*- mode: rst -*- - -.. _client-tools-yum: - -=== -Yum -=== - -.. warning:: Deprecated in favor of :ref:`YUMng ` - -Handles RPMs using the YUM package manager. -- cgit v1.2.3-1-g7c22