diff options
author | Sol Jerome <solj@ices.utexas.edu> | 2009-12-28 00:55:43 +0000 |
---|---|---|
committer | Sol Jerome <solj@ices.utexas.edu> | 2009-12-28 00:55:43 +0000 |
commit | d61a93ac7451be4eedb07f93d507b67d6af7b025 (patch) | |
tree | 8b1a608813379757facfbd67dce118e19e87066d /doc/plugins/index.txt | |
parent | 6748674b04b321e3cc8aa2dad22a62a1405c4937 (diff) | |
download | bcfg2-d61a93ac7451be4eedb07f93d507b67d6af7b025.tar.gz bcfg2-d61a93ac7451be4eedb07f93d507b67d6af7b025.tar.bz2 bcfg2-d61a93ac7451be4eedb07f93d507b67d6af7b025.zip |
doc: Add server plugin docs
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5635 ce84e21b-d406-0410-9b95-82705330c041
Diffstat (limited to 'doc/plugins/index.txt')
-rw-r--r-- | doc/plugins/index.txt | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/doc/plugins/index.txt b/doc/plugins/index.txt new file mode 100644 index 000000000..0d46fc102 --- /dev/null +++ b/doc/plugins/index.txt @@ -0,0 +1,83 @@ +.. -*- mode: rst -*- + +======= +Plugins +======= + +Plugins are the source of all logic used in building a config. They can perform one of several tasks: + +#. Generating configuration inventory lists for clients +#. Generating configuration entry contents for clients +#. Probing client-side state (like hardware inventory, etc) -- the generic client probing mechanism is described at :doc:`probes`. +#. Automating administrative tasks (e.g. :doc:`sshbase` which automates ssh key management) +#. Generating client per-entry installation decision-lists + +Enabling Plugins +================ + +In order for the bcfg2 server to use a plugin, it needs to be listed on the *plugins* line in bcfg2.conf. + +Default Plugins +=============== + +The `Bcfg2 repository`_ has the default plugin list currently distributed with Bcfg2: http://trac.mcs.anl.gov/projects/bcfg2/browser/trunk/bcfg2/src/lib/Server/Plugins. + +.. _Bcfg2 repository: http://trac.mcs.anl.gov/projects/bcfg2/browser/trunk/bcfg2/src/lib/Server/Plugins. + +Metadata (Grouping) +------------------- + +* :doc:`bb` +* :doc:`metadata` + +Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. + +Abstract Configuration (Structures) +----------------------------------- + +* :doc:`base` +* :doc:`bundler` + +Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. + +Literal Configuration (Generators) +---------------------------------- + +* :doc:`account` +* :doc:`actions` +* :doc:`cfg` +* :doc:`decisions` +* :doc:`deps` +* :doc:`hostbase` +* :doc:`nagiosgen` +* :doc:`packages` +* :doc:`pkgmgr` +* :doc:`rules` +* :doc:`sshbase` +* :doc:`tcheetah` +* :doc:`tgenshi` + +Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. + +Statistics Plugins +------------------ + +* :doc:`dbstats` +* :doc:`statistics` + +DBStats can be enabled by adding it to the plugins line in /etc/bcfg2.conf. + +Version Plugins +--------------- + +* :doc:`bzr` +* :doc:`fossil` +* :doc:`git` +* :doc:`svn` + +Plugin Roles (in 1.0) +===================== + +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. + +More details can be found in :doc:`plugin-roles` |