diff options
author | Sol Jerome <solj@ices.utexas.edu> | 2009-12-29 04:19:02 +0000 |
---|---|---|
committer | Sol Jerome <solj@ices.utexas.edu> | 2009-12-29 04:19:02 +0000 |
commit | bd0204ecb1fb80cdf36af0f57b72e84445c1a088 (patch) | |
tree | 930345633221d9fda156140fb494d739a0484f85 /doc/plugins/index.txt | |
parent | d61a93ac7451be4eedb07f93d507b67d6af7b025 (diff) | |
download | bcfg2-bd0204ecb1fb80cdf36af0f57b72e84445c1a088.tar.gz bcfg2-bd0204ecb1fb80cdf36af0f57b72e84445c1a088.tar.bz2 bcfg2-bd0204ecb1fb80cdf36af0f57b72e84445c1a088.zip |
doc: Rearrange plugin document structure
Signed-off-by: Sol Jerome <solj@ices.utexas.edu>
git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5636 ce84e21b-d406-0410-9b95-82705330c041
Diffstat (limited to 'doc/plugins/index.txt')
-rw-r--r-- | doc/plugins/index.txt | 56 |
1 files changed, 32 insertions, 24 deletions
diff --git a/doc/plugins/index.txt b/doc/plugins/index.txt index 0d46fc102..a478f6a8f 100644 --- a/doc/plugins/index.txt +++ b/doc/plugins/index.txt @@ -9,7 +9,7 @@ Plugins are the source of all logic used in building a config. They can perform #. 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) +#. Automating administrative tasks (e.g. :doc:`generators/sshbase` which automates ssh key management) #. Generating client per-entry installation decision-lists Enabling Plugins @@ -27,53 +27,55 @@ The `Bcfg2 repository`_ has the default plugin list currently distributed with B Metadata (Grouping) ------------------- -* :doc:`bb` -* :doc:`metadata` +.. toctree:: + :maxdepth: 2 + :glob: + + grouping/* Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. Abstract Configuration (Structures) ----------------------------------- -* :doc:`base` -* :doc:`bundler` +.. toctree:: + :maxdepth: 2 + :glob: + + structures/* 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` +.. toctree:: + :maxdepth: 2 + :glob: + + generators/* Each of these plugins has a corresponding subdirectory with the same name in the Bcfg2 repository. Statistics Plugins ------------------ -* :doc:`dbstats` -* :doc:`statistics` +.. toctree:: + :maxdepth: 2 + :glob: + + 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` +.. toctree:: + :maxdepth: 2 + :glob: + + version/* Plugin Roles (in 1.0) ===================== @@ -81,3 +83,9 @@ 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` + +.. toctree:: + :hidden: + + plugin-roles + probes |