blob: 8ef3d5af3bfbc99c7217d8be5483b00f210d784a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
.. -*- mode: rst -*-
.. _server-plugins-index:
=======
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
:ref:`server-plugins-probes-index`.
#. Automating administrative tasks
(e.g. :ref:`server-plugins-generators-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`_ contains the all plugins currently distributed
with Bcfg2.
.. _Bcfg2 repository: http://trac.mcs.anl.gov/projects/bcfg2/browser/src/lib/Server/Plugins
Metadata (Grouping)
-------------------
.. toctree::
:maxdepth: 1
:glob:
grouping/*
Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.
Abstract Configuration (Structures)
-----------------------------------
.. toctree::
:maxdepth: 1
:glob:
structures/bundler/index
structures/*
Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.
Literal Configuration (Generators)
----------------------------------
.. toctree::
:maxdepth: 1
:glob:
generators/tgenshi/index
generators/*
Each of these plugins has a corresponding subdirectory with the same
name in the Bcfg2 repository.
Connector Plugins
-----------------
.. toctree::
:maxdepth: 1
:glob:
connectors/*
Statistics Plugins
------------------
.. toctree::
:maxdepth: 1
:glob:
statistics/*
DBStats can be enabled by adding it to the plugins line in
``/etc/bcfg2.conf``.
Version Plugins
---------------
.. toctree::
:maxdepth: 1
:glob:
version/*
Miscellaneous Plugins
---------------------
.. toctree::
:maxdepth: 1
:glob:
misc/*
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 :ref:`server-plugins-plugin-roles`
.. toctree::
:hidden:
plugin-roles
probes/index
|